Skip to content

Commit

Permalink
Some additions
Browse files Browse the repository at this point in the history
Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
  • Loading branch information
klecki committed Nov 7, 2023
1 parent 0966b53 commit 27460cb
Show file tree
Hide file tree
Showing 4 changed files with 1,685 additions and 4 deletions.
68 changes: 65 additions & 3 deletions cspell.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,17 @@
"addWords": true
},
{
"name": "project-words",
"name": "maintainers",
"path": "./cspell_dicts/maintainers_dict.txt",
"addWords": true
},
{
"name": "project-words",
"name": "personal-names",
"path": "./cspell_dicts/names_dict.txt",
"addWords": true
},
{
"name": "layouts",
"path": "./cspell_dicts/layouts_dict.txt",
"addWords": true
},
Expand All @@ -22,14 +27,71 @@
"project-words",
"maintainers",
"layouts",
"personal-names",
],
"ignorePaths": [
// Skip build directories
"build*",
// and dependencies
"third_party/**",
"/.cspell_dict.txt",
// Do not scan the dictionaries
"cspell_dicts/**",
// file containing lot of names
"Acknowledgements.txt",
// Doxygen has weird names in config
"Doxyfile",
// TODO(klecki): Check cmake spelling
"*.cmake",
"CMakeLists.txt",
// files encoded as text
"*.ipynb",
// Internal config files and similar
"*.sh",
"*.json",
"*.sup",
"*.yml",
"*.yaml",
"*map.in",
// test data with lots of names
"*synset*",
// Do not include C++ tests, as they use weird strings
"*_test.cc",
"*_test.cu",
// temporary file pattern for developement
"*-words.txt",
],
"overrides": [
// Force `*.cu` and `*.cuh` files to be treated as `cpp` files:
{
"filename": "**/{*.cu,*.cuh}",
"languageId": "cpp"
},
],
"languageSettings": [
// Specific, per-language settings
{
// use with cpp or c files
"languageId": "cpp,c",
// turn off compound words, because it is only checking strings.
"allowCompoundWords": false,
// Only check comments and strings
"includeRegExpList": [
"CStyleComment",
"strings",
"/([R]\".*\\()[^\\1]*?\\1/g"
],

"ignoreRegExpList": [
"/#include.*/", // Exclude includes, because they are also strings.
"/@param([ ]+[^ ]+)/" // match anything of form "@param <param_name>"
],
},
{
"languageId": "python",
"includeRegExpList": [
"strings",
"comments"
]
}
]
}
Empty file added cspell_dicts/names_dict.txt
Empty file.
2 changes: 1 addition & 1 deletion get_unknown_words.sh
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
#!/bin/bash
docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest --words-only --unique --quiet "**" | sort --ignore-case >> project-words.txt
docker run -it -v $PWD:/workdir ghcr.io/streetsidesoftware/cspell:latest --words-only --unique --quiet --no-color "**" | sort --ignore-case > project-words.txt
Loading

0 comments on commit 27460cb

Please sign in to comment.