Initial commit

Author: sharkykh

.eslintignore

@@ -0,0 +1,2 @@
+**/node_modules/**
+!.eslintrc.js

.eslintrc.js

@@ -0,0 +1,12 @@
+/* eslint comma-dangle: [error, always-multiline] */
+module.exports = {
+  extends: [
+    'xo-space',
+  ],
+  rules: {
+    'object-curly-spacing': [
+      'error',
+      'always',
+    ],
+  },
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+*.log

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 sharkykh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,14 @@
+# eslint-plugin-vue-extra
+
+[![NPM version](https://img.shields.io/npm/v/@sharkykh/eslint-plugin-vue-extra.svg)](https://npmjs.org/package/@sharkykh/eslint-plugin-vue-extra)
+[![License](https://img.shields.io/github/license/sharkykh/eslint-plugin-vue-extra.svg?style=flat)](https://github.com/sharkykh/eslint-plugin-vue-extra/blob/master/LICENSE)
+
+> ESLint plugin, extension for [`eslint-plugin-vue`](https://eslint.vuejs.org).
+
+## Rules
+
+- [component-not-registered](src/component-not-registered.js) - Warn if a component is used in a [SFC file](https://vuejs.org/v2/guide/single-file-components.html) without being registered (a.k.a. a globally registered component). **Does not support dynamically assigned components.**
+
+## :lock: License
+
+See the [LICENSE](LICENSE) file for license rights and limitations (MIT).

package.json

@@ -0,0 +1,35 @@
+{
+  "version": "0.1.0",
+  "name": "@sharkykh/eslint-plugin-vue-extra",
+  "description": "ESLint plugin, extension for eslint-plugin-vue",
+  "author": "sharkykh",
+  "license": "MIT",
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "eslint-config",
+    "vue",
+    "vuejs",
+    "rules"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sharkykh/eslint-plugin-vue.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sharkykh/eslint-plugin-vue/issues"
+  },
+  "main": "src/index.js",
+  "scripts": {
+    "lint": "eslint *.js"
+  },
+  "peerDependencies": {
+    "eslint": "^5.0.0 || ^6.0.0",
+    "eslint-plugin-vue": "^5.2.3"
+  },
+  "devDependencies": {
+    "eslint": "^6.0.1",
+    "eslint-config-xo-space": "^0.21.0",
+    "eslint-plugin-vue": "^5.2.3"
+  }
+}

src/component-not-registered.js

@@ -0,0 +1,118 @@
+/**
+ * @author sharkykh
+ * Based on https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/component-name-in-template-casing.js
+ */
+'use strict';
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const utils = require('eslint-plugin-vue/lib/utils');
+const casing = require('eslint-plugin-vue/lib/utils/casing');
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+const VueBuiltInComponents = [
+  'component',
+  'keep-alive',
+  'slot',
+  'transition',
+  'transition-group'
+];
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    schema: [
+      {
+        type: 'array',
+        items: {
+          type: 'string'
+        },
+        uniqueItems: true,
+        additionalItems: false
+      }
+    ]
+  },
+
+  create(context) {
+    const allowedComponents = VueBuiltInComponents.concat(context.options[0] || []);
+    const registeredComponents = [];
+
+    const tokens = context.parserServices.getTemplateBodyTokenStore && context.parserServices.getTemplateBodyTokenStore();
+
+    let hasInvalidEOF = false;
+
+    /**
+     * Checks whether the given node is the verification target node.
+     * @param {VElement} node element node
+     * @returns {boolean} `true` if the given node is the verification target node.
+     */
+    function isVerifyTarget(node) {
+      // If the component is allowed, ignore it
+      try {
+        if (allowedComponents.some(name => name === node.rawName)) {
+          return false;
+        }
+      } catch (_) {}
+
+      // Ignore non-Vue-components (vanilla HTML elements and SVG)
+      if ((!utils.isHtmlElementNode(node) && !utils.isSvgElementNode(node)) ||
+        utils.isHtmlWellKnownElementName(node.rawName) ||
+        utils.isSvgWellKnownElementName(node.rawName)
+      ) {
+        return false;
+      }
+
+      return true;
+    }
+
+    return utils.defineTemplateBodyVisitor(
+      context,
+      {
+        VElement(node) {
+          if (hasInvalidEOF) {
+            return;
+          }
+
+          if (!isVerifyTarget(node)) {
+            return;
+          }
+
+          const name = node.rawName;
+          const casingName = casing.getConverter('PascalCase')(name);
+          if (!registeredComponents.some(componentName => casingName === componentName)) {
+            const { startTag } = node;
+            const open = tokens.getFirstToken(startTag);
+
+            context.report({
+              node: open,
+              loc: open.loc,
+              message: 'Component "{{name}}" is used but not registered.',
+              data: {
+                name
+              }
+            });
+          }
+        }
+      },
+      Object.assign(
+        {
+          Program(node) {
+            hasInvalidEOF = utils.hasInvalidEOF(node);
+          }
+        },
+        utils.executeOnVue(context, obj => {
+          registeredComponents.push(...utils.getRegisteredComponents(obj).map(n => n.name));
+        })
+      )
+    );
+  }
+};

src/index.js

@@ -0,0 +1,7 @@
+'use strict';
+
+module.exports = {
+  rules: {
+    'component-not-registered': require('./component-not-registered.js')
+  }
+};