Skip to content

Commit c3a5b7d

Browse files
authored
Update docs (#52)
1 parent b975c5d commit c3a5b7d

File tree

11 files changed

+228
-213
lines changed

11 files changed

+228
-213
lines changed

.eslintignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,6 @@
1212
/tests-integrations/fixtures/vue-eslint-parser-option/test.json
1313
/assets
1414
/index.d.ts
15+
!/.github
16+
!/.vscode
17+
!/docs/.vuepress

.eslintrc.js

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
// const version = require("./package.json").version
2-
31
module.exports = {
42
parserOptions: {
5-
// sourceType: "script",
63
ecmaVersion: 2020,
74
project: require.resolve("./tsconfig.json"),
85
},
@@ -59,16 +56,6 @@ module.exports = {
5956
project: "./tsconfig.json",
6057
},
6158
},
62-
// {
63-
// files: ["lib/rules/**"],
64-
// rules: {
65-
// "eslint-plugin/report-message-format": [
66-
// "error",
67-
// "[^a-z].*\\.$",
68-
// ],
69-
// "eslint-plugin/require-meta-docs-url": "off",
70-
// },
71-
// },
7259
{
7360
files: ["scripts/**/*.ts", "tests/**/*.ts"],
7461
rules: {
@@ -77,28 +64,5 @@ module.exports = {
7764
"@typescript-eslint/ban-ts-comment": "off",
7865
},
7966
},
80-
// {
81-
// files: ["*.vue"],
82-
// parserOptions: {
83-
// sourceType: "module",
84-
// },
85-
// globals: {
86-
// require: true,
87-
// },
88-
// },
89-
// {
90-
// files: ["docs/.vuepress/**"],
91-
// parserOptions: {
92-
// sourceType: "module",
93-
// ecmaVersion: 2020,
94-
// parser: "babel-eslint",
95-
// },
96-
// globals: {
97-
// window: true,
98-
// },
99-
// rules: {
100-
// "require-jsdoc": "off",
101-
// },
102-
// },
10367
],
10468
}

.github/workflows/GHPages.yml

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
name: GHPages
22

33
on:
4-
push:
5-
branches: [master]
4+
push:
5+
branches: [master]
66

77
jobs:
8-
deploy-docs:
9-
runs-on: ubuntu-latest
10-
steps:
11-
- uses: actions/checkout@v2
12-
- uses: actions/setup-node@v2
13-
- name: Install Packages
14-
run: npm install
15-
- name: Build docs
16-
run: npm run docs:build
17-
- name: Deploy
18-
uses: peaceiris/actions-gh-pages@v3
19-
with:
20-
github_token: ${{ secrets.GITHUB_TOKEN }}
21-
publish_dir: ./docs/.vuepress/dist
22-
force_orphan: true
8+
deploy-docs:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
- uses: actions/setup-node@v2
13+
- name: Install Packages
14+
run: npm install
15+
- name: Build docs
16+
run: npm run docs:build
17+
- name: Deploy
18+
uses: peaceiris/actions-gh-pages@v3
19+
with:
20+
github_token: ${{ secrets.GITHUB_TOKEN }}
21+
publish_dir: ./docs/.vuepress/dist
22+
force_orphan: true

.github/workflows/NodeCI.yml

Lines changed: 97 additions & 97 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,102 @@
11
name: CI
22

33
on:
4-
push:
5-
branches: [master]
6-
pull_request:
7-
branches: [master]
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
88

