[Fix] dynamic-import-chunkname/TypeScript: support `@typescript-esl…

…int/parser` Fixes #1771.
import-js · Jun 20, 2020 · 4d6c539 · 4d6c539
1 parent 2962628
commit 4d6c539
Show file tree

Hide file tree

Showing 5 changed files with 376 additions and 57 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -23,6 +23,9 @@ matrix:
   include:
   - env: LINT=true
     node_js: lts/*
+  - env: TS_PARSER=2 ESLINT_VERSION=7
+    node_js: lts/*
+    before_script: 'npm install --no-save @typescript-eslint/parser@2'
   - env: PACKAGE=resolvers/node
     node_js: 14
   - env: PACKAGE=resolvers/node

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -13,6 +13,7 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
 - [`no-extraneous-dependencies`]/TypeScript: do not error when importing type from dev dependencies ([#1820], thanks [@fernandopasik])
 - [`default`]: avoid crash with `export =` ([#1822], thanks [@AndrewLeedham])
 - [`order`]/[`newline-after-import`]: ignore TypeScript's "export import object" ([#1830], thanks [@be5invis])
+- [`dynamic-import-chunkname`]/TypeScript: supports `@typescript-eslint/parser` ([#1833], thanks [@noelebrun])
 
 ### Changed
 - [`no-extraneous-dependencies`]: add tests for importing types ([#1824], thanks [@taye])
@@ -713,6 +714,7 @@ for info on changes for earlier releases.
 
 [`memo-parser`]: ./memo-parser/README.md
 
+[#1833]: https://github.com/benmosher/eslint-plugin-import/pull/1833
 [#1830]: https://github.com/benmosher/eslint-plugin-import/pull/1830
 [#1824]: https://github.com/benmosher/eslint-plugin-import/pull/1824
 [#1823]: https://github.com/benmosher/eslint-plugin-import/pull/1823
@@ -1238,3 +1240,4 @@ for info on changes for earlier releases.
 [@taye]: https://github.com/taye
 [@AndrewLeedham]: https://github.com/AndrewLeedham
 [@be5invis]: https://github.com/be5invis
+[@noelebrun]: https://github.com/noelebrun
diff --git a/package.json b/package.json
@@ -55,7 +55,7 @@
   "devDependencies": {
     "@eslint/import-test-order-redirect-scoped": "file:./tests/files/order-redirect-scoped",
     "@test-scope/some-module": "file:./tests/files/symlinked-module",
-    "@typescript-eslint/parser": "^2.23.0",
+    "@typescript-eslint/parser": "^2.23.0 || ^3.3.0",
     "array.prototype.flatmap": "^1.2.3",
     "babel-cli": "^6.26.0",
     "babel-core": "^6.26.3",

diff --git a/src/rules/dynamic-import-chunkname.js b/src/rules/dynamic-import-chunkname.js
@@ -34,78 +34,85 @@ module.exports = {
     const chunkSubstrFormat = ` webpackChunkName: "${webpackChunknameFormat}",? `
     const chunkSubstrRegex = new RegExp(chunkSubstrFormat)
 
-    return {
-      CallExpression(node) {
-        if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) {
-          return
-        }
+    function run(node, arg) {
+      const sourceCode = context.getSourceCode()
+      const leadingComments = sourceCode.getCommentsBefore
+        ? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
+        : sourceCode.getComments(arg).leading // This method is deprecated in ESLint 7.
 
-        const sourceCode = context.getSourceCode()
-        const arg = node.arguments[0]
-        const leadingComments = sourceCode.getCommentsBefore
-          ? sourceCode.getCommentsBefore(arg) // This method is available in ESLint >= 4.
-          : sourceCode.getComments(arg).leading // This method is deprecated in ESLint 7.
+      if (!leadingComments || leadingComments.length === 0) {
+        context.report({
+          node,
+          message: 'dynamic imports require a leading comment with the webpack chunkname',
+        })
+        return
+      }
 
-        if (!leadingComments || leadingComments.length === 0) {
+      let isChunknamePresent = false
+
+      for (const comment of leadingComments) {
+        if (comment.type !== 'Block') {
           context.report({
             node,
-            message: 'dynamic imports require a leading comment with the webpack chunkname',
+            message: 'dynamic imports require a /* foo */ style comment, not a // foo comment',
           })
           return
         }
 
-        let isChunknamePresent = false
-
-        for (const comment of leadingComments) {
-          if (comment.type !== 'Block') {
-            context.report({
-              node,
-              message: 'dynamic imports require a /* foo */ style comment, not a // foo comment',
-            })
-            return
-          }
-
-          if (!paddedCommentRegex.test(comment.value)) {
-            context.report({
-              node,
-              message: `dynamic imports require a block comment padded with spaces - /* foo */`,
-            })
-            return
-          }
-
-          try {
-            // just like webpack itself does
-            vm.runInNewContext(`(function(){return {${comment.value}}})()`)
-          }
-          catch (error) {
-            context.report({
-              node,
-              message: `dynamic imports require a "webpack" comment with valid syntax`,
-            })
-            return
-          }
-
-          if (!commentStyleRegex.test(comment.value)) {
-            context.report({
-              node,
-              message:
-                `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,
-            })
-            return
-          }
+        if (!paddedCommentRegex.test(comment.value)) {
+          context.report({
+            node,
+            message: `dynamic imports require a block comment padded with spaces - /* foo */`,
+          })
+          return
+        }
 
-          if (chunkSubstrRegex.test(comment.value)) {
-            isChunknamePresent = true
-          }
+        try {
+          // just like webpack itself does
+          vm.runInNewContext(`(function(){return {${comment.value}}})()`)
+        }
+        catch (error) {
+          context.report({
+            node,
+            message: `dynamic imports require a "webpack" comment with valid syntax`,
+          })
+          return
         }
 
-        if (!isChunknamePresent) {
+        if (!commentStyleRegex.test(comment.value)) {
           context.report({
             node,
             message:
               `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,
           })
+          return
         }
+
+        if (chunkSubstrRegex.test(comment.value)) {
+          isChunknamePresent = true
+        }
+      }
+
+      if (!isChunknamePresent) {
+        context.report({
+          node,
+          message:
+            `dynamic imports require a leading comment in the form /*${chunkSubstrFormat}*/`,
+        })
+      }
+    }
+
+    return {
+      ImportExpression(node) {
+        run(node, node.source)
+      },
+
+      CallExpression(node) {
+        if (node.callee.type !== 'Import' && importFunctions.indexOf(node.callee.name) < 0) {
+          return
+        }
+
+        run(node, node.arguments[0])
       },
     }
   },