Docs: add vuepress site

Author: mysticatea

.eslintignore

@@ -1,2 +1,6 @@
+/.nyc_output
+/coverage
 /node_modules
-!.eslintrc.js
+
+!.vuepress
+/docs/.vuepress/dist

.eslintrc.js

@@ -0,0 +1,14 @@
+extends:
+  - plugin:mysticatea/es2015
+  - plugin:mysticatea/+eslint-plugin
+
+overrides:
+  - files: "docs/.vuepress/components/*.vue"
+    parserOptions:
+      parser: babel-eslint
+
+  - files: "lib/rules/*.js"
+    rules:
+      mysticatea/eslint-plugin/require-meta-docs-url:
+        - error
+        - pattern: "https://mysticatea.github.io/eslint-plugin-eslint-comments/rules/{{name}}.html"

.eslintrc.yml

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

.gitignore

@@ -18,3 +18,17 @@ script:
 
 after_success:
   - npm run codecov
+
+before_deploy:
+  - npm run docs:build
+
+deploy:
+  provider: pages
+  github-token: $ATOKEN
+  keep-history: true
+  local-dir: docs/.vuepress/dist
+  on:
+    branch: master
+    node: "10"
+    condition: $ESLINT_VERSION = ^4.19.1
+  skip-cleanup: true

.travis.yml

@@ -8,74 +8,9 @@
 
 Additional ESLint rules for ESLint directive comments (e.g. `//eslint-disable-line`).
 
-## 💿 Installation
-
-```
-npm install --save-dev eslint eslint-plugin-eslint-comments
-```
-
-### Requirements
-
-- Node.js `^6.5.0`, or newer versions.
-- ESLint `^4.19.1`, or newer versions.
-
 ## 📖 Usage
 
