👕 refactor(eslint): docs linting

Author: kazupon

docs/.eslintrc.js

@@ -0,0 +1,8 @@
+'use strict'
+
+module.exports = {
+  extends: '../.eslintrc.js',
+  plugins: [
+    'markdown'
+  ]
+}

docs/rules/no-dynamic-keys.md

@@ -39,6 +39,9 @@ localization codes:
 ```
 
 ```js
+import Vue from 'vue'
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {
@@ -71,23 +74,26 @@ localization codes:
 ```vue
 <template>
   <div class="app">
-    <!-- ✗ GOOD -->
+    <!-- ✓ GOOD -->
     <p>{{ $t('hello') }}</p>
-    <!-- ✗ GOOD -->
+    <!-- ✓ GOOD -->
     <p v-t="'hello'"></p>
   </div>
 </template>
 ```
 
 ```js
+import Vue from 'vue'
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {
     en: require('./locales/en.json')
   }
 })
 
-const app = new Vue({
+new Vue({
   i18n,
   data () {
     return { msg: 'hello' }

docs/rules/no-html-messages.md

@@ -13,7 +13,7 @@ This rule is aimed at eliminating HTML localization messages.
 :-1: Examples of **incorrect** code for this rule:
 
 locale messages:
-```js
+```json
 // ✗ BAD
 {
   "hello": "Hello! DIO!",
@@ -40,6 +40,9 @@ In localization codes of application:
 ```
 
 ```js
+import Vue from 'vue'
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {
@@ -48,15 +51,15 @@ const i18n = new VueI18n({
 })
 
 new Vue({
-  i18n,
+  i18n
   // ...
 }).$mount('#app')
 ```
 
 :+1: Examples of **correct** code for this rule:
 
 locale messages:
-```js
+```json
 // ✓ GOOD
 {
   "hello": "Hello! DIO!",
@@ -85,6 +88,9 @@ In localization codes of application:
 ```
 
 ```js
+import Vue from 'vue'
+import VueI18n from 'vue-i18n'
+
 // import some components used in i18n component
 import Banner from './path/to/components/Banner.vue'
 import Modal from './path/to/components/Modal.vue'

docs/rules/no-missing-keys.md

@@ -42,6 +42,8 @@ localization codes:
 ```
 
 ```js
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {
@@ -67,17 +69,19 @@ localization codes:
 ```vue
 <template>
   <div class="app">
-    <!-- ✗ GOOD -->
+    <!-- ✓ GOOD -->
     <p>{{ $t('hello') }}</p>
-    <!-- ✗ GOOD -->
+    <!-- ✓ GOOD -->
     <p v-t="'hello'"></p>
-    <!-- ✗ GOOD -->
+    <!-- ✓ GOOD -->
     <i18n path="hello" tag="p"></i18n>
   </div>
 </template>
 ```
 
 ```js
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {

docs/rules/no-unused-keys.md

@@ -11,7 +11,7 @@ This rule is aimed at eliminating unused localization keys.
 :-1: Examples of **incorrect** code for this rule:
 
 locale messages:
-```js
+```json
 // ✗ BAD
 {
   "hello": "Hello! DIO!",
@@ -30,6 +30,8 @@ In localization codes of application:
 ```
 
 ```js
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {
@@ -43,7 +45,7 @@ i18n.t('hello')
 :+1: Examples of **correct** code for this rule:
 
 locale messages:
-```js
+```json
 // ✓ GOOD
 {
   "hello": "Hello! DIO!",
@@ -62,6 +64,8 @@ In localization codes of application:
 ```
 
 ```js
+import VueI18n from 'vue-i18n'
+
 const i18n = new VueI18n({
   locale: 'en',
   messages: {

docs/started.md

@@ -20,21 +20,21 @@ Configure your `.eslintrc.*` file.
 For example:
 
 ```js
-{
-  "extends": [
-    "eslint:recommended",
-    "plugin:vue-i18n/recommended"
+module.export = {
+  extends: [
+    'eslint:recommended',
+    'plugin:vue-i18n/recommended'
   ],
-  "rules": {
+  rules: {
     // Optional.
-    "vue-i18n/no-dynamic-keys": "error",
-    "vue-i18n/no-unused-keys": ["error", {
-      "extensions": [".js", ".vue"]
+    'vue-i18n/no-dynamic-keys': 'error',
+    'vue-i18n/no-unused-keys': ['error', {
+      extensions: ['.js', '.vue']
     }]
   },
-  "settings": {
-    "vue-i18n": {
-      "localeDir": "./path/to/locales/*.json" // extention is glob formatting!
+  settings: {
+    'vue-i18n': {
+      localeDir: './path/to/locales/*.json' // extention is glob formatting!
     }
   }
 }

package.json

@@ -23,6 +23,7 @@
     "conventional-changelog-cli": "^2.0.12",
     "conventional-github-releaser": "^3.1.2",
     "eslint": "^5.15.0",
+    "eslint-plugin-markdown": "^1.0.0",
     "eslint-plugin-vue-libs": "^3.0.0",
     "git-commit-message-convention": "git://github.com/kazupon/git-commit-message-convention.git",
     "mocha": "^6.0.2",
@@ -66,6 +67,7 @@
     "docs:build": "vuepress build docs",
     "generate": "node scripts/update.js",
     "lint": "eslint lib scripts tests docs/.vuepress --ignore-pattern \"!.*\"",
+    "lint:docs": "eslint --ext js,vue,md docs --ignore-pattern \"!.*\"",
     "release": "conventional-github-releaser -n ./node_modules/git-commit-message-convention/convention.js",
     "test": "mocha ./tests/**/*.js",
     "test:coverage": "nyc mocha ./tests/**/*.js"