Implement support for line comments

Author: armano2

lib/utils/index.js

@@ -341,16 +341,6 @@ module.exports = {
       })
   },
 
-  /**
-   * Check whether the given node is a Vue component based
-   * @param {RuleContext} context The ESLint rule context object.
-   * @returns {boolean}
-   */
-  hasVueComponentComment (context) {
-    const sourceCode = context.getSourceCode()
-    return Boolean(sourceCode.getAllComments().find(item => /@vue\/component/g.test(item.value)))
-  },
-
   /**
    * Check whether the given node is a Vue component based
    * on the filename and default export type
@@ -442,21 +432,52 @@ module.exports = {
   executeOnVueComponent (context, cb) {
     const filePath = context.getFilename()
     const _this = this
+    const componentComments = []
+    const foundNodes = []
+
+    const hasNode = (node) => {
+      return foundNodes.some(el => el.loc.start.line === node.loc.start.line)
+    }
 
     return {
+      LineComment (node) {
+        // line comment with @vue/component
+        if (!_this.isVueComponentComment(node.value)) return
+        componentComments.push(node)
+      },
+      BlockComment (node) {
+        // block comment with @vue/component
+        if (!_this.isVueComponentComment(node.value)) return
+        componentComments.push(node)
+      },
+      ObjectExpression (node) {
+        // comment with @vue/component
+        if (!componentComments.some(el => el.loc.end.line === node.loc.start.line - 1) || hasNode(node)) return
+        foundNodes.push(node)
+        cb(node)
+      },
       'ExportDefaultDeclaration:exit' (node) {
-        // export default {} in .vue || .jsx or comment with @vue/component
-        if (!_this.isVueComponentFile(node, filePath, context) && !_this.hasVueComponentComment(context)) return
+        // export default {} in .vue || .jsx
+        if (!_this.isVueComponentFile(node, filePath, context) || hasNode(node)) return
         cb(node.declaration)
       },
       'CallExpression:exit' (node) {
         // Vue.component('xxx', {}) || component('xxx', {})
-        if (!_this.isVueComponent(node)) return
+        if (!_this.isVueComponent(node) || foundNodes.some(el => el.loc.start.line === node.loc.start.line)) return
         cb(node.arguments.slice(-1)[0])
       }
     }
   },
 
+  /**
+   * Check whether the given comment is a Vue component based
+   * @param {string} value Conent of comment.
+   * @return {boolean}
+   */
+  isVueComponentComment (value) {
+    return /@vue\/component/g.test(value)
+  },
+
   /**
    * Return generator with all properties
    * @param {ASTNode} node Node to check

tests/lib/utils/vue-component.js

@@ -105,12 +105,13 @@ function foundTests (ext) {
   return [
     {
       filename: `test.${ext}`,
-      code: `Vue.component('async-example', function (resolve, reject) {
+      code: `// ${ext}
+      Vue.component('async-example', function (resolve, reject) {
         // @vue/component
         resolve({})
       })`,
       parserOptions,
-      errors: [makeError(2)]
+      errors: [makeError(4)]
     },
     {
       filename: `test.${ext}`,
@@ -120,82 +121,93 @@ function foundTests (ext) {
     },
     {
       filename: `test.${ext}`,
-      code: `// @vue/component
+      code: `// ${ext}
+      // @vue/component
       export default { }`,
       parserOptions,
-      errors: [makeError(2)]
+      errors: [makeError(3)]
     },
     {
       filename: `test.${ext}`,
-      code: `/* @vue/component */
-      export default { }`,
+      code: `// ${ext}
+      /* @vue/component */
+      export default { }
+      // ${ext}`,
       parserOptions,
-      errors: [makeError(2)]
+      errors: [makeError(3)]
     },
     {
       filename: `test.${ext}`,
       code: `
       /*
+       * ext: ${ext}
        * @vue/component
        */
-      export default { }`,
+      export default { }
+      // ${ext}`,
       parserOptions,
-      errors: [makeError(5)]
+      errors: [makeError(6)]
     },
     {
       filename: `test.${ext}`,
       code: `// @vue/component
       export default { }
       // @vue/component
-      export var a = { }`,
+      export var a = { }
+      // ${ext}`,
       parserOptions,
       errors: [makeError(2), makeError(4)]
     },
     {
       filename: `test.${ext}`,
       code: `/* @vue/component */
-      export const a = { }
+      export const foo = { }
       /* @vue/component */
-      export default { }`,
+      export default { }
+      // ${ext}`,
       parserOptions,
       errors: [makeError(2), makeError(4)]
     },
     {
       filename: `test.${ext}`,
       code: `export default { }
       // @vue/component
-      export let b = { }`,
+      export let foo = { }
+      // ${ext}`,
       parserOptions,
-      errors: [makeError(3)]
+      errors: (ext === 'js' ? [] : [makeError(1)]).concat([makeError(3)])
     },
     {
       filename: `test.${ext}`,
-      code: `let b = { }
+      code: `let foo = { }
       // @vue/component
-      export let b = { }`,
+      export let bar = { }
+      // ${ext}`,
       parserOptions,
       errors: [makeError(3)]
     },
     {
       filename: `test.${ext}`,
-      code: `export var b = { }
+      code: `export var dar = { }
       // @vue/component
       foo({ })
-      bar({ })`,
+      bar({ })
+      // ${ext}`,
       parserOptions,
       errors: [makeError(3)]
     },
     {
       filename: `test.${ext}`,
       code: `foo({ })
       export default {
-        test: {}
+        test: {},
         // @vue/component
         foo: { }
       }
-      bar({ })`,
+      bar({ })
+      // ${ext}`,
       parserOptions,
-      errors: [makeError(5)]
+      errors: (ext === 'js' ? [] : [makeError(2)]).concat([makeError(5)])
     },
     {
       filename: `test.${ext}`,
@@ -207,9 +219,10 @@ function foundTests (ext) {
           // @vue/component
           return {}
         }
-      }`,
+      }
+      // ${ext}`,
       parserOptions,
-      errors: [makeError(7)]
+      errors: (ext === 'js' ? [] : [makeError(1)]).concat([makeError(7)])
     }
   ]
 }
@@ -219,7 +232,7 @@ function foundTests (ext) {
 // ------------------------------------------------------------------------------
 
 const ruleTester = new RuleTester()
-ruleTester.run('return-in-computed-property', rule, {
+ruleTester.run('vue-component', rule, {
 
   valid: [
     {