Merge branch 'master' into master

Author: inker

.circleci/config.yml

@@ -5,7 +5,6 @@ workflows:
       - node-v8
       - node-v10
       - node-v12
-      - node-v12-minimal
 
 version: 2
 jobs:
@@ -43,32 +42,3 @@ jobs:
     <<: *node-base
     docker:
       - image: node:12
-
-  node-v12-minimal:
-    docker:
-      - image: node:12
-    steps:
-      - run:
-          name: Versions
-          command: npm version
-      - checkout
-      - restore_cache:
-          keys:
-            - v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
-      - run:
-          name: Install dependencies
-          command: npm install
-      - save_cache:
-          key: v2-npm-lock-{{ .Branch }}-{{ .Environment.CIRCLE_JOB }}-{{ checksum "package.json" }}
-          paths:
-            - node_modules
-      - run:
-          name: Install eslint 5
-          command: |
-            # We need to execute this command twice because of npm's bug.
-            # See also: https://npm.community/t/error-node-modules-staging-eslint-e7cf6846-node-modules-eslint
-            npm install [email protected] [email protected] --no-save
-            npm install [email protected] [email protected] --no-save
-      - run:
-          name: Test
-          command: npm test

.eslintignore

@@ -2,7 +2,7 @@
 /coverage
 /node_modules
 /tests/fixtures
