Merge 05abe66 into 4e65b25

future-architect · Jul 22, 2020 · 1fb64ca · 1fb64ca
2 parents 4e65b25 + 05abe66
commit 1fb64ca
Show file tree

Hide file tree

Showing 92 changed files with 3,813 additions and 2,102 deletions.
diff --git a/.github/workflows/NodeCI.yml b/.github/workflows/NodeCI.yml
@@ -0,0 +1,64 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+      with:
+        node-version: 14
+    - name: Install Packages
+      run: npm install
+    - name: Lint
+      run: npm run lint
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [10.13.x, 12.x, 13.x, 14.x]
+    steps:
+    - uses: actions/checkout@v1
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install Packages
+      run: npm install
+    - name: build
+      run: npm run build
+    - name: Test
+      run: npm test
+  test-with-eslint6:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+      with:
+        node-version: 8.10.x
+    - name: Install Target Packages
+      run: |+
+        npm i -D eslint@6.0.0
+        npx rimraf node_modules
+        npm install
+    - name: Test
+      run: npm test
+  test-and-coverage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v1
+    - uses: actions/setup-node@v1
+    - name: Install Packages
+      run: npm install
+    - name: Test
+      run: npm run test:nyc
+    - name: Coveralls GitHub Action
+      uses: coverallsapp/github-action@v1.1.1
+      with:
+        github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/NpmPublish.yml b/.github/workflows/NpmPublish.yml
@@ -0,0 +1,28 @@
+name: publish
+on:
+  push:
+    tags:
+      - "*"
+jobs:
+  release:
+    name: check version, and release
+    runs-on: ubuntu-latest
+    steps:
+    - name: checkout
+      uses: actions/checkout@v1
+    - name: setup Node
+      uses: actions/setup-node@v1
+      with:
+        registry-url: 'https://registry.npmjs.org'
+    - name: Install Packages
+      run: npm install
+    - name: test
+      run: npm run test
+    - name: check can npm-publish
+      run: npx can-npm-publish
+    - name: build
+      run: npm run build
+    - name: release
+      run: npm publish
+      env:
+        NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/README.md b/README.md
@@ -9,7 +9,7 @@
 [![NPM downloads](https://img.shields.io/npm/dm/eslint-plugin-vue-scoped-css.svg)](http://www.npmtrends.com/eslint-plugin-vue-scoped-css)
 [![NPM downloads](https://img.shields.io/npm/dy/eslint-plugin-vue-scoped-css.svg)](http://www.npmtrends.com/eslint-plugin-vue-scoped-css)
 [![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-vue-scoped-css.svg)](http://www.npmtrends.com/eslint-plugin-vue-scoped-css)
-[![Build Status](https://travis-ci.com/future-architect/eslint-plugin-vue-scoped-css.svg?branch=master)](https://travis-ci.com/future-architect/eslint-plugin-vue-scoped-css)
+[![Build Status](https://github.com/future-architect/eslint-plugin-vue-scoped-css/workflows/CI/badge.svg?branch=master)](https://github.com/future-architect/eslint-plugin-vue-scoped-css/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/github/future-architect/eslint-plugin-vue-scoped-css/badge.svg?branch=master)](https://coveralls.io/github/future-architect/eslint-plugin-vue-scoped-css?branch=master)
 <!--
 [![Greenkeeper badge](https://badges.greenkeeper.io/future-architect/eslint-plugin-vue-scoped-css.svg)](https://greenkeeper.io/)
@@ -103,6 +103,23 @@ Enforce all the rules in this category with:
 | [vue-scoped-css/no-unused-selector](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-selector.html) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
 | [vue-scoped-css/require-scoped](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-scoped.html) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
 
+## Recommended for Vue.js 3.x
+
+Enforce all the rules in this category with:
+
+```json
+{
+  "extends": "plugin:vue-scoped-css/vue3-recommended"
+}
+```
+
+| Rule ID | Description |    |
+|:--------|:------------|:---|
+| [vue-scoped-css/no-parsing-error](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-parsing-error.html) | Disallow parsing errors in `<style>` |  |
+| [vue-scoped-css/no-unused-keyframes](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-keyframes.html) | Reports the `@keyframes` is not used in Scoped CSS. |  |
+| [vue-scoped-css/no-unused-selector](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-unused-selector.html) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
+| [vue-scoped-css/require-scoped](https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/require-scoped.html) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
+
 ## Uncategorized
 
 No preset enables the rules in this category.

diff --git a/docs/.vuepress/categories.js b/docs/.vuepress/categories.js
@@ -27,12 +27,12 @@ for (const categoryId of Object.keys(categoryRules)) {
     }
 }
 
-module.exports = categoryIds.map(categoryId => ({
+module.exports = categoryIds.map((categoryId) => ({
     categoryId,
     title: categoryTitles[categoryId],
     configDescription: categoryConfigDescriptions[categoryId],
     rules: (categoryRules[categoryId] || []).filter(
-        rule => !rule.meta.deprecated
+        (rule) => !rule.meta.deprecated
     ),
 }))
 // .filter(category => category.rules.length >= 1)
diff --git a/docs/.vuepress/components/components/EslintPluginEditor.vue b/docs/.vuepress/components/components/EslintPluginEditor.vue
@@ -129,7 +129,7 @@ export default {
 
             const vm = this
             const verifyAndFix = linter.verifyAndFix.bind(linter)
-            linter.verifyAndFix = function(...args) {
+            linter.verifyAndFix = function (...args) {
                 args[2].preprocess = vm.preprocess
                 args[2].postprocess = vm.postprocess
                 return verifyAndFix(...args)

diff --git a/docs/.vuepress/components/components/RulesSettings.vue b/docs/.vuepress/components/components/RulesSettings.vue
@@ -11,18 +11,18 @@
                     <label class="category-title">
                         <input
                             :checked="
-                                category.rules.every(rule =>
+                                category.rules.every((rule) =>
                                     isErrorState(rule.ruleId)
                                 )
                             "
                             type="checkbox"
                             :indeterminate.prop="
-                                !category.rules.every(rule =>
+                                !category.rules.every((rule) =>
                                     isErrorState(rule.ruleId)
                                 ) &&
-                                    !category.rules.every(
-                                        rule => !isErrorState(rule.ruleId)
-                                    )
+                                !category.rules.every(
+                                    (rule) => !isErrorState(rule.ruleId)
+                                )
                             "
                             @input="onAllClick(category, $event)"
                         />

diff --git a/docs/.vuepress/components/components/SnsBar.vue b/docs/.vuepress/components/components/SnsBar.vue
@@ -44,7 +44,7 @@ function setup() {
         clearTimeout(timeoutId)
     }
     timeoutId = setTimeout(() => {
-        ;(function(d, s, id) {
+        ;(function (d, s, id) {
             const [fjs] = d.getElementsByTagName(s)
             if (d.getElementById(id)) {
                 return
@@ -54,7 +54,7 @@ function setup() {
             js.src = "https://buttons.github.io/buttons.js"
             fjs.parentNode.insertBefore(js, fjs)
         })(document, "script", "gh-buttons")
-        ;(function(d, s, id) {
+        ;(function (d, s, id) {
             const [fjs] = d.getElementsByTagName(s)
             if (d.getElementById(id)) {
                 return
@@ -65,7 +65,7 @@ function setup() {
                 "https://connect.facebook.net/ja_JP/sdk.js#xfbml=1&version=v2.10"
             fjs.parentNode.insertBefore(js, fjs)
         })(document, "script", "facebook-jssdk")
-        ;(function(d, s, id) {
+        ;(function (d, s, id) {
             const [fjs] = d.getElementsByTagName(s)
             const p = /^http:/u.test(d.location) ? "http" : "https"
             if (!d.getElementById(id)) {

diff --git a/docs/.vuepress/components/eslint-code-block.vue b/docs/.vuepress/components/eslint-code-block.vue
@@ -49,7 +49,8 @@ export default {
             }
             return nodes
                 .map(
-                    node => node.text || this.computeCodeFromSlot(node.children)
+                    (node) =>
+                        node.text || this.computeCodeFromSlot(node.children)
                 )
                 .join("")
         },

diff --git a/docs/.vuepress/components/playground-block.vue b/docs/.vuepress/components/playground-block.vue
@@ -20,12 +20,12 @@
                             v-for="(msg, i) in messages"
                             :key="
                                 msg.line +
-                                    ':' +
-                                    msg.column +
-                                    ':' +
-                                    msg.ruleId +
-                                    '@' +
-                                    i
+                                ':' +
+                                msg.column +
+                                ':' +
+                                msg.ruleId +
+                                '@' +
+                                i
                             "
                             class="message"
                         >
@@ -135,8 +135,8 @@ export default {
 }
 
 function equalsRules(a, b) {
-    const akeys = Object.keys(a).filter(k => a[k] !== "off")
-    const bkeys = Object.keys(b).filter(k => b[k] !== "off")
+    const akeys = Object.keys(a).filter((k) => a[k] !== "off")
+    const bkeys = Object.keys(b).filter((k) => b[k] !== "off")
     if (akeys.length !== bkeys.length) {
         return false
     }

diff --git a/docs/.vuepress/components/rules/index.js b/docs/.vuepress/components/rules/index.js
@@ -78,7 +78,7 @@ export const categories = []
 
 for (const rule of allRules) {
     const title = CATEGORY_TITLES[rule.category] || rule.fallbackTitle
-    let category = categories.find(c => c.title === title)
+    let category = categories.find((c) => c.title === title)
     if (!category) {
         category = {
             classes: CATEGORY_CLASSES[rule.category],

diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -4,9 +4,9 @@ const categories = require("./categories")
 const webpack = require("webpack")
 
 const uncategorizedRules = rules.filter(
-    rule => !rule.meta.docs.category && !rule.meta.deprecated
+    (rule) => !rule.meta.docs.category && !rule.meta.deprecated
 )
-const deprecatedRules = rules.filter(rule => rule.meta.deprecated)
+const deprecatedRules = rules.filter((rule) => rule.meta.deprecated)
 
 const extraCategories = []
 if (uncategorizedRules.length > 0) {
@@ -99,7 +99,7 @@ module.exports = {
                             }) => [`/rules/${ruleName}`, ruleId]
                         ),
                     }))
-                    .filter(menu => Boolean(menu.children.length)),
+                    .filter((menu) => Boolean(menu.children.length)),
 
                 // Rules in no category.
                 ...extraCategories,

diff --git a/docs/README.md b/docs/README.md
@@ -9,7 +9,7 @@
 [![NPM downloads](https://img.shields.io/npm/dm/eslint-plugin-vue-scoped-css.svg)](http://www.npmtrends.com/eslint-plugin-vue-scoped-css)
 [![NPM downloads](https://img.shields.io/npm/dy/eslint-plugin-vue-scoped-css.svg)](http://www.npmtrends.com/eslint-plugin-vue-scoped-css)
 [![NPM downloads](https://img.shields.io/npm/dt/eslint-plugin-vue-scoped-css.svg)](http://www.npmtrends.com/eslint-plugin-vue-scoped-css)
-[![Build Status](https://travis-ci.com/future-architect/eslint-plugin-vue-scoped-css.svg?branch=master)](https://travis-ci.com/future-architect/eslint-plugin-vue-scoped-css)
+[![Build Status](https://github.com/future-architect/eslint-plugin-vue-scoped-css/workflows/CI/badge.svg?branch=master)](https://github.com/future-architect/eslint-plugin-vue-scoped-css/actions?query=workflow%3ACI)
 [![Coverage Status](https://coveralls.io/repos/github/future-architect/eslint-plugin-vue-scoped-css/badge.svg?branch=master)](https://coveralls.io/github/future-architect/eslint-plugin-vue-scoped-css?branch=master)
 <!--
 [![Greenkeeper badge](https://badges.greenkeeper.io/future-architect/eslint-plugin-vue-scoped-css.svg)](https://greenkeeper.io/)

diff --git a/docs/rules/README.md b/docs/rules/README.md
@@ -23,6 +23,23 @@ Enforce all the rules in this category with:
 | [vue-scoped-css/no-unused-selector](./no-unused-selector.md) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
 | [vue-scoped-css/require-scoped](./require-scoped.md) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
 
+## Recommended for Vue.js 3.x
+
+Enforce all the rules in this category with:
+
+```json
+{
+  "extends": "plugin:vue-scoped-css/vue3-recommended"
+}
+```
+
+| Rule ID | Description |    |
+|:--------|:------------|:---|
+| [vue-scoped-css/no-parsing-error](./no-parsing-error.md) | Disallow parsing errors in `<style>` |  |
+| [vue-scoped-css/no-unused-keyframes](./no-unused-keyframes.md) | Reports the `@keyframes` is not used in Scoped CSS. |  |
+| [vue-scoped-css/no-unused-selector](./no-unused-selector.md) | Reports selectors defined in Scoped CSS not used in `<template>`. |  |
+| [vue-scoped-css/require-scoped](./require-scoped.md) | Enforce the `<style>` tags to has the `scoped` attribute. |  |
+
 ## Uncategorized
 
 No preset enables the rules in this category.

diff --git a/docs/rules/no-parsing-error.md b/docs/rules/no-parsing-error.md
@@ -8,7 +8,7 @@ description: "Disallow parsing errors in `<style>`"
 
 > Disallow parsing errors in `<style>`
 
-- :gear: This rule is included in `"plugin:vue-scoped-css/recommended"` and `"plugin:vue-scoped-css/all"`.
+- :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
 This rule reports syntax errors in `<style>`. 
 

diff --git a/docs/rules/no-unused-keyframes.md b/docs/rules/no-unused-keyframes.md
@@ -8,7 +8,7 @@ description: "Reports the `@keyframes` is not used in Scoped CSS."
 
 > Reports the `@keyframes` is not used in Scoped CSS.
 
-- :gear: This rule is included in `"plugin:vue-scoped-css/recommended"` and `"plugin:vue-scoped-css/all"`.
+- :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
 This rule reports `@keyframes` is not used in Scoped CSS.
 

diff --git a/docs/rules/no-unused-selector.md b/docs/rules/no-unused-selector.md
@@ -8,7 +8,7 @@ description: "Reports selectors defined in Scoped CSS not used in `<template>`."
 
 > Reports selectors defined in Scoped CSS not used in `<template>`.
 
-- :gear: This rule is included in `"plugin:vue-scoped-css/recommended"` and `"plugin:vue-scoped-css/all"`.
+- :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
 ## :book: Rule Details
 

diff --git a/docs/rules/require-scoped.md b/docs/rules/require-scoped.md
@@ -8,7 +8,7 @@ description: "Enforce the `<style>` tags to has the `scoped` attribute."
 
 > Enforce the `<style>` tags to has the `scoped` attribute.
 
-- :gear: This rule is included in `"plugin:vue-scoped-css/recommended"` and `"plugin:vue-scoped-css/all"`.
+- :gear: This rule is included in all of `"plugin:vue-scoped-css/recommended"`, `"plugin:vue-scoped-css/vue3-recommended"` and `"plugin:vue-scoped-css/all"`.
 
 ## :book: Rule Details
 

diff --git a/lib/configs/vue3-recommended.ts b/lib/configs/vue3-recommended.ts
@@ -0,0 +1,6 @@
+import { collectRules } from "../utils/rules"
+
+export = {
+    extends: require.resolve("./base"),
+    rules: collectRules("vue3-recommended"),
+}
diff --git a/lib/index.ts b/lib/index.ts
@@ -1,9 +1,10 @@
 import { rules as ruleList } from "./utils/rules"
-import { Rule } from "./types"
+import type { Rule } from "./types"
 
 const configs = {
     base: require("./configs/base"),
     recommended: require("./configs/recommended"),
+    "vue3-recommended": require("./configs/vue3-recommended"),
     all: require("./configs/all"),
 }
 

diff --git a/lib/options.ts b/lib/options.ts
@@ -22,7 +22,7 @@ export namespace ParsedQueryOptions {
         return {
             ignoreBEMModifier: ignoreBEMModifier ?? false,
             captureClassesFromDoc:
-                captureClassesFromDoc?.map(s => toRegExp(s, "g")) ?? [],
+                captureClassesFromDoc?.map((s) => toRegExp(s, "g")) ?? [],
         }
     }
 }
diff --git a/lib/rules/no-parsing-error.ts b/lib/rules/no-parsing-error.ts
@@ -1,16 +1,20 @@
-import { RuleContext } from "../types"
-import { VCSSParsingError } from "../styles/ast"
+import type { RuleContext, Rule } from "../types"
+import type { VCSSParsingError } from "../styles/ast"
 import {
     getStyleContexts,
     getCommentDirectivesReporter,
     InvalidStyleContext,
 } from "../styles/context"
 
+declare const module: {
+    exports: Rule
+}
+
 module.exports = {
     meta: {
         docs: {
             description: "Disallow parsing errors in `<style>`",
-            category: "recommended",
+            categories: ["recommended", "vue3-recommended"],
             default: "warn",
             url:
                 "https://future-architect.github.io/eslint-plugin-vue-scoped-css/rules/no-parsing-error.html",