Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
cSpell to NUKE build pipeline (#2086)
- Loading branch information
Showing
15 changed files
with
1,231 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| name: Documentation Checks | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - develop | ||
| paths: | ||
| # This ensures the check will only be run when something changes in the docs content | ||
| - "docs/**/*" # or whatever the path to the markdown / docs files happens to be | ||
| pull_request: | ||
| branches: | ||
| - develop | ||
| paths: | ||
| - "docs/**/*" | ||
| jobs: | ||
| spellcheck: | ||
| name: "Docs: Spellcheck" | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
| fetch-depth: 0 | ||
| name: Check out the code | ||
| - name: Run NUKE spell check | ||
| run: ./build.sh --target SpellCheck |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| { | ||
| "version": "1.0", | ||
| "language": "en", | ||
| "words": [ | ||
| "browsable", | ||
| "comparands", | ||
| "Doomen", | ||
| "formattable", | ||
| "Guids", | ||
| "LINQ", | ||
| "MVVM", | ||
| "parameterless", | ||
| "refactorings", | ||
| "struct" | ||
| ], | ||
| "patterns": [ | ||
| { | ||
| "name": "Markdown links", | ||
| "pattern": "\\((.*)\\)", | ||
| "description": "" | ||
| }, | ||
| { | ||
| "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": "Frontmatter", | ||
| "pattern": "/^([-]{3}|[+]{3}|[.]{3})$[\\s\\S]+^([-]{3}|[+]{3}|[.]{3})$/gm" | ||
| }, | ||
| { | ||
| "name": "Liquid Includes", | ||
| "pattern": "\\{%(.*) %\\}" | ||
| } | ||
| ], | ||
| "ignoreRegExpList": [ | ||
| "Markdown links", | ||
| "Markdown code blocks", | ||
| "Inline code blocks", | ||
| "Link contents", | ||
| "Snippet references", | ||
| "Snippet references 2", | ||
| "Multi-line code blocks", | ||
| "HTML Tags", | ||
| "Frontmatter", | ||
| "Liquid Includes" | ||
| ], | ||
| "ignorePaths": [ | ||
| "docs/_pages/releases.md" | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,6 @@ | ||
| del _site /s /q | ||
|
|
||
| rem Documentation spell check | ||
| ..\build.cmd --target SpellCheck | ||
|
|
||
| bundle exec jekyll serve --incremental |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| { | ||
| "version": "1.0.0", | ||
| "scripts": { | ||
| "cspell": "cspell --config ./cSpell.json ./**/*.md --no-progress" | ||
| }, | ||
| "dependencies": { | ||
| "cspell": "^6.18.1" | ||
| } | ||
| } |
Oops, something went wrong.