Skip to content

Commit

Permalink
ci: add autocorrect ci (#283)
Browse files Browse the repository at this point in the history
  • Loading branch information
JustAnotherID authored Oct 14, 2024
1 parent bec76a6 commit 19ea309
Show file tree
Hide file tree
Showing 6 changed files with 48 additions and 34 deletions.
2 changes: 1 addition & 1 deletion .autocorrectrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# yaml-language-server: $schema=https://huacnlee.github.io/autocorrect/schema.json
yaml-language-server: $schema=https://huacnlee.github.io/autocorrect/schema.json
rules:
# Default rules: https://github.com/huacnlee/autocorrect/raw/main/autocorrect/.autocorrectrc.default
spellcheck: 2
Expand Down
16 changes: 16 additions & 0 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,19 @@ jobs:
- uses: DavidAnson/markdownlint-cli2-action@v16
with:
globs: "**/*.md"

autocorrect:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: latest
- name: Setup pnpm
uses: pnpm/action-setup@v4
with:
version: latest
run_install: true

- name: AutoCorrect
run: pnpm run lint:autocorrect
4 changes: 1 addition & 3 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
{
"recommendations": [
"davidanson.vscode-markdownlint"
]
"recommendations": ["davidanson.vscode-markdownlint", "huacnlee.autocorrect"]
}
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ VitePress 驱动的海豹骰官方使用手册。
pnpm install
```

## MarkDown 格式规范
## Markdown 格式规范

提交前请务必使用 markdownlint 进行检查,不满足格式要求的修改无法合并入主仓库。

Expand All @@ -40,7 +40,7 @@ pnpm run lint:autocorrect
pnpm run lint:autocorrect:fix # 检查并进行部分自动修复
```

使用 AutoCorrect 插件可以提供编辑器集成的提示,但确有观察到编辑器插件不识别配置文件造成假阳性报告的问题
使用 AutoCorrect 插件可以提供编辑器集成的提示。这一插件已经被添加到本项目的推荐插件中,只需在打开本项目时按 VS Code 的提示安装即可

- [VS Code](https://marketplace.visualstudio.com/items?itemName=huacnlee.autocorrect)
- [JetBrains](https://plugins.jetbrains.com/plugin/20244-autocorrect)
Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
"docs:preview": "vitepress preview docs",
"lint:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\"",
"lint:md:fix": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" --fix",
"lint:autocorrect": "autocorrect --lint",
"lint:autocorrect:fix": "autocorrect --fix"
"lint:autocorrect": "autocorrect --lint --strict",
"lint:autocorrect:fix": "autocorrect --fix --strict"
},
"keywords": [],
"author": "Sealdice Team",
"license": "MIT",
"devDependencies": {
"markdownlint-cli2": "^0.14.0",
"autocorrect-node": "^2.11.1",
"autocorrect-node": "^2.12.0",
"mermaid": "^11.3.0",
"sass": "^1.79.4",
"vitepress": "^1.3.4",
Expand Down
50 changes: 25 additions & 25 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 19ea309

Please sign in to comment.