Chore: Add "no-layout-rules" config (#698)

* Add 'no-layout-rules' config
* Enable eslint-plugin/require-meta-type rule

Author: michalsnik

.eslintrc.js

@@ -28,6 +28,7 @@ module.exports = {
     rules: {
       "consistent-docs-description": "error",
       "no-invalid-meta": "error",
+      'eslint-plugin/require-meta-type': 'error',
       "require-meta-docs-url": ["error", {
         "pattern": `https://vuejs.github.io/eslint-plugin-vue/rules/{{name}}.html`
       }]

lib/configs/no-layout-rules.js

@@ -0,0 +1,21 @@
+/*
+ * IMPORTANT!
+ * This file has been automatically generated,
+ * in order to update it's content execute "npm run update"
+ */
+module.exports = {
+  rules: {
+    'vue/html-closing-bracket-newline': 'off',
+    'vue/html-closing-bracket-spacing': 'off',
+    'vue/html-indent': 'off',
+    'vue/html-quotes': 'off',
+    'vue/html-self-closing': 'off',
+    'vue/max-attributes-per-line': 'off',
+    'vue/multiline-html-element-content-newline': 'off',
+    'vue/mustache-interpolation-spacing': 'off',
+    'vue/no-multi-spaces': 'off',
+    'vue/no-spaces-around-equal-signs-in-attribute': 'off',
+    'vue/script-indent': 'off',
+    'vue/singleline-html-element-content-newline': 'off'
+  }
+}

lib/index.js

@@ -73,8 +73,9 @@ module.exports = {
   configs: {
     'base': require('./configs/base'),
     'essential': require('./configs/essential'),
-    'strongly-recommended': require('./configs/strongly-recommended'),
-    'recommended': require('./configs/recommended')
+    'no-layout-rules': require('./configs/no-layout-rules'),
+    'recommended': require('./configs/recommended'),
+    'strongly-recommended': require('./configs/strongly-recommended')
   },
   processors: {
     '.vue': require('./processor')

lib/rules/v-bind-style.js

@@ -17,7 +17,7 @@ const utils = require('../utils')
 
 module.exports = {
   meta: {
-    type: 'layout',
+    type: 'suggestion',
     docs: {
       description: 'enforce `v-bind` directive style',
       category: 'strongly-recommended',

lib/rules/v-on-style.js

@@ -17,7 +17,7 @@ const utils = require('../utils')
 
 module.exports = {
   meta: {
-    type: 'layout',
+    type: 'suggestion',
     docs: {
       description: 'enforce `v-on` directive style',
       category: 'strongly-recommended',

package.json

@@ -53,8 +53,8 @@
     "@types/node": "^4.2.16",
     "babel-eslint": "^8.2.2",
     "chai": "^4.1.0",
-    "eslint": "^5.2.0",
-    "eslint-plugin-eslint-plugin": "^1.4.0",
+    "eslint": "^5.11.1",
+    "eslint-plugin-eslint-plugin": "^2.0.1",
     "eslint-plugin-vue-libs": "^3.0.0",
     "eslint4b": "^5.1.0",
     "lodash": "^4.17.4",

tools/lib/configs.js

@@ -0,0 +1,15 @@
+/**
+ * @author Michał Sajnóg <https://github.com/michalsnik>
+ * See LICENSE file in root directory for full license.
+ */
+
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+const ROOT = path.resolve(__dirname, '../../lib/configs')
+
+module.exports =
+  fs.readdirSync(ROOT)
+    .filter(file => path.extname(file) === '.js')
+    .map(file => path.basename(file, '.js'))

tools/update-lib-index.js

@@ -13,7 +13,7 @@ const fs = require('fs')
 const path = require('path')
 const eslint = require('eslint')
 const rules = require('./lib/rules')
-const categories = require('./lib/categories')
+const configs = require('./lib/configs')
 
 // Update files.
 const filePath = path.resolve(__dirname, '../lib/index.js')
@@ -29,7 +29,7 @@ module.exports = {
     ${rules.map(rule => `'${rule.name}': require('./rules/${rule.name}')`).join(',\n')}
   },
   configs: {
-    ${categories.map(category => `'${category.categoryId}': require('./configs/${category.categoryId}')`).join(',\n')}
+    ${configs.map(config => `'${config}': require('./configs/${config}')`).join(',\n')}
   },
   processors: {
     '.vue': require('./processor')

tools/update-no-layout-rules-config.js

@@ -0,0 +1,42 @@
+/**
+ * @author Michał Sajnóg
+ * @copyright 2018 Michał Sajnóg. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+'use strict'
+
+/*
+ * This script updates `lib/configs/prettier.js`,
+ * and disables all layout rules
+ */
+
+const fs = require('fs')
+const path = require('path')
+const rules = require('./lib/rules')
+
+const rulesToDisable = rules.filter(({ meta }) => meta.type === 'layout')
+
+function formatRules (rules) {
+  const obj = rules.reduce((setting, rule) => {
+    setting[rule.ruleId] = 'off'
+    return setting
+  }, {})
+  return JSON.stringify(obj, null, 2)
+}
+
+function generateConfig (rules) {
+  return `/*
+ * IMPORTANT!
+ * This file has been automatically generated,
+ * in order to update it's content execute "npm run update"
+ */
+module.exports = {
+  rules: ${formatRules(rules)}
+}
+`
+}
+
+// Update files.
+const filePath = path.resolve(__dirname, '../lib/configs/no-layout-rules.js')
+const content = generateConfig(rulesToDisable)
+fs.writeFileSync(filePath, content)

tools/update.js

@@ -5,6 +5,7 @@
  */
 'use strict'
 
+require('./update-no-layout-rules-config')
 require('./update-lib-configs')
 require('./update-lib-index')
 require('./update-docs')