mirror of https://github.com/abpframework/abp
Merge pull request #14374 from SeanKilleen/spellcheck
Automated Spellcheck via GitHub Actionspull/14442/head
Berkan Sasmaz
3 years ago
committed by
GitHub
commit
8ac758ed34
@ -0,0 +1,29 @@
|
||||
name: Documentation Checks
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- dev
|
||||
paths:
|
||||
# This ensures the check will only be run when something changes in the docs content
|
||||
- "docs/en/**/*"
|
||||
pull_request:
|
||||
branches:
|
||||
- dev
|
||||
paths:
|
||||
- "docs/en/**/*"
|
||||
jobs:
|
||||
spellcheck:
|
||||
name: "Docs: Spellcheck (En)"
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
name: Check out the code
|
||||
- uses: actions/setup-node@v1
|
||||
name: Setup node
|
||||
with:
|
||||
node-version: "16"
|
||||
- run: npm install -g cspell
|
||||
name: Install cSpell
|
||||
- run: cspell --config ./cSpell.json "docs/en/**/*.md" --no-progress # Update for path to the markdown files
|
||||
name: Run cSpell
|
||||
@ -0,0 +1,151 @@
|
||||
{
|
||||
"version": "0.2",
|
||||
"language": "en",
|
||||
"words": [
|
||||
"ABP's",
|
||||
"abpframework",
|
||||
"Antiforgery",
|
||||
"appsettings",
|
||||
"aspnet",
|
||||
"aspnetcore",
|
||||
"Autofac",
|
||||
"automagically",
|
||||
"Blazor",
|
||||
"CQRS",
|
||||
"crossfade",
|
||||
"Dapr",
|
||||
"Datagrid's",
|
||||
"Datatable",
|
||||
"datepicker",
|
||||
"dismissable",
|
||||
"dockerized",
|
||||
"entrypoints",
|
||||
"findability",
|
||||
"hoverable",
|
||||
"Iddict",
|
||||
"IntelliCode",
|
||||
"Keysize",
|
||||
"Linq",
|
||||
"Microservices",
|
||||
"middlewares",
|
||||
"Minifier",
|
||||
"multitenancy",
|
||||
"multitenant",
|
||||
"Navs",
|
||||
"Newtonsoft",
|
||||
"Npgsql",
|
||||
"oidc",
|
||||
"overridable",
|
||||
"Parameterless",
|
||||
"Passwordless",
|
||||
"PKCE",
|
||||
"preconfigured",
|
||||
"proxying",
|
||||
"redirections",
|
||||
"scrollbars",
|
||||
"signin",
|
||||
"Templating",
|
||||
"textboxes",
|
||||
"toolset",
|
||||
"unsubscription",
|
||||
"Xunit"
|
||||
],
|
||||
"ignoreWords": [
|
||||
"Aliyun",
|
||||
"Allibone",
|
||||
"Blazorise",
|
||||
"Boutwell",
|
||||
"Cmskit",
|
||||
"connectionstrings",
|
||||
"Devart",
|
||||
"Formik",
|
||||
"Halil",
|
||||
"Hanselman",
|
||||
"hikalkan",
|
||||
"Ibrahim",
|
||||
"İbrahim",
|
||||
"Kalkan",
|
||||
"Kirti",
|
||||
"Kommunity",
|
||||
"Kulkarni",
|
||||
"Luxon",
|
||||
"malihu",
|
||||
"Malik",
|
||||
"Masis",
|
||||
"Minio",
|
||||
"NGXS",
|
||||
"NSWAG",
|
||||
"Scriban",
|
||||
"Serilog",
|
||||
"Shoudly",
|
||||
"Shouldly",
|
||||
"Sweetalert",
|
||||
"Syncfusion",
|
||||
"Telerik",
|
||||
"Timeago",
|
||||
"Toastr",
|
||||
"Volo",
|
||||
"Volosoft",
|
||||
"Xeevis"
|
||||
],
|
||||
"patterns": [
|
||||
{
|
||||
"name": "Markdown links",
|
||||
"pattern": "\\((.*)\\)",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"name": "Markdown code blocks",
|
||||
"pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx",
|
||||
"description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions"
|
||||
},
|
||||
{
|
||||
"name": "Inline code blocks",
|
||||
"pattern": "\\`([^\\`\\r\\n]+?)\\`",
|
||||
"description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex"
|
||||
},
|
||||
{
|
||||
"name": "Link contents",
|
||||
"pattern": "\\<a(.*)\\>",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"name": "Snippet references",
|
||||
"pattern": "-- snippet:(.*)",
|
||||
"description": ""
|
||||
},
|
||||
{
|
||||
"name": "Snippet references 2",
|
||||
"pattern": "\\<\\[sample:(.*)",
|
||||
"description": "another kind of snippet reference"
|
||||
},
|
||||
{
|
||||
"name": "Multi-line code blocks",
|
||||
"pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm"
|
||||
},
|
||||
{
|
||||
"name": "HTML Tags",
|
||||
"pattern": "<[^>]*>",
|
||||
"description": "Reference: https://stackoverflow.com/questions/11229831/regular-expression-to-remove-html-tags-from-a-string"
|
||||
},
|
||||
{
|
||||
"name": "Markdown Image",
|
||||
"pattern": "!\\[(.*)\\]\\((.*)\\)"
|
||||
}
|
||||
],
|
||||
"ignoreRegExpList": [
|
||||
"Markdown links",
|
||||
"Markdown code blocks",
|
||||
"Inline code blocks",
|
||||
"Link contents",
|
||||
"Snippet references",
|
||||
"Snippet references 2",
|
||||
"Multi-line code blocks",
|
||||
"HTML Tags",
|
||||
"Markdown Image"
|
||||
],
|
||||
"ignorePaths": [
|
||||
"**/*Release/Post.md",
|
||||
"**/*Preview/POST.md"
|
||||
]
|
||||
}
|
||||
Loading…
Reference in new issue