⭐️New: Add vue/require-direct-export rule (#581)

* require-direct-export rule

* Added it to entry file and category

* Fixed rule doc issues

* Update require-direct-export

Author: privatenumber

docs/rules/README.md

@@ -145,6 +145,7 @@ For example:
 | [vue/key-spacing](./key-spacing.md) | enforce consistent spacing between keys and values in object literal properties | :wrench: |
 | [vue/match-component-file-name](./match-component-file-name.md) | require component name property to match its file name |  |
 | [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
+| [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported |  |
 | [vue/script-indent](./script-indent.md) | enforce consistent indentation in `<script>` | :wrench: |
 | [vue/space-infix-ops](./space-infix-ops.md) | require spacing around infix operators | :wrench: |
 | [vue/space-unary-ops](./space-unary-ops.md) | enforce consistent spacing before or after unary operators | :wrench: |

docs/rules/require-direct-export.md

@@ -0,0 +1,45 @@
+---
+pageClass: rule-details
+sidebarDepth: 0
+title: vue/require-direct-export
+description: require the component to be directly exported
+---
+# vue/require-direct-export
+> require the component to be directly exported
+
+## Rule Details
+
+This rule aims to require that the component object be directly exported.
+
+:-1: Examples of **incorrect** code:
+
+```js
+const ComponentA = {
+	name: 'ComponentA',
+	data() {
+		return {
+			state: 1
+		}
+	}
+}
+
+export default ComponentA
+```
+
+:+1: Examples of **correct** code:
+
+```js
+export default {
+	name: 'ComponentA',
+	data() {
+		return {
+			state: 1
+		}
+	}
+}
+```
+
+## :mag: Implementation
+
+- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/require-direct-export.js)
+- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/require-direct-export.js)

lib/index.js

@@ -48,6 +48,7 @@ module.exports = {
     'prop-name-casing': require('./rules/prop-name-casing'),
     'require-component-is': require('./rules/require-component-is'),
     'require-default-prop': require('./rules/require-default-prop'),
+    'require-direct-export': require('./rules/require-direct-export'),
     'require-prop-type-constructor': require('./rules/require-prop-type-constructor'),
     'require-prop-types': require('./rules/require-prop-types'),
     'require-render-return': require('./rules/require-render-return'),

lib/rules/require-direct-export.js

@@ -0,0 +1,46 @@
+/**
+ * @fileoverview require the component to be directly exported
+ * @author Hiroki Osame <[email protected]>
+ */
+'use strict'
+
+const utils = require('../utils')
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'require the component to be directly exported',
+      category: undefined,
+      url: 'https://eslint.vuejs.org/rules/require-direct-export.html'
+    },
+    fixable: null,  // or "code" or "whitespace"
+    schema: []
+  },
+
+  create (context) {
+    const filePath = context.getFilename()
+
+    return {
+      'ExportDefaultDeclaration:exit' (node) {
+        if (!utils.isVueFile(filePath)) return
+
+        const isObjectExpression = (
+          node.type === 'ExportDefaultDeclaration' &&
+          node.declaration.type === 'ObjectExpression'
+        )
+
+        if (!isObjectExpression) {
+          context.report({
+            node,
+            message: `Expected the component literal to be directly exported.`
+          })
+        }
+      }
+    }
+  }
+}

lib/utils/index.js

@@ -536,6 +536,10 @@ module.exports = {
       })
   },
 
+  isVueFile (path) {
+    return path.endsWith('.vue') || path.endsWith('.jsx')
+  },
+
   /**
    * Check whether the given node is a Vue component based
    * on the filename and default export type
@@ -545,8 +549,7 @@ module.exports = {
    * @returns {boolean}
    */
   isVueComponentFile (node, path) {
-    const isVueFile = path.endsWith('.vue') || path.endsWith('.jsx')
-    return isVueFile &&
+    return this.isVueFile(path) &&
       node.type === 'ExportDefaultDeclaration' &&
       node.declaration.type === 'ObjectExpression'
   },

tests/lib/rules/require-direct-export.js

@@ -0,0 +1,56 @@
+/**
+ * @fileoverview require the component to be directly exported
+ * @author Hiroki Osame <[email protected]>
+ */
+'use strict'
+
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/require-direct-export')
+const RuleTester = require('eslint').RuleTester
+
+const parserOptions = {
+  ecmaVersion: 2018,
+  sourceType: 'module',
+  ecmaFeatures: { jsx: true }
+}
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester()
+ruleTester.run('require-direct-export', rule, {
+
+  valid: [
+    {
+      filename: 'test.vue',
+      code: ''
+    },
+    {
+      filename: 'test.vue',
+      code: `
+            export default {}
+          `,
+      parserOptions
+    }
+  ],
+
+  invalid: [
+
+    {
+      filename: 'test.vue',
+      code: `
+          const A = {};
+          export default A`,
+      parserOptions,
+      errors: [{
+        message: 'Expected the component literal to be directly exported.',
+        type: 'ExportDefaultDeclaration',
+        line: 3
+      }]
+    }
+  ]
+})