Skip to content

Commit 4c12325

Browse files
ota-meshiota-meshi
authored
Update doc gen (#23)
1 parent a3a3db9 commit 4c12325

25 files changed

+328
-192
lines changed

‎.env-cmdrc‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"version": {
3+
"IN_VERSION_SCRIPT": "true"
4+
}
5+
}

‎.eslintignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,6 @@
55
/docs/.vuepress/components/demo/demo-code.js
66
/node_modules
77
/assets
8+
!/docs/.vuepress
9+
!/.vscode
10+
!/.github

‎.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: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,64 +1,64 @@
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:
24-
runs-on: ubuntu-latest
25-
strategy:
26-
matrix:
27-
node-version: [10.13.x, 12.x, 13.x, 14.x]
28-
steps:
29-
- uses: actions/checkout@v2
30-
- name: Use Node.js ${{ matrix.node-version }}
31-
uses: actions/setup-node@v2
32-
with:
33-
node-version: ${{ matrix.node-version }}
34-
- name: Install Packages
35-
run: npm install
36-
- name: Test
37-
run: npm test
38-
test-with-eslint6:
39-
runs-on: ubuntu-latest
40-
steps:
41-
- uses: actions/checkout@v2
42-
- uses: actions/setup-node@v2
43-
with:
44-
node-version: 8.10.x
45-
- name: Install Target Packages
46-
run: |+
47-
npm i -D [email protected] mocha@7
48-
npx rimraf node_modules
49-
npm install
50-
- name: Test
51-
run: npm test
52-
test-and-coverage:
53-
runs-on: ubuntu-latest
54-
steps:
55-
- uses: actions/checkout@v2
56-
- uses: actions/setup-node@v2
57-
- name: Install Packages
58-
run: npm install
59-
- name: Test
60-
run: npm run test:nyc
61-
- name: Coveralls GitHub Action
62-
uses: coverallsapp/[email protected]
63-
with:
64-
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:
24+
runs-on: ubuntu-latest
25+
strategy:
26+
matrix:
27+
node-version: [10.13.x, 12.x, 13.x, 14.x]
28+
steps:
29+
- uses: actions/checkout@v2
30+
- name: Use Node.js ${{ matrix.node-version }}
31+
uses: actions/setup-node@v2
32+
with:
33+
node-version: ${{ matrix.node-version }}
34+
- name: Install Packages
35+
run: npm install
36+
- name: Test
37+
run: npm test
38+
test-with-eslint6:
39+
runs-on: ubuntu-latest
40+
steps:
41+
- uses: actions/checkout@v2
42+
- uses: actions/setup-node@v2
43+
with:
44+
node-version: 8.10.x
45+
- name: Install Target Packages
46+
run: |+
47+
npm i -D [email protected] mocha@7
48+
npx rimraf node_modules
49+
npm install
50+
- name: Test
51+
run: npm test
52+
test-and-coverage:
53+
runs-on: ubuntu-latest
54+
steps:
55+
- uses: actions/checkout@v2
56+
- uses: actions/setup-node@v2
57+
- name: Install Packages
58+
run: npm install
59+
- name: Test
60+
run: npm run test:nyc
61+
- name: Coveralls GitHub Action
62+
uses: coverallsapp/[email protected]
63+
with:
64+
github-token: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/NpmPublish.yml‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
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: check can npm-publish
22-
run: npx can-npm-publish
23-
- name: release
24-
run: npm publish
25-
env:
26-
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: check can npm-publish
22+
run: npx can-npm-publish
23+
- name: release
24+
run: npm publish
25+
env:
26+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

‎.vscode/settings.json‎

Lines changed: 33 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,34 @@
11
{
2-
"eslint.validate": [
3-
"javascript",
4-
"javascriptreact",
5-
"vue",
6-
"typescript",
7-
"json",
8-
"jsonc"
9-
],
10-
"typescript.validate.enable": true,
11-
"javascript.validate.enable": false,
12-
"eslint.workingDirectories": [
13-
"./", "./docs/.vuepress"
14-
],
15-
"vetur.validation.script": false,
16-
"vetur.validation.style": false,
17-
"css.validate": false,
18-
"typescript.tsdk": "node_modules/typescript/lib",
19-
"editor.codeActionsOnSave": {
20-
"source.fixAll.eslint": true,
21-
"source.fixAll.stylelint": true,
22-
},
23-
"stylelint.customSyntax": "stylelint-plugin-stylus/custom-syntax",
24-
"stylelint.validate": [
25-
"css",
26-
"html",
27-
"less",
28-
"postcss",
29-
"sass",
30-
"scss",
31-
"vue",
32-
"vue-html",
33-
"vue-postcss",
34-
"stylus"
35-
]
36-
}
2+
"eslint.validate": [
3+
"javascript",
4+
"javascriptreact",
5+
"vue",
6+
"typescript",
7+
"json",
8+
"jsonc",
9+
"yaml"
10+
],
11+
"typescript.validate.enable": true,
12+
"javascript.validate.enable": false,
13+
"vetur.validation.script": false,
14+
"vetur.validation.style": false,
15+
"css.validate": false,
16+
"typescript.tsdk": "node_modules/typescript/lib",
17+
"editor.codeActionsOnSave": {
18+
"source.fixAll.eslint": true,
19+
"source.fixAll.stylelint": true
20+
},
21+
"stylelint.customSyntax": "stylelint-plugin-stylus/custom-syntax",
22+
"stylelint.validate": [
23+
"css",
24+
"html",
25+
"less",
26+
"postcss",
27+
"sass",
28+
"scss",
29+
"vue",
30+
"vue-html",
31+
"vue-postcss",
32+
"stylus"
33+
]
34+
}

‎docs/rules/match-any.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ pageClass: "rule-details"
33
sidebarDepth: 0
44
title: "regexp/match-any"
55
description: "enforce match any character style"
6+
since: "v0.1.0"
67
---
78
# regexp/match-any
89

@@ -67,7 +68,11 @@ var foo = /[\w\W]/;
6768

6869
</eslint-code-block>
6970

70-
## Implementation
71+
## :rocket: Version
72+
73+
This rule was introduced in eslint-plugin-regexp v0.1.0
74+
75+
## :mag: Implementation
7176

7277
- [Rule source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/rules/match-any.ts)
73-
- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/match-any.js)
78+
- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/match-any.ts)

‎docs/rules/no-assertion-capturing-group.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ pageClass: "rule-details"
33
sidebarDepth: 0
44
title: "regexp/no-assertion-capturing-group"
55
description: "disallow capturing group that captures assertions."
6+
since: "v0.1.0"
67
---
78
# regexp/no-assertion-capturing-group
89

@@ -14,7 +15,7 @@ description: "disallow capturing group that captures assertions."
1415

1516
This rule reports capturing group that captures assertions.
1617

17-
<eslint-code-block >
18+
<eslint-code-block>
1819

1920
```js
2021
/* eslint regexp/no-assertion-capturing-group: "error" */
@@ -37,7 +38,11 @@ var foo = /(^)a/;
3738

3839
Nothing.
3940

40-
## Implementation
41+
## :rocket: Version
42+
43+
This rule was introduced in eslint-plugin-regexp v0.1.0
44+
45+
## :mag: Implementation
4146

4247
- [Rule source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/rules/no-assertion-capturing-group.ts)
43-
- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/no-assertion-capturing-group.js)
48+
- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/no-assertion-capturing-group.ts)

‎docs/rules/no-dupe-characters-character-class.md‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ pageClass: "rule-details"
33
sidebarDepth: 0
44
title: "regexp/no-dupe-characters-character-class"
55
description: "disallow duplicate characters in the RegExp character class"
6+
since: "v0.1.0"
67
---
78
# regexp/no-dupe-characters-character-class
89

@@ -20,7 +21,7 @@ var foo = /\\(\\)/;
2021

2122
This rule disallows duplicate characters in the RegExp character class.
2223

23-
<eslint-code-block >
24+
<eslint-code-block>
2425

2526
```js
2627
/* eslint regexp/no-dupe-characters-character-class: "error" */
@@ -47,7 +48,11 @@ var foo = /[\w0-9]/;
4748

4849
Nothing.
4950

50-
## Implementation
51+
## :rocket: Version
52+
53+
This rule was introduced in eslint-plugin-regexp v0.1.0
54+
55+
## :mag: Implementation
5156

5257
- [Rule source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/lib/rules/no-dupe-characters-character-class.ts)
53-
- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/no-dupe-characters-character-class.js)
58+
- [Test source](https://github.com/ota-meshi/eslint-plugin-regexp/blob/master/tests/lib/rules/no-dupe-characters-character-class.ts)

0 commit comments

Comments
 (0)