New: eslint-comments/recommended preset

Author: mysticatea

.gitignore

@@ -1,7 +1,6 @@
 /.nyc_output
 /.vscode
 /coverage
-/index.js
 /node_modules
 /npm-debug.log
 /test.js

index.js

@@ -0,0 +1,34 @@
+/**
+ * @author Toru Nagashima
+ * @copyright 2016 Toru Nagashima. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+module.exports = {
+    configs: {
+        recommended: {
+            plugins: ["eslint-comments"],
+            rules: {
+                "eslint-comments/disable-enable-pair": "error",
+                "eslint-comments/no-aggregating-enable": "error",
+                "eslint-comments/no-duplicate-disable": "error",
+                "eslint-comments/no-restricted-disable": "off",
+                "eslint-comments/no-unlimited-disable": "error",
+                "eslint-comments/no-unused-disable": "error",
+                "eslint-comments/no-unused-enable": "error",
+                "eslint-comments/no-use": "off",
+            },
+        },
+    },
+    rules: {
+        "disable-enable-pair": require("./lib/rules/disable-enable-pair"),
+        "no-aggregating-enable": require("./lib/rules/no-aggregating-enable"),
+        "no-duplicate-disable": require("./lib/rules/no-duplicate-disable"),
+        "no-restricted-disable": require("./lib/rules/no-restricted-disable"),
+        "no-unlimited-disable": require("./lib/rules/no-unlimited-disable"),
+        "no-unused-disable": require("./lib/rules/no-unused-disable"),
+        "no-unused-enable": require("./lib/rules/no-unused-enable"),
+        "no-use": require("./lib/rules/no-use"),
+    },
+}

lib/rules/no-aggregating-enable.js

@@ -18,7 +18,7 @@ const utils = require("../utils")
 
 /**
  * Creates AST event handlers for no-aggregating-enable.
- * 
+ *
  * @param {RuleContext} context - The rule context.
  * @returns {object} AST event handlers.
  */

lib/rules/no-restricted-disable.js

@@ -19,7 +19,7 @@ const utils = require("../utils")
 
 /**
  * Creates AST event handlers for no-restricted-disable.
- * 
+ *
  * @param {RuleContext} context - The rule context.
  * @returns {object} AST event handlers.
  */

package.json

@@ -19,7 +19,7 @@
   "devDependencies": {
     "chokidar-cli": "^1.2.0",
     "codecov": "^3.0.0",
-    "eslint": "^4.7.0",
+    "eslint": "^4.10.0",
     "eslint-config-mysticatea": "^12.0.0",
     "mocha": "^4.0.0",
     "npm-run-all": "^4.1.1",
@@ -30,7 +30,7 @@
   "scripts": {
     "preversion": "run-s clean test build",
     "postversion": "git push && git push --tags",
-    "build": "node scripts/generate-index.js",
+    "build": "node scripts/build.js",
     "clean": "rimraf .nyc_output coverage index.js",
     "lint": "eslint lib scripts tests",
     "test": "nyc mocha \"tests/lib/**/*.js\" --reporter progress",

scripts/build.js

@@ -0,0 +1,37 @@
+/**
+ * @author Toru Nagashima <https://github.com/mysticatea>
+ * @copyright 2017 Toru Nagashima. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const fs = require("fs")
+const path = require("path")
+const generateIndex = require("./generate-index")
+
+//------------------------------------------------------------------------------
+// Main
+//------------------------------------------------------------------------------
+
+const rules =
+    fs.readdirSync(path.resolve(__dirname, "../lib/rules"))
+        .map(fileName => path.basename(fileName, ".js"))
+        .map(name => {
+            const meta = require(`../lib/rules/${name}`).meta
+            return {
+                id: `eslint-comments/${name}`,
+                name,
+                category: meta.docs.category,
+                description: meta.docs.description,
+                recommended: meta.docs.recommended,
+                fixable: meta.fixable,
+                deprecated: meta.deprecated,
+                replacedBy: meta.docs.replacedBy,
+            }
+        })
+
+generateIndex(rules)

scripts/generate-index.js

@@ -13,24 +13,40 @@ const fs = require("fs")
 const path = require("path")
 
 //------------------------------------------------------------------------------
-// Main
+// Helpers
 //------------------------------------------------------------------------------
 
-fs.writeFileSync(path.resolve(__dirname, "../index.js"), `/**
+const INDEX_FILE_PATH = path.resolve(__dirname, "../index.js")
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+/**
+ * Generate `index.js` file.
+ * @param {{id:string,name:string,category:string,description:string,recommended:boolean,fixable:boolean,deprecated:boolean,replacedBy:string[]}[]} rules The rules to generate index.js.
+ * @returns {void}
+ */
+module.exports = (rules) => {
+    fs.writeFileSync(INDEX_FILE_PATH, `/**
  * @author Toru Nagashima
  * @copyright 2016 Toru Nagashima. All rights reserved.
  * See LICENSE file in root directory for full license.
  */
 "use strict"
 
 module.exports = {
+    configs: {
+        recommended: {
+            plugins: ["eslint-comments"],
+            rules: {
+${rules.map(rule => `                "${rule.id}": "${rule.recommended ? "error" : "off"}",`).join("\n")}
+            },
+        },
+    },
     rules: {
-${
-    fs.readdirSync(path.resolve(__dirname, "../lib/rules"))
-        .map(fileName => path.basename(fileName, ".js"))
-        .map(ruleId => `        "${ruleId}": require("./lib/rules/${ruleId}"),`)
-        .join("\n")
-}
+${rules.map(rule => `        "${rule.name}": require("./lib/rules/${rule.name}"),`).join("\n")}
     },
 }
 `)
+}