-Write in your ESLint configurations: http://eslint.org/docs/user-guide/configuring#using-the-configuration-from-a-plugin
-
-### Example
-
-**.eslintrc.json**
-
-```json
-{
-    "extends": [
-        "eslint:recommended",
-        "plugin:eslint-comments/recommended"
-    ],
-}
-```
-
-Or you can specify for each rule:
-
-```json
-{
-    "plugins": [
-        "eslint-comments"
-    ],
-    "rules": {
-        "eslint-comments/no-unused-disable": "error",
-        "eslint-comments/no-unused-enable": "error",
-        // ...
-    }
-}
-```
-
-## Rules
-
-- 🌟 mark: the rule is enabled by `eslint-comments/recommended` preset.
-- ✒️ mark: the rule is fixable by `eslint --fix` command.
-
-<!--RULES_TABLE_START-->
-### Best Practices
-
-|    | Rule ID | Description |
-|:---|:--------|:------------|
-| 🌟 | [eslint-comments/disable-enable-pair](./docs/rules/disable-enable-pair.md) | requires a `eslint-enable` comment for every `eslint-disable` comment |
-| 🌟 | [eslint-comments/no-aggregating-enable](./docs/rules/no-aggregating-enable.md) | disallows `eslint-enable` comments for multiple `eslint-disable` comments |
-| 🌟 | [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-unused-enable](./docs/rules/no-unused-enable.md) | disallows unused `eslint-enable` comments |
-
-### Stylistic Issues
-
-|    | Rule ID | Description |
-|:---|:--------|:------------|
-|  | [eslint-comments/no-restricted-disable](./docs/rules/no-restricted-disable.md) | disallows `eslint-disable` comments about specific rules |
-|  | [eslint-comments/no-use](./docs/rules/no-use.md) | disallows ESLint directive-comments |
-
-<!--RULES_TABLE_END-->
+- [Documentation](https://mysticatea.github.io/eslint-plugin-eslint-comments)
 
 ## 🚥 Semantic Versioning Policy
 

README.md

@@ -0,0 +1,115 @@
+<template>
+    <eslint-editor
+        :linter="linter"
+        :config="config"
+        :code="code"
+        :class="`eslint-playground-${type}`"
+        class="eslint-playground"
+        dark
+        fix
+    />
+</template>
+
+<script>
+// https://github.com/vuejs/vuepress/issues/451
+import EslintEditor from "../../../node_modules/vue-eslint-editor"
+import { rules } from "../../../"
+
+export default {
+    name: "ESLintPlayground",
+    components: { EslintEditor },
+
+    props: {
+        code: {
+            type: String,
+            required: true,
+        },
+        type: {
+            type: String,
+            required: true,
+            validator(value) {
+                return value === "bad" || value === "good"
+            },
+        },
+        reportUnusedDisable: {
+            type: Boolean,
+            default: false,
+        },
+    },
+
+    data() {
+        return {
+            linter: null,
+        }
+    },
+
+    computed: {
+        config() {
+            const config = {
+                globals: {
+                    // ES2015 globals
+                    ArrayBuffer: false,
+                    DataView: false,
+                    Float32Array: false,
+                    Float64Array: false,
+                    Int16Array: false,
+                    Int32Array: false,
+                    Int8Array: false,
+                    Map: false,
+                    Promise: false,
+                    Proxy: false,
+                    Reflect: false,
+                    Set: false,
+                    Symbol: false,
+                    Uint16Array: false,
+                    Uint32Array: false,
+                    Uint8Array: false,
+                    Uint8ClampedArray: false,
+                    WeakMap: false,
+                    WeakSet: false,
+                    // ES2017 globals
+                    Atomics: false,
+                    SharedArrayBuffer: false,
+                },
+                rules: {},
+                parserOptions: {
+                    ecmaVersion: 2018,
+                    sourceType: "module",
+                },
+            }
+
+            if (this.reportUnusedDisable) {
+                config.rules["eslint-comments/no-unused-disable"] = "error"
+            }
+
+            return config
+        },
+    },
+
+    async mounted() {
+        // Load linter.
+        const { default: Linter } = await import("eslint4b")
+        const linter = (this.linter = new Linter())
+
+        for (const ruleId of Object.keys(rules)) {
+            linter.defineRule(`eslint-comments/${ruleId}`, rules[ruleId])
+        }
+    },
+}
+</script>
+
+<style>
+.eslint-playground {
+    width: 100%;
+    min-height: 160px;
+    margin-bottom: 8px;
+    box-sizing: border-box;
+    border: 1.5px solid gray;
+}
+.eslint-playground-good {
+    border-color: #4caf50;
+}
+.eslint-playground-bad {
+    border-color: #f44336;
+}
+</style>

docs/.vuepress/components/eslint-playground.vue

@@ -0,0 +1,69 @@
+/**
+ * @author Toru Nagashima <https://github.com/mysticatea>
+ * See LICENSE file in root directory for full license.
+ */
+"use strict"
+
+const rules = require("../../scripts/lib/rules")
+require("../../scripts/update-docs-headers")
+require("../../scripts/update-docs-index")
+
+module.exports = {
+    base: "/eslint-plugin-eslint-comments/",
+    title: "eslint-plugin-eslint-comments",
+    description: "ESLint plugin about ECMAScript syntax.",
+    serviceWorker: true,
+    ga: "UA-12936571-6",
+    evergreen: true,
+
+    themeConfig: {
+        repo: "mysticatea/eslint-plugin-eslint-comments",
+        docsRepo: "mysticatea/eslint-plugin-eslint-comments",
+        docsDir: "docs",
+        docsBranch: "master",
+        editLinks: true,
+        lastUpdated: true,
+        serviceWorker: {
+            updatePopup: true,
+        },
+
+        nav: [
+            { text: "Guide", link: "/guide/getting-started" },
+            { text: "Rules", link: "/rules/" },
+        ],
+
+        sidebarDepth: 0,
+        sidebar: [
+            {
+                title: "Guide",
+                collapsable: false,
+                children: ["/", "/guide/getting-started"],
+            },
+            {
+                title: "Rules",
+                collapsable: false,
+                children: [
+                    "/rules/",
+                    ...rules.map(({ id, name }) => [`/rules/${name}`, id]),
+                ],
+            },
+        ],
+    },
+
+    configureWebpack: {
+        module: {
+            rules: [
+                {
+                    test: new RegExp(String.raw`internal[\\/]get-linters\.js$`),
+                    loader: "string-replace-loader",
+                    options: {
+                        search: "[\\s\\S]+", // whole file.
+                        replace:
+                            'module.exports = () => [require("eslint4b/dist/linter")]',
+                        flags: "g",
+                    },
+                },
+            ],
+        },
+    },
+}

docs/.vuepress/config.js

@@ -0,0 +1 @@
+$accentColor = #463fd4