Docs: add vuepress documentation (#534)

* Docs: add vuepress documentation

* small update for rule index

* add links to source code

* small tweaks

* upgrade vuepress

* update eslint-code-block component

* update attribute-hyphenation

* update attributes-order

* update component-name-in-template-casing

* update html-closing-bracket-newline

* update html-closing-bracket-spacing

* update html-end-tags

* update html-indent

* update html-quotes

* update html-self-closing

* update max-attributes-per-line

* add uncategorized rules to sidebar

* update mustache-interpolation-spacing

* update name-property-casing

* update no-async-in-computed-properties

* update no-confusing-v-for-v-if

* update no-dupe-keys

* update no-duplicate-attributes

* update no-multi-spaces

* update no-parsing-error

* update no-reserved-keys

* update no-shared-component-data

* update no-side-effects-in-computed-properties

* update no-template-key

* update no-template-shadow

* update no-textarea-mustache

* update no-unused-vars

* update no-use-v-if-with-v-for

* update no-v-html

* update order-in-components

* update prop-name-casing

* Add `valid-*` eslint-code-block (#622)

* Update documentation

- no-spaces-around-equal-signs-in-attribute
- script-indent
- singleline-html-element-content-newline
- use-v-on-exact

* Change some of blockquotes to warnings

* require-prop-type-constructor

* add missing Implementation blocks

* comment-directive

* require-render-return

* jsx-uses-vars code type

* require-prop-type-constructor

* update

- require-v-for-key
- require-valid-default-prop
- return-in-computed-property

* add missing options

* Update

- v-on-style
- v-bind-style

* fix remaining missing options

update: valid-v-on

* Update require-component-is & no-use-v-if-with-v-for

* Update formating from html to vue

* require-default-prop

* Related links -> 📚 Further reading

* standarize heading icons

* Add processors

* no-multi-spaces after merge

* improve consistency across docs

* this-in-template

* require-prop-types

* multiline-html-element-content-newline

* fix json structure in return in computed property

* Add Further reading for few rules

* no-unused-components

* Enable fixing eslint-code-block only one fixable rules

* Add deprecated category

This category will be present only if we have deprecated rules

* Do not include cateogry in deprecated rules

* Add example to return-in-computed-property

* Add links and fix style

* fix rebase issue no-multi-spaces

* Update description of require-v-for-key

* Update docs/rules/require-render-return.md

* add moe notes

* Improve readibility and add Further reading links

* mustache-interpolation-spacing & name-property-casing

move default example to rule details

* Add IntelliJ IDEA / JetBrains WebStorm configuration help

 move editor configuration to correct section

* Fix links

* replace emoji with shortcodes

* Add yarn install guide

* Fix issue with not supported `vue/comment-directive`

* unify options json (2 -> "error")

2 is used only if few examples but "error" is used in alot of them

* Add bad example of no-use-v-vi-with-v-for

* editor: update default formating to preset in documentation

* Update vue-eslint-editor to fix tooltip issue

* Add comment about auto-generated content

* Fix indentations in Vue file

* Add short description for vue/attribute-hyphenation rule

* Add short description for vue/this-in-template rule

* Update valid-template-root docs

* Update user guide structure

* Update rules heading in docs

* Flatten sidebar navigation for rules

* Update valid-template-root.md

* Update README.md

* Setup docs deployment

* Uncomment deploy.sh

* Add description metadata to rule pages & fix updating metadata when header is present

* Indicate `no-parsing-error` warning as Note

* Ignore gh-pages in CircleCI

* Fix CircleCI config

Author: mysticatea

.circleci/config.yml

@@ -2,10 +2,28 @@ workflows:
   version: 2
   node-multi-build:
     jobs:
-      - node-v6
-      - node-v8
-      - node-v10
-      - node-v10-minimal
+      - node-v6:
+          filters:
+            branches:
+              ignore: gh-pages
+      - node-v8:
+          filters:
+            branches:
+              ignore: gh-pages
+      - node-v10:
+          filters:
+            branches:
+              ignore: gh-pages
+      - node-v10-minimal:
+          filters:
+            branches:
+              ignore: gh-pages
+      - deploy_docs:
+          requires:
+            - node-v10
+          filters:
+            branches:
+              only: master
 
 version: 2
 jobs:
@@ -20,19 +38,16 @@ jobs:
       - restore_cache:
           keys:
             - v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
-            - v2-npm-lock-master-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
-            - v2-npm-cache-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}
-            - v2-npm-cache-master-{{ .Environment.CIRCLE_JOB }}
       - run:
           name: Install dependencies
           command: npm install
-      - run:
-          name: Test
-          command: npm test
       - save_cache:
           key: v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
           paths:
             - node_modules
+      - run:
+          name: Test
+          command: npm test
 
   node-v6:
     <<: *node-base
@@ -46,6 +61,7 @@ jobs:
     <<: *node-base
     docker:
       - image: node:10
+    working_directory: ~/node_10
   node-v10-minimal:
     steps:
       - run:
@@ -73,4 +89,13 @@ jobs:
             - node_modules
     docker:
       - image: node:10
-    
+
+  deploy_docs:
+    docker:
+      - image: node:10
+    steps:
+      - attach_workspace:
+          at: ~/node_10
+      - run:
+          name: Deploy to Github Pages
+          command: npm run docs:deploy

.eslintignore

@@ -3,3 +3,6 @@
 /node_modules
 /tests/fixtures
 /tests/integrations/*/node_modules
+
+!.vuepress
+/docs/.vuepress/dist

.gitignore

@@ -7,3 +7,4 @@
 /test.*
 yarn.lock
 yarn-error.log
+docs/.vuepress/dist

.vscode/settings.json

@@ -2,5 +2,10 @@
     "editor.tabSize": 2,
     "eslint.options": {
         "rulePaths": ["eslint-internal-rules"]
-    }
+    },
+    "eslint.validate": [
+        "javascript",
+        "javascriptreact",
+        { "language": "vue", "autoFix": true }
+    ]
 }