99
jobs:
10-
lint:
11-
runs-on: ubuntu-latest
12-
steps:
13-
- uses: actions/checkout@v2
14-
- uses: actions/setup-node@v2
15-
with:
16-
node-version: 14
17-
- name: Install Packages
18-
run: npm install
19-
- name: Build
20-
run: npm run build
21-
- name: Lint
22-
run: npm run lint
23-
test-for-win-integrations:
24-
runs-on: windows-latest
25-
steps:
26-
- uses: actions/checkout@v2
27-
- name: Use Node.js 14
28-
uses: actions/setup-node@v2
29-
with:
30-
node-version: 14
31-
- name: Install Packages
32-
run: npm install
33-
- name: Test
34-
run: npm run test:integrations
35-
test-for-mac-integrations:
36-
runs-on: macos-latest
37-
steps:
38-
- uses: actions/checkout@v2
39-
- name: Use Node.js 14
40-
uses: actions/setup-node@v2
41-
with:
42-
node-version: 14
43-
- name: Install Packages
44-
run: npm install
45-
- name: Test
46-
run: npm run test:integrations
47-
test-for-ubuntu-integrations:
48-
runs-on: ubuntu-latest
49-
steps:
50-
- uses: actions/checkout@v2
51-
- name: Use Node.js 14
52-
uses: actions/setup-node@v2
53-
with:
54-
node-version: 14
55-
- name: Install Packages
56-
run: npm install
57-
- name: Test
58-
run: npm run test:integrations
59-
test:
60-
runs-on: ubuntu-latest
61-
strategy:
62-
matrix:
63-
node-version: [10.13.x, 12.x, 13.x, 14.x]
64-
steps:
65-
- uses: actions/checkout@v2
66-
- name: Use Node.js ${{ matrix.node-version }}
67-
uses: actions/setup-node@v2
68-
with:
69-
node-version: ${{ matrix.node-version }}
70-
- name: Install Packages
71-
run: npm install
72-
- name: Test
73-
run: npm test
74-
test-with-eslint6:
75-
runs-on: ubuntu-latest
76-
steps:
77-
- uses: actions/checkout@v2
78-
- uses: actions/setup-node@v2
79-
with:
80-
node-version: 8.10.x
81-
- name: Install Target Packages
82-
run: |+
83-
npm i -D [email protected] mocha@7
84-
npx rimraf node_modules
85-
npm install
86-
- name: Test
87-
run: npm test
88-
test-and-coverage:
89-
runs-on: ubuntu-latest
90-
steps:
91-
- uses: actions/checkout@v2
92-
- uses: actions/setup-node@v2
93-
with:
94-
node-version: 10.x
95-
- name: Install Packages
96-
run: npm install
97-
- name: Test
98-
run: npm run test:nyc
99-
- name: Coveralls GitHub Action
100-
uses: coverallsapp/[email protected]
101-
with:
102-
github-token: ${{ secrets.GITHUB_TOKEN }}
10+
lint:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-node@v2
15+
with:
16+
node-version: 14
17+
- name: Install Packages
18+
run: npm install
19+
- name: Build
20+
run: npm run build
21+
- name: Lint
22+
run: npm run lint
23+
test-for-win-integrations:
24+
runs-on: windows-latest
25+
steps:
26+
- uses: actions/checkout@v2
27+
- name: Use Node.js 14
28+
uses: actions/setup-node@v2
29+
with:
30+
node-version: 14
31+
- name: Install Packages
32+
run: npm install
33+
- name: Test
34+
run: npm run test:integrations
35+
test-for-mac-integrations:
36+
runs-on: macos-latest
37+
steps:
38+
- uses: actions/checkout@v2
39+
- name: Use Node.js 14
40+
uses: actions/setup-node@v2
41+
with:
42+
node-version: 14
43+
- name: Install Packages
44+
run: npm install
45+
- name: Test
46+
run: npm run test:integrations
47+
test-for-ubuntu-integrations:
48+
runs-on: ubuntu-latest
49+
steps:
50+
- uses: actions/checkout@v2
51+
- name: Use Node.js 14
52+
uses: actions/setup-node@v2
53+
with:
54+
node-version: 14
55+
- name: Install Packages
56+
run: npm install
57+
- name: Test
58+
run: npm run test:integrations
59+
test:
60+
runs-on: ubuntu-latest
61+
strategy:
62+
matrix:
63+
node-version: [10.13.x, 12.x, 13.x, 14.x]
64+
steps:
65+
- uses: actions/checkout@v2
66+
- name: Use Node.js ${{ matrix.node-version }}
67+
uses: actions/setup-node@v2
68+
with:
69+
node-version: ${{ matrix.node-version }}
70+
- name: Install Packages
71+
run: npm install
72+
- name: Test
73+
run: npm test
74+
test-with-eslint6:
75+
runs-on: ubuntu-latest
76+
steps:
77+
- uses: actions/checkout@v2
78+
- uses: actions/setup-node@v2
79+
with:
80+
node-version: 8.10.x
81+
- name: Install Target Packages
82+
run: |+
83+
npm i -D [email protected] mocha@7
84+
npx rimraf node_modules
85+
npm install
86+
- name: Test
87+
run: npm test
88+
test-and-coverage:
89+
runs-on: ubuntu-latest
90+
steps:
91+
- uses: actions/checkout@v2
92+
- uses: actions/setup-node@v2
93+
with:
94+
node-version: 10.x
95+
- name: Install Packages
96+
run: npm install
97+
- name: Test
98+
run: npm run test:nyc
99+
- name: Coveralls GitHub Action
100+
uses: coverallsapp/[email protected]
101+
with:
102+
github-token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/NpmPublish.yml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
name: publish
22
on:
3-
push:
4-
tags:
5-
- "*"
3+
push:
4+
tags:
5+
- "*"
66
jobs:
7-
release:
8-
name: check version, and release
9-
runs-on: ubuntu-latest
10-
steps:
11-
- name: checkout
12-
uses: actions/checkout@v2
13-
- name: setup Node
14-
uses: actions/setup-node@v2
15-
with:
16-
registry-url: 'https://registry.npmjs.org'
17-
- name: Install Packages
18-
run: npm install
19-
- name: test
20-
run: npm run test
21-
- name: Build
22-
run: npm run build
23-
- name: check can npm-publish
24-
run: npx can-npm-publish
25-
- name: release
26-
run: npm publish
27-
env:
28-
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
7+
release:
8+
name: check version, and release
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: checkout
12+
uses: actions/checkout@v2
13+
- name: setup Node
14+
uses: actions/setup-node@v2
15+
with:
16+
registry-url: "https://registry.npmjs.org"
17+
- name: Install Packages
18+
run: npm install
19+
- name: test
20+
run: npm run test
21+
- name: Build
22+
run: npm run build
23+
- name: check can npm-publish
24+
run: npx can-npm-publish
25+
- name: release
26+
run: npm publish
27+
env:
28+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

0 commit comments

Comments
 (0)