-/tests/integrations/*/node_modules
+/tests/integrations/eslint-plugin-import
 
 !.vuepress
 /docs/.vuepress/dist

.eslintrc.js

@@ -29,6 +29,7 @@ module.exports = {
     rules: {
       "consistent-docs-description": "error",
       "no-invalid-meta": "error",
+      "no-invalid-meta-docs-categories": "error",
       'eslint-plugin/require-meta-type': 'error',
       "require-meta-docs-url": ["error", {
         "pattern": `https://eslint.vuejs.org/rules/{{name}}.html`

README.md

@@ -11,6 +11,14 @@
 
 See [the official website](https://eslint.vuejs.org).
 
+> :exclamation: Attention - this is documentation for version `7.x` :exclamation:
+>
+> This branch contains `eslint-plugin-vue@next` which is a pre-released `7.0`, but it's not the default version that you get with `npm install eslint-plugin-vue`. In order to install this you need to specify either `"eslint-plugin-vue": "next"` in `package.json` or do `npm install eslint-plugin-vue@next`.
+>
+> Please try it and report any issues that you might have encountered.
+>
+> If you want to check previous releases [go here](https://github.com/vuejs/eslint-plugin-vue/releases).
+
 ## :anchor: Versioning Policy
 
 This plugin is following [Semantic Versioning](https://semver.org/) and [ESLint's Semantic Versioning Policy](https://github.com/eslint/eslint#semantic-versioning-policy).

docs/.vuepress/components/eslint-code-block.vue

@@ -18,8 +18,7 @@
 </template>
 
 <script>
-// https://github.com/vuejs/vuepress/issues/451
-import EslintEditor from '../../../node_modules/vue-eslint-editor'
+import EslintEditor from 'vue-eslint-editor'
 import { rules, processors } from '../../../'
 
 export default {

docs/.vuepress/config.js

@@ -5,11 +5,47 @@
 'use strict'
 
 const rules = require('../../tools/lib/rules')
-const categories = require('../../tools/lib/categories')
 
-const uncategorizedRules = rules.filter(rule => !rule.meta.docs.category && !rule.meta.deprecated)
+const uncategorizedRules = rules.filter(rule => !rule.meta.docs.categories && !rule.meta.deprecated)
 const deprecatedRules = rules.filter(rule => rule.meta.deprecated)
 
+const sidebarCategories = [
+  { title: 'Base Rules', categoryIds: ['base'] },
+  { title: 'Priority A: Essential', categoryIds: ['vue3-essential', 'essential'] },
+  { title: 'Priority A: Essential for Vue.js 3.x', categoryIds: ['vue3-essential'] },
+  { title: 'Priority A: Essential for Vue.js 2.x', categoryIds: ['essential'] },
+  { title: 'Priority B: Strongly Recommended', categoryIds: ['vue3-strongly-recommended', 'strongly-recommended'] },
+  { title: 'Priority B: Strongly Recommended for Vue.js 3.x', categoryIds: ['vue3-strongly-recommended'] },
+  { title: 'Priority B: Strongly Recommended for Vue.js 2.x', categoryIds: ['strongly-recommended'] },
+  { title: 'Priority C: Recommended', categoryIds: ['vue3-recommended', 'recommended'] },
+  { title: 'Priority C: Recommended for Vue.js 3.x', categoryIds: ['vue3-recommended'] },
+  { title: 'Priority C: Recommended for Vue.js 2.x', categoryIds: ['recommended'] }
+]
+
+const categorizedRules = []
+for (const { title, categoryIds } of sidebarCategories) {
+  const categoryRules = rules
+    .filter(rule => rule.meta.docs.categories && !rule.meta.deprecated)
+    .filter(rule => categoryIds
+      .every(categoryId => rule.meta.docs.categories.includes(categoryId))
+    )
+  const children = categoryRules
+    .filter(({ ruleId }) => {
+      const exists = categorizedRules.some(({ children }) => children.some(([, alreadyRuleId]) => alreadyRuleId === ruleId))
+      return !exists
+    })
+    .map(({ ruleId, name }) => [`/rules/${name}`, ruleId])
+
+  if (children.length === 0) {
+    continue
+  }
+  categorizedRules.push({
+    title,
+    collapsable: false,
+    children
+  })
+}
+
 const extraCategories = []
 if (uncategorizedRules.length > 0) {
   extraCategories.push({
@@ -30,22 +66,25 @@ module.exports = {
   base: '/',
   title: 'eslint-plugin-vue',
   description: 'Official ESLint plugin for Vue.js',
-  serviceWorker: true,
   evergreen: true,
   head: [
     ['link', { rel: 'icon', href: '/favicon.png' }]
   ],
 
+  plugins: {
+    '@vuepress/pwa': {
+      serviceWorker: true,
+      updatePopup: true
+    }
+  },
+
   themeConfig: {
     repo: 'vuejs/eslint-plugin-vue',
     docsRepo: 'vuejs/eslint-plugin-vue',
     docsDir: 'docs',
     docsBranch: 'master',
     editLinks: true,
     lastUpdated: true,
-    serviceWorker: {
-      updatePopup: true
-    },
 
     nav: [
       { text: 'User Guide', link: '/user-guide/' },
@@ -59,11 +98,7 @@ module.exports = {
         '/rules/',
 
         // Rules in each category.
-        ...categories.map(({ title, rules }) => ({
-          title: title.replace(/ \(.+?\)/, ''),
-          collapsable: false,
-          children: rules.map(({ ruleId, name }) => [`/rules/${name}`, ruleId])
-        })),
+        ...categorizedRules,
 
         // Rules in no category.
         ...extraCategories

docs/.vuepress/style.styl renamed to docs/.vuepress/styles/index.styl

@@ -1,4 +1,4 @@
-.theme-container.rule-details .content > h1 {
+.theme-container.rule-details .theme-default-content > h1 {
   font-size: 1.8rem;
 
   + blockquote {

docs/.vuepress/theme/index.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extend: '@vuepress/theme-default'
+}

docs/.vuepress/theme/layouts/Layout.vue

@@ -0,0 +1,79 @@
+<template>
+  <BaseLayout
+    v-bind="$attrs"
+    v-on="$listeners">
+    <slot
+      name="sidebar-top"
+      slot="sidebar-top"
+    />
+    <slot
+      name="sidebar-bottom"
+      slot="sidebar-bottom"
+    />
+    <template
+      slot="page-top">
+      <div class="theme-default-content beta-doc-description">
+        <div class="warning custom-block">
+          <p class="custom-block-title">Note</p>
+          <p>This is a documentation for version <code>{{docVersion}}</code>.<template v-if="hasNotYetBeenReleased"> Also, this documentation may contain content that has not yet been released.</template><br>
+          To check version <code>6.2.2</code> <a :href="v6DocLink">go here</a>.
+          To check previous releases <a href="https://github.com/vuejs/eslint-plugin-vue/releases">go here</a>.</p>
+        </div>
+      </div>
+      <slot
+        name="page-top"
+      />
+    </template>
+    <slot
+      name="page-bottom"
+      slot="page-bottom"
+    />
+  </BaseLayout>
+</template>
+
+<script>
+/**
+ * Layout definition to navigate to older versions of the document.
+ */
+import BaseLayout from '@vuepress/theme-default/layouts/Layout.vue'
+import semver from 'semver'
+const version = semver.parse(require('../../../../package.json').version)
+export default {
+  name: 'MyLayout',
+  components: {
+    BaseLayout
+  },
+  computed: {
+    docVersion () {
+      if (version.major < 7) {
+        return '7.x'
+      }
+      return version.raw
+    },
+    hasNotYetBeenReleased () {
+      if (version.major < 7) {
+        return true
+      }
+      return false
+    },
+    v6DocLink () {
+      if (this.$page.path.endsWith('.html')) {
+        return `https://github.com/vuejs/eslint-plugin-vue/blob/v6.2.2/docs${this.$page.path.replace(/\.html$/, '')}.md`
+      }
+      return `https://github.com/vuejs/eslint-plugin-vue/blob/v6.2.2/docs${this.$page.path}README.md`
+    }
+  }
+}
+</script>
+
+<style scoped>
+.beta-doc-description {
+  padding-bottom: 0;
+}
+* ::v-deep .theme-default-content ~ .theme-default-content {
+  padding-top: 0;
+}
+* ::v-deep .theme-default-content:not(.custom) h1{
+  margin-top: -3.1rem;
+}
+</style>