Skip to content

Commit d23f5c9

Browse files
committed
feat: GitHub Pagesで動作するtextlintプレビューサイトを追加
- textlint-website-generatorを使用したWebサイト生成 - exampleディレクトリ構成でプリセットをインストール - PRプレビュー機能(rossjrw/pr-preview-action使用) - メインブランチへの自動デプロイ設定
1 parent c72b068 commit d23f5c9

16 files changed

+14867
-169
lines changed

.github/workflows/deploy-website.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Deploy Website to GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
workflow_dispatch:
8+
9+
permissions:
10+
contents: write
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: '20'
29+
cache: 'npm'
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
34+
- name: Build textlint rules
35+
run: npm run build
36+
37+
- name: Install example dependencies
38+
run: cd example && npm install
39+
40+
- name: Build website
41+
run: cd example && npm run website
42+
43+
- name: Upload artifact
44+
uses: actions/upload-pages-artifact@v3
45+
with:
46+
path: ./example/dist
47+
48+
deploy:
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
runs-on: ubuntu-latest
53+
needs: build
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

.github/workflows/website-preview.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Deploy PR Preview
2+
3+
on:
4+
pull_request:
5+
types:
6+
- opened
7+
- reopened
8+
- synchronize
9+
- closed
10+
11+
concurrency:
12+
group: preview-${{ github.ref }}
13+
cancel-in-progress: true
14+
15+
jobs:
16+
deploy-preview:
17+
runs-on: ubuntu-latest
18+
permissions:
19+
contents: write
20+
pull-requests: write
21+
steps:
22+
- name: Checkout
23+
uses: actions/checkout@v4
24+
25+
- name: Setup Node.js
26+
uses: actions/setup-node@v4
27+
with:
28+
node-version: '20'
29+
cache: 'npm'
30+
31+
- name: Install dependencies
32+
run: npm ci
33+
34+
- name: Build textlint rules
35+
run: npm run build
36+
37+
- name: Install example dependencies
38+
run: cd example && npm install
39+
40+
- name: Build website
41+
run: cd example && npm run website
42+
43+
- name: Deploy preview
44+
uses: rossjrw/pr-preview-action@v1
45+
with:
46+
source-dir: ./example/dist/
47+
preview-branch: gh-pages
48+
umbrella-dir: pr-preview
49+
action: auto

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -230,3 +230,6 @@ fabric.properties
230230
# Build files
231231
/lib
232232
/module
233+
/public
234+
/example/dist
235+
/example/node_modules

.textlintrc.json

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
"plugins": {},
33
"filters": {},
44
"rules": {
5-
"preset-japanese": true
5+
"preset-ai-writing": {
6+
"no-ai-colon-continuation": true,
7+
"no-ai-emphasis-patterns": true,
8+
"no-ai-hype-expressions": true,
9+
"no-ai-list-formatting": true,
10+
"ai-tech-writing-guideline": true
11+
}
612
}
713
}

example/.textlintrc.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"filters": {
3+
"comments": true
4+
},
5+
"rules": {
6+
"@textlint-ja/preset-ai-writing": true
7+
}
8+
}

0 commit comments

Comments
 (0)