-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
12 changed files
with
488 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # dynamic imports require a leading comment with a webpackChunkName (dynamic-import-chunkname) | ||
|
|
||
| This rule reports any dynamic imports without a webpackChunkName specified in a leading block comment in the proper format. | ||
|
|
||
| This rule enforces naming of webpack chunks in dynamic imports. When you don't explicitly name chunks, webpack will autogenerate chunk names that are not consistent across builds, which prevents long-term browser caching. | ||
|
|
||
| ## Rule Details | ||
| This rule runs against `import()` by default, but can be configured to also run against an alternative dynamic-import function, e.g. 'dynamicImport.' | ||
| You can also configure the regex format you'd like to accept for the webpackChunkName - for example, if we don't want the number 6 to show up in our chunk names: | ||
| ```javascript | ||
| { | ||
| "dynamic-import-chunkname": [2, { | ||
| importFunctions: ["dynamicImport"], | ||
| webpackChunknameFormat: "[a-zA-Z0-57-9-/_]" | ||
| }] | ||
| } | ||
| ``` | ||
|
|
||
| ### invalid | ||
| The following patterns are invalid: | ||
|
|
||
| ```javascript | ||
| // no leading comment | ||
| import('someModule'); | ||
|
|
||
| // incorrectly formatted comment | ||
| import( | ||
| /*webpackChunkName:"someModule"*/ | ||
| 'someModule', | ||
| ); | ||
|
|
||
| // chunkname contains a 6 (forbidden by rule config) | ||
| import( | ||
| /* webpackChunkName: "someModule6" */ | ||
| 'someModule', | ||
| ); | ||
|
|
||
| // using single quotes instead of double quotes | ||
| import( | ||
| /* webpackChunkName: 'someModule' */ | ||
| 'someModule', | ||
| ); | ||
|
|
||
| // single-line comment, not a block-style comment | ||
| import( | ||
| // webpackChunkName: "someModule" | ||
| 'someModule', | ||
| ); | ||
| ``` | ||
| ### valid | ||
| The following patterns are valid: | ||
|
|
||
| ```javascript | ||
| import( | ||
| /* webpackChunkName: "someModule" */ | ||
| 'someModule', | ||
| ); | ||
| import( | ||
| /* webpackChunkName: "someOtherModule12345789" */ | ||
| 'someModule', | ||
| ); | ||
| ``` | ||
|
|
||
| ## When Not To Use It | ||
|
|
||
| If you don't care that webpack will autogenerate chunk names and may blow up browser caches and bundle size reports. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # import/no-useless-path-segments | ||
|
|
||
| Use this rule to prevent unnecessary path segemnts in import and require statements. | ||
|
|
||
| ## Rule Details | ||
|
|
||
| Given the following folder structure: | ||
|
|
||
| ``` | ||
| my-project | ||
| ├── app.js | ||
| ├── footer.js | ||
| ├── header.js | ||
| └── pages | ||
| ├── about.js | ||
| ├── contact.js | ||
| └── index.js | ||
| ``` | ||
|
|
||
| The following patterns are considered problems: | ||
|
|
||
| ```js | ||
| /** | ||
| * in my-project/app.js | ||
| */ | ||
|
|
||
| import "./../pages/about.js"; // should be "./pages/about.js" | ||
| import "./../pages/about"; // should be "./pages/about" | ||
| import "../pages/about.js"; // should be "./pages/about.js" | ||
| import "../pages/about"; // should be "./pages/about" | ||
| import "./pages//about"; // should be "./pages/about" | ||
| import "./pages/"; // should be "./pages" | ||
| ``` | ||
|
|
||
| The following patterns are NOT considered problems: | ||
|
|
||
| ```js | ||
| /** | ||
| * in my-project/app.js | ||
| */ | ||
|
|
||
| import "./header.js"; | ||
| import "./pages"; | ||
| import "./pages/about"; | ||
| import "."; | ||
| import ".."; | ||
| import fs from "fs"; | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| import docsUrl from '../docsUrl' | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| docs: { | ||
| url: docsUrl('dynamic-import-chunkname'), | ||
| }, | ||
| schema: [{ | ||
| type: 'object', | ||
| properties: { | ||
| importFunctions: { | ||
| type: 'array', | ||
| uniqueItems: true, | ||
| items: { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| webpackChunknameFormat: { | ||
| type: 'string', | ||
| }, | ||
| }, | ||
| }], | ||
| }, | ||
|
|
||
| create: function (context) { | ||
| const config = context.options[0] | ||
| const { importFunctions = [] } = config || {} | ||
| const { webpackChunknameFormat = '[0-9a-zA-Z-_/.]+' } = config || {} | ||
|
|
||
| const commentFormat = ` webpackChunkName: "${webpackChunknameFormat}" ` | ||
| const commentRegex = new RegExp(commentFormat) | ||
|
|
||
| return { | ||
| CallExpression(node) { | ||
| if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) { | ||
| return | ||
| } | ||
|
|
||
| const sourceCode = context.getSourceCode() | ||
| const arg = node.arguments[0] | ||
| const leadingComments = sourceCode.getComments(arg).leading | ||
|
|
||
| if (!leadingComments || leadingComments.length !== 1) { | ||
| context.report({ | ||
| node, | ||
| message: 'dynamic imports require a leading comment with the webpack chunkname', | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| const comment = leadingComments[0] | ||
| if (comment.type !== 'Block') { | ||
| context.report({ | ||
| node, | ||
| message: 'dynamic imports require a /* foo */ style comment, not a // foo comment', | ||
| }) | ||
| return | ||
| } | ||
|
|
||
| const webpackChunkDefinition = comment.value | ||
| if (!webpackChunkDefinition.match(commentRegex)) { | ||
| context.report({ | ||
| node, | ||
| message: `dynamic imports require a leading comment in the form /*${commentFormat}*/`, | ||
| }) | ||
| } | ||
| }, | ||
| } | ||
| }, | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.