vercel/next.js

### Goals

thanachotnual opened this issue · 1 comments

thanachotnual commented

Goals

Make it possible to export a config in next.config.js with a property that uses webpack to add the "use client" to client components from a third-party component library and allow server components to import it directly without the need for wrapper files.

Non-Goals

No response

Background

To use NextJS 13 with client components libraries like Prime React or React Bootstrap, since they are not exporting their components with the "use client" directive, we need to create a file like this:

export * from 'my-component-library/some-component'

Besides that doing this sucks, this, for instance, breaks the VScode auto import extension (it doesn't reach components exported this way).

Proposal

It's easy to use webpack loaders to fix that:

// next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  webpack: function (config, options) {
    config.module.rules.push({
      test: [/node_modules\/primereact\//], // here goes the regex for the modules we want to add the "use client"
      loader: require.resolve("./loaders/use-client-loader.js"),
    });
    return config;
  },
};

module.exports = nextConfig;

/// And then we create a loader in loaders/use-client-loader.js
module.exports = function (source) {
  return `"use client";\n` + source;
};

So, one way of implementing that would be having a property in next.config.js that just abstracts this webpack loader. It could be something like this:

/** @type {import('next').NextConfig} */
const nextConfig = {
  transformClientModules: [/primereact\//],
};

module.exports = nextConfig;

and this property will pass this array to the test property of the webpack loader.

Originally posted by @VitorFigm in #51092

github-actions commented

We could not detect a valid reproduction link. Make sure to follow the bug report template carefully.

Why was this issue closed?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We need a link to a public GitHub repository (template for App Router, template for Pages Router), but you can also use these templates: CodeSandbox: App Router or CodeSandbox: Pages Router.

The bug template that you filled out has a section called "Link to the code that reproduces this issue", which is where you should provide the link to the reproduction.

  • If you did not provide a link or the link you provided is not valid, we will close the issue.
  • If you provide a link to a private repository, we will close the issue.
  • If you provide a link to a repository but not in the correct section, we will close the issue.

What should I do?

Depending on the reason the issue was closed, you can do the following:

  • If you did not provide a link, please open a new issue with a link to a reproduction.
  • If you provided a link to a private repository, please open a new issue with a link to a public repository.
  • If you provided a link to a repository but not in the correct section, please open a new issue with a link to a reproduction in the correct section.

In general, assume that we should not go through a lengthy onboarding process at your company code only to be able to verify an issue.

My repository is private and cannot make it public

In most cases, a private repo will not be a sufficient minimal reproduction, as this codebase might contain a lot of unrelated parts that would make our investigation take longer. Please do not make it public. Instead, create a new repository using the templates above, adding the relevant code to reproduce the issue. Common things to look out for:

  • Remove any code that is not related to the issue. (pages, API routes, components, etc.)
  • Remove any dependencies that are not related to the issue.
  • Remove any third-party service that would require us to sign up for an account to reproduce the issue.
  • Remove any environment variables that are not related to the issue.
  • Remove private packages that we do not have access to.
  • If the issue is not related to a monorepo specifically, try to reproduce the issue without a complex monorepo setup

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps by opening a new issue.

I think my reproduction is good enough, why aren't you looking into it quickly?

We look into every Next.js issue and constantly monitor open issues for new comments.

However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

Useful Resources