feat: add no-import-compiler-macros rule

Author: waynzh

lib/rules/no-import-compiler-macros.js

@@ -0,0 +1,94 @@
+/**
+ * @author Wayne Zhang
+ * See LICENSE file in root directory for full license.
+ */
+'use strict'
+
+const COMPILER_MACROS = new Set([
+  'defineProps',
+  'defineEmits',
+  'defineExpose',
+  'withDefaults'
+])
+
+const VUE_MODULES = new Set(['@vue/runtime-core', '@vue/runtime-dom', 'vue'])
+
+/**
+ * @param {Token} node
+ */
+function isComma(node) {
+  return node.type === 'Punctuator' && node.value === ','
+}
+
+/**
+ * @param {Token} node
+ */
+function isLeftCurlyBrace(node) {
+  return node.type === 'Punctuator' && node.value === '{'
+}
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'disallow importing vue compiler macros',
+      categories: undefined,
+      url: 'https://eslint.vuejs.org/rules/no-import-compiler-macros.html'
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      noImportCompilerMacros:
+        "'{{name}}' is a compiler macro and no longer needs to be imported from '{{source}}'."
+    }
+  },
+  /**
+   * @param {RuleContext} context
+   * @returns {RuleListener}
+   */
+  create(context) {
+    const sourceCode = context.getSourceCode()
+
+    return {
+      ImportDeclaration(node) {
+        if (node.specifiers.length === 0) return
+
+        if (VUE_MODULES.has(node.source.value)) {
+          for (const specifier of node.specifiers) {
+            if (
+              specifier.type === 'ImportSpecifier' &&
+              COMPILER_MACROS.has(specifier.imported.name)
+            ) {
+              context.report({
+                node: specifier,
+                messageId: 'noImportCompilerMacros',
+                data: {
+                  name: specifier.imported.name,
+                  source: node.source.value
+                },
+                fix: (fixer) => {
+                  const tokenAfter = sourceCode.getTokenAfter(specifier)
+                  const tokenBefore = sourceCode.getTokenBefore(specifier)
+
+                  const hasCommaAfter = isComma(tokenAfter)
+                  const isFirstSpecifier = isLeftCurlyBrace(tokenBefore)
+
+                  const codeStart = hasCommaAfter
+                    ? tokenBefore.range[1]
+                    : isFirstSpecifier
+                      ? specifier.range[0]
+                      : tokenBefore.range[0]
+                  const codeEnd = hasCommaAfter
+                    ? tokenAfter.range[1]
+                    : specifier.range[1]
+
+                  return fixer.removeRange([codeStart, codeEnd])
+                }
+              })
+            }
+          }
+        }
+      }
+    }
+  }
+}

tests/lib/rules/no-import-compiler-macros.js

@@ -0,0 +1,128 @@
+/**
+ * @author Wayne Zhang
+ * See LICENSE file in root directory for full license.
+ */
+'use strict'
+
+const RuleTester = require('../../eslint-compat').RuleTester
+const rule = require('../../../lib/rules/no-import-compiler-macros')
+
+const tester = new RuleTester({
+  languageOptions: {
+    parser: require('vue-eslint-parser'),
+    ecmaVersion: 2020,
+    sourceType: 'module'
+  }
+})
+
+tester.run('no-import-compiler-macros', rule, {
+  valid: [
+    {
+      filename: 'test.vue',
+      code: `
+      <script setup>
+      import { ref } from 'vue'
+      import { someFunction } from '@vue/runtime-core'
+      </script>
+      `
+    },
+    {
+      filename: 'test.vue',
+      code: `
+      <script>
+      import { defineProps } from 'some-other-package'
+      </script>
+      `
+    }
+  ],
+  invalid: [
+    {
+      filename: 'test.vue',
+      code: `
+      <script setup>
+      import { computed, defineProps } from 'vue'
+      import { defineEmits, ref, withDefaults } from '@vue/runtime-core'
+      import { defineExpose, watch } from '@vue/runtime-dom'
+      </script>
+      `,
+      output: `
+      <script setup>
+      import { computed } from 'vue'
+      import { ref } from '@vue/runtime-core'
+      import { watch } from '@vue/runtime-dom'
+      </script>
+      `,
+      errors: [
+        {
+          messageId: 'noImportCompilerMacros',
+          data: {
+            name: 'defineProps',
+            source: 'vue'
+          },
+          line: 3,
+          column: 26
+        },
+        {
+          messageId: 'noImportCompilerMacros',
+          data: {
+            name: 'defineEmits',
+            source: '@vue/runtime-core'
+          },
+          line: 4,
+          column: 16
+        },
+        {
+          messageId: 'noImportCompilerMacros',
+          data: {
+            name: 'withDefaults',
+            source: '@vue/runtime-core'
+          },
+          line: 4,
+          column: 34
+        },
+        {
+          messageId: 'noImportCompilerMacros',
+          data: {
+            name: 'defineExpose',
+            source: '@vue/runtime-dom'
+          },
+          line: 5,
+          column: 16
+        }
+      ]
+    },
+    {
+      filename: 'test.vue',
+      code: `
+      <script setup>
+      import { defineProps, withDefaults, ref } from 'vue'
+      </script>
+      `,
+      output: `
+      <script setup>
+      import { withDefaults, ref } from 'vue'
+      </script>
+      `,
+      errors: [
+        {
+          messageId: 'noImportCompilerMacros',
+          data: {
+            name: 'defineProps',
+            source: 'vue'
+          },
+          line: 3,
+          column: 16
+        },
+        {
+          messageId: 'noImportCompilerMacros',
+          data: {
+            name: 'withDefaults',
+            source: 'vue'
+          },
+          line: 3,
+          column: 29
+        }
+      ]
+    }
+  ]
+})