support check chunk-name format only in dynamic-import-chunkname rule

[JiangWeixian]

Thanks for awesome works :)

Currently dynamic-import-chunkname rule require webpack chunk name, will report error if not exit.

Is able to add a option to check chunk-name format only, if webpack chunk name not exit is ok.

Currently dynamic-import-chunkname will throw error for

// Bad
import("someModule")

// Good
import(
    /* webpackChunkName: "someModule" */
    'someModule',
  );

// Bad
import(
  /*webpackChunkName:"someModule"*/
  'someModule',
);

I want to add a option to make

// Good
import("someModule")

// Bad
import(
  /*webpackChunkName:"someModule"*/
  'someModule',
);

I glad like open a PR for this feature.

Related un-ts#21

[ljharb]

You want to forbid webpack chunk name comments?

[JounQin]

I think he wants to allow empty leadingComments:

https://github.com/import-js/eslint-plugin-import/blob/main/src/rules/dynamic-import-chunkname.js#L45-L51

[ljharb]

That’s the default behavior of the language without the rule enabled tho.

[JounQin]

I think he wants to allow empty leadingComments but check the format if it exists?

[ljharb]

Hmm, ok - what's the use case? When would you want some dynamic imports handled by webpack but some not?

[JounQin]

@ljharb

Take the following as example, when dynamic string included, a chunk name is good to have.

import(
  /* webpackChunkName: "my-chunk-name" */
  `./locale/${language}`
);

But then the expression itself is static, no need to change it.

[ljharb]

The staticness or dynamicness of the import specifier isn't relevant to webpack tho. This rule was created because in a codebase that's using webpack dynamic import code splitting, every single dynamic import needs to have a chunk name identified.

[JiangWeixian]

@ljharb

When I wrap dynamic import with loadable, e.g.

loadable(() => import("some-module"))

it provides a babel-plugin or swc-plugin to automatic add webpackChunkName during compile time(or swc transform).

automatic generate chunkName only enabled when webpackChunkName not found in leadingComments I think it's ok to allow empty leadingComments

[ljharb]

If you’re using that plugin, why would you use this rule?

[JiangWeixian]

If use these plugins:

// will automatic add webpackChunkName, /* webpackChunkName: "foo" */
loadable(() => import("foo"))

// will not automatic add webpackChunkName,  /* webpackChunkName: "foo" */, use /* webpackChunkName: "some-module" */  instead.
loadable(() => import(/* webpackChunkName: "some-module" */ "foo"))

Because this rule also check webpackChunkName format. If I already defined webpackChunkName, I want to check webpackChunkName format is right or not. Webpack split chunks not working on wrong magic webpackChunkName commets syntax.

[ljharb]

OK, thanks, that's at least a use case :-) I'll wait til I hear @JiangWeixian's use case before I decide anything tho.

[JounQin]

OK, thanks, that's at least a use case :-) I'll wait til I hear @JiangWeixian's use case before I decide anything tho.

Not sure what's your meaning, @JiangWeixian has already provided his use case.

[ljharb]

I don't see where; the OP only asks for a solution. A use case is the "why" - the problem they're having and why they're having it.

[JounQin]

OK, thanks, that's at least a use case

What does this mean?

[ljharb]

It means that you provided the first motivation - reason/justification - for making any changes here, since the OP still hasn't provided any.

[JounQin]

I think you meant the OP here? I'm not requesting this feature, just help the OP to explain. I don't have such usage case.

[ljharb]

ah thanks, i got confused :-)

In that case, an option that ignores missing comments would be fine.

[JounQin]

@JiangWeixian So this feature is ready to be implemented.