New: no-use rule.

Author: mysticatea

README.md

@@ -6,7 +6,7 @@
 [![codecov](https://codecov.io/gh/mysticatea/eslint-plugin-eslint-comments/branch/master/graph/badge.svg)](https://codecov.io/gh/mysticatea/eslint-plugin-eslint-comments)
 [![Dependency Status](https://david-dm.org/mysticatea/eslint-plugin-eslint-comments.svg)](https://david-dm.org/mysticatea/eslint-plugin-eslint-comments)
 
-Additional ESLint rules for ESLint's directive comments (e.g. `//eslint-disable-line`).
+Additional ESLint rules for ESLint's directive-comments (e.g. `//eslint-disable-line`).
 
 ## :cd: Installation
 
@@ -49,7 +49,7 @@ Write in your ESLint configurations: http://eslint.org/docs/user-guide/configuri
 - [eslint-comments/no-duplicate-disable](docs/rules/no-duplicate-disable.md) disallows duplicate `eslint-disable` comments.
 - [eslint-comments/no-unlimited-disable](docs/rules/no-unlimited-disable.md) disallows `eslint-disable` comments without rule names.
 - [eslint-comments/no-unused-disable](docs/rules/no-unused-disable.md) disallows unused `eslint-disable` comments.
-- [eslint-comments/no-use](docs/rules/no-use.md) disallows ESLint directive comments.
+- [eslint-comments/no-use](docs/rules/no-use.md) disallows ESLint directive-comments.
 - [eslint-comments/no-useless-enable](docs/rules/no-useless-enable.md) disallows useless `eslint-enable` comments.
 
 ## :anchor: Semantic Versioning Policy

docs/rules/no-use.md

@@ -0,0 +1,53 @@
+# disallows ESLint directive-comments (eslint-comments/no-use)
+
+Abuse of directive-comments may cause to overlook bugs or upset of coding style.
+This rule disallows a use of directive-comments.
+
+## Rule Details
+
+Examples of :thumbsdown: **incorrect** code for this rule:
+
+```js
+/*eslint eslint-comments/no-use: error */
+
+/* eslint no-undef: off */
+/* eslint-env browser */
+/* eslint-enable */
+/* eslint-disable */
+// eslint-disable-line
+// eslint-disable-next-line
+/* exported foo */
+/* global $ */
+/* globals a, b, c */
+```
+
+## Options
+
+You can specify allowed directive-comments.
+
+```json
+{
+    "eslint-comments/no-use": ["error", {"allow": []}]
+}
+```
+
+- `allow` option is an array to allow specified directive-comments. The value of the array is some of the following strings:
+    - `"eslint"`
+    - `"eslint-disable"`
+    - `"eslint-disable-line"`
+    - `"eslint-disable-next-line"`
+    - `"eslint-enable"`
+    - `"eslint-env"`
+    - `"exported"`
+    - `"global"`
+    - `"globals"`
+
+## Known Limitations
+
+This rule cannot prevent the following case:
+
+```js
+/* eslint eslint-comments/no-use: off */
+```
+
+Because ESLint addresses the directive-comment before parsing.

lib/rules/no-use.js

@@ -0,0 +1,86 @@
+/**
+ * @author Toru Nagashima
+ * @copyright 2016 Toru Nagashima. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const utils = require("../utils")
+
+//------------------------------------------------------------------------------
+// Helpers
+//------------------------------------------------------------------------------
+
+const BLOCK_COMMENT_DIRECTIVE = /^\s*(eslint(?:-disable|-enable|-env)?|exported|globals?)(?:\s|$)/
+const LINE_COMMENT_DIRECTIVE = /^\s*(eslint-disable(?:-next)?-line)(?:\s|$)/
+const MESSAGE = "Unexpected ESLint directive comment."
+const NOT_FOUND = -1
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+module.exports = {
+    meta: {
+        docs: {
+            description: "disallows ESLint directive-comments",
+            category: "Best Practices",
+            recommended: false,
+        },
+        fixable: false,
+        schema: [{
+            type: "object",
+            properties: {
+                allow: {
+                    type: "array",
+                    items: {
+                        enum: [
+                            "eslint",
+                            "eslint-disable",
+                            "eslint-disable-line",
+                            "eslint-disable-next-line",
+                            "eslint-enable",
+                            "eslint-env",
+                            "exported",
+                            "global",
+                            "globals",
+                        ],
+                    },
+                    additionalItems: false,
+                    uniqueItems: true,
+                },
+            },
+            additionalProperties: false,
+        }],
+    },
+
+    create(context) {
+        const allowed = (context.options[0] && context.options[0].allow) || []
+
+        return {
+            BlockComment(token) {
+                const m = BLOCK_COMMENT_DIRECTIVE.exec(token.value)
+                if (m != null && allowed.indexOf(m[1]) === NOT_FOUND) {
+                    context.report({
+                        loc: utils.toForceLocation(token.loc),
+                        message: MESSAGE,
+                    })
+                }
+            },
+
+            LineComment(token) {
+                const m = LINE_COMMENT_DIRECTIVE.exec(token.value)
+                if (m != null && allowed.indexOf(m[1]) === NOT_FOUND) {
+                    context.report({
+                        loc: utils.toForceLocation(token.loc),
+                        message: MESSAGE,
+                    })
+                }
+            },
+        }
+    },
+}

lib/utils.js

@@ -0,0 +1,28 @@
+/**
+ * @author Toru Nagashima
+ * @copyright 2016 Toru Nagashima. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+//------------------------------------------------------------------------------
+// Exports
+//------------------------------------------------------------------------------
+
+module.exports = {
+    /**
+     * Make the location ignoring `eslint-disable` comments.
+     *
+     * @param {object} location - The location to convert.
+     * @returns {object} Converted location.
+     */
+    toForceLocation(location) {
+        return {
+            start: {
+                line: location.start.line,
+                column: -1,
+            },
+            end: location.end,
+        }
+    },
+}

tests/lib/rules/no-use.js

@@ -0,0 +1,108 @@
+/**
+ * @author Toru Nagashima
+ * @copyright 2016 Toru Nagashima. All rights reserved.
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const RuleTester = require("eslint").RuleTester
+const rule = require("../../../lib/rules/no-use")
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const tester = new RuleTester()
+
+tester.run("no-use", rule, {
+    valid: [
+        "// eslint foo",
+        "// eslint-disable",
+        "// eslint-enable",
+        "// exported",
+        "// global",
+        "// globals",
+        "// eslint-env",
+        "/* eslint-disable-line */",
+        "/* eslint-disable-next-line */",
+        "/* just eslint in a normal comment */",
+        {
+            code: "/* eslint */",
+            options: [{allow: ["eslint"]}],
+        },
+        {
+            code: "/* eslint-env */",
+            options: [{allow: ["eslint-env"]}],
+        },
+        {
+            code: "/* eslint-enable */",
+            options: [{allow: ["eslint-enable"]}],
+        },
+        {
+            code: "/* eslint-disable */",
+            options: [{allow: ["eslint-disable"]}],
+        },
+        {
+            code: "// eslint-disable-line",
+            options: [{allow: ["eslint-disable-line"]}],
+        },
+        {
+            code: "// eslint-disable-next-line",
+            options: [{allow: ["eslint-disable-next-line"]}],
+        },
+        {
+            code: "/* exported */",
+            options: [{allow: ["exported"]}],
+        },
+        {
+            code: "/* global */",
+            options: [{allow: ["global"]}],
+        },
+        {
+            code: "/* globals */",
+            options: [{allow: ["globals"]}],
+        },
+    ],
+    invalid: [
+        {
+            code: "/* eslint */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "/* eslint-env */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "/* eslint-enable */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "/* eslint-disable */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "// eslint-disable-line",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "// eslint-disable-next-line",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "/* exported */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "/* global */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+        {
+            code: "/* globals */",
+            errors: ["Unexpected ESLint directive comment."],
+        },
+    ],
+})