Chores: Add JSDoc type checking with TypeScript

Author: ota-meshi

Diff for: .eslintrc.js

@@ -37,24 +37,6 @@ module.exports = {
     'dot-notation': 'error'
   },
   overrides: [
-    // Introduce prettier. but ignore files to avoid conflicts with PR.
-    {
-      files: [
-        // https://github.com/vuejs/eslint-plugin-vue/pull/819
-        'lib/rules/attributes-order.js',
-        'tests/lib/rules/attributes-order.js'
-      ],
-      extends: [
-        'plugin:eslint-plugin/recommended',
-        'plugin:vue-libs/recommended'
-      ],
-      rules: {
-        'prettier/prettier': 'off',
-
-        'rest-spread-spacing': 'error',
-        'no-mixed-operators': 'error'
-      }
-    },
     {
       files: ['lib/rules/*.js'],
       rules: {

Diff for: .vscode/settings.json

@@ -7,5 +7,6 @@
         "javascript",
         "javascriptreact",
         { "language": "vue", "autoFix": true }
-    ]
+    ],
+    "typescript.tsdk": "node_modules/typescript/lib"
 }

Diff for: lib/processor.js

@@ -13,6 +13,7 @@
  */
 
 module.exports = {
+  /** @param {string} code */
   preprocess(code) {
     return [code]
   },
@@ -34,6 +35,7 @@ module.exports = {
         disableRuleKeys: new Map()
       }
     }
+    /** @type {string[]} */
     const usedDisableDirectiveKeys = []
     /** @type {Map<string,LintMessage>} */
     const unusedDisableDirectiveReports = new Map()
@@ -88,15 +90,15 @@ module.exports = {
         if (state.line.disableAllKeys.size) {
           disableDirectiveKeys.push(...state.line.disableAllKeys)
         }
-        if (state.block.disableRuleKeys.has(message.ruleId)) {
-          disableDirectiveKeys.push(
-            ...state.block.disableRuleKeys.get(message.ruleId)
-          )
-        }
-        if (state.line.disableRuleKeys.has(message.ruleId)) {
-          disableDirectiveKeys.push(
-            ...state.line.disableRuleKeys.get(message.ruleId)
-          )
+        if (message.ruleId) {
+          const block = state.block.disableRuleKeys.get(message.ruleId)
+          if (block) {
+            disableDirectiveKeys.push(...block)
+          }
+          const line = state.line.disableRuleKeys.get(message.ruleId)
+          if (line) {
+            disableDirectiveKeys.push(...line)
+          }
         }
 
         if (disableDirectiveKeys.length) {
@@ -153,8 +155,8 @@ function messageToKey(message) {
 
 /**
  * Compares the locations of two objects in a source file
- * @param {{line: number, column: number}} itemA The first object
- * @param {{line: number, column: number}} itemB The second object
+ * @param {Position} itemA The first object
+ * @param {Position} itemB The second object
  * @returns {number} A value less than 1 if itemA appears before itemB in the source file, greater than 1 if
  * itemA appears after itemB in the source file, or 0 if itemA and itemB have the same location.
  */

Diff for: lib/rules/array-bracket-spacing.js

@@ -7,6 +7,7 @@ const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line no-invalid-meta, no-invalid-meta-docs-categories
 module.exports = wrapCoreRule(
+  // @ts-ignore
   require('eslint/lib/rules/array-bracket-spacing'),
   { skipDynamicArguments: true }
 )

Diff for: lib/rules/arrow-spacing.js

@@ -6,4 +6,7 @@
 const { wrapCoreRule } = require('../utils')
 
 // eslint-disable-next-line
-module.exports = wrapCoreRule(require('eslint/lib/rules/arrow-spacing'))
+module.exports = wrapCoreRule(
+  // @ts-ignore
+  require('eslint/lib/rules/arrow-spacing')
+)

Diff for: lib/rules/attribute-hyphenation.js

@@ -45,7 +45,7 @@ module.exports = {
       }
     ]
   },
-
+  /** @param {RuleContext} context */
   create(context) {
     const sourceCode = context.getSourceCode()
     const option = context.options[0]
@@ -61,6 +61,10 @@ module.exports = {
       useHyphenated ? 'kebab-case' : 'camelCase'
     )
 
+    /**
+     * @param {VDirective | VAttribute} node
+     * @param {string} name
+     */
     function reportIssue(node, name) {
       const text = sourceCode.getText(node.key)
 
@@ -78,6 +82,9 @@ module.exports = {
       })
     }
 
+    /**
+     * @param {string} value
+     */
     function isIgnoredAttribute(value) {
       const isIgnored = ignoredAttributes.some((attr) => {
         return value.indexOf(attr) !== -1
@@ -101,7 +108,9 @@ module.exports = {
         const name = !node.directive
           ? node.key.rawName
           : node.key.name.name === 'bind'
-          ? node.key.argument && node.key.argument.rawName
+          ? node.key.argument &&
+            node.key.argument.type === 'VIdentifier' &&
+            node.key.argument.rawName
           : /* otherwise */ false
         if (!name || isIgnoredAttribute(name)) return