Skip to content

Commit cd19cb3

Browse files
committed
test: add spell checking
1 parent 1dd373a commit cd19cb3

File tree

9 files changed

+453
-42
lines changed

9 files changed

+453
-42
lines changed

.vscode/settings.json

Lines changed: 0 additions & 30 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Contributing
2+
3+
You will need [`pnpm`](https://pnpm.io/installation) to build and test `setup-cpp`:
4+
5+
```shell
6+
pnpm install
7+
```
8+
9+
Before running the tests locally, backup your environment variables because faulty code might corrupt the environment.
10+
11+
<https://stackoverflow.com/a/5147185/7910299>

LICENSE.dependencies.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
setup-cpp reused some code from the following projects:
22

3-
- [install-llvm-action](https://github.com/KyleMayes/install-llvm-action/blob/master/LICENSE.txt): Apach-2.0
3+
- [install-llvm-action](https://github.com/KyleMayes/install-llvm-action/blob/master/LICENSE.txt): Apache-2.0
44
- [install-cmake](https://github.com/Symbitic/install-cmake/blob/master/LICENSE.md): MIT
55
- [get-cmake](https://github.com/lukka/get-cmake/blob/main/LICENSE.txt): MIT
66
- [gha-setup-ninja](https://github.com/seanmiddleditch/gha-setup-ninja): MIT
77
- [msvc-problem-matcher](https://github.com/ammaraskar/msvc-problem-matcher): Apache-2.0
88
- [gcc-problem-matcher](https://github.com/ammaraskar/gcc-problem-matcher): Apache-2.0
99

10-
This package also uses the depedencies listed in package.json. You can get the list of their licenses using the following command:
10+
This package also uses the dependencies listed in package.json. You can get the list of their licenses using the following command:
1111
```
1212
npm install -g license-checker
1313
license-checker --summary --production --excludePackages "setup-python@2.2.2"

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ An example that installs llvm, cmake, ninja, ccache, and vcpkg:
6161
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.10.0/setup_cpp_windows.exe"
6262
./setup_cpp_windows --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
6363
64-
RefreshEnv.cmd # activate cpp enviroment variables
64+
RefreshEnv.cmd # activate cpp environment variables
6565
```
6666

6767
```ps1
@@ -70,7 +70,7 @@ wget "https://github.com/aminya/setup-cpp/releases/download/v0.10.0/setup_cpp_li
7070
chmod +x setup_cpp_linux
7171
sudo ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
7272
73-
source ~/.cpprc # activate cpp enviroment variables
73+
source ~/.cpprc # activate cpp environment variables
7474
```
7575

7676
```ps1
@@ -79,7 +79,7 @@ wget "https://github.com/aminya/setup-cpp/releases/download/v0.10.0/setup_cpp_ma
7979
chmod +x setup_cpp_mac
8080
sudo ./setup_cpp_mac --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
8181
82-
source ~/.cpprc # activate cpp enviroment variables
82+
source ~/.cpprc # activate cpp environment variables
8383
```
8484

8585
NOTE: In the `compiler` entry, you can specify the version after `-` like `llvm-11.0.0`. For the tools, you can pass a specific version instead of `true` that chooses the default version
@@ -101,7 +101,7 @@ Open the shell as admin, download via `curl`, then install
101101
curl -LJO "https://github.com/aminya/setup-cpp/releases/download/v0.10.0/setup_cpp.js"
102102
node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
103103
104-
RefreshEnv.cmd # activate cpp enviroment variables
104+
RefreshEnv.cmd # activate cpp environment variables
105105
```
106106

107107
On Linux or Mac:
@@ -110,7 +110,7 @@ On Linux or Mac:
110110
wget "https://github.com/aminya/setup-cpp/releases/download/v0.10.0/setup_cpp.js"
111111
sudo node ./setup_cpp.js --compiler llvm --cmake true --ninja true --ccache true --vcpkg true
112112
113-
source ~/.cpprc # activate cpp enviroment variables
113+
source ~/.cpprc # activate cpp environment variables
114114
```
115115

116116
## Inside GitHub Actions
@@ -191,7 +191,7 @@ RUN chmod +x ./setup_cpp_linux
191191
# install llvm, cmake, ninja, and ccache
192192
RUN ./setup_cpp_linux --compiler llvm --cmake true --ninja true --ccache true
193193

194-
# activate cpp enviroment variables
194+
# activate cpp environment variables
195195
RUN source ~/.cpprc
196196

197197
ENTRYPOINT [ "/bin/sh" ]

cspell.config.yaml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
version: "0.2"
2+
files:
3+
- "**/*"
4+
useGitignore: true
5+
enableGlobDot: true
6+
ignorePaths:
7+
- pnpm-lock.yaml
8+
- .git/
9+
- dist/
10+
words:
11+
- "buildtools"
12+
- "ccache"
13+
- "cmake"
14+
- "CPATH"
15+
- "Cppcheck"
16+
- "CPPFLAGS"
17+
- "cpprc"
18+
- "dyld"
19+
- "eabi"
20+
- "execa"
21+
- "gcovr"
22+
- "Graphviz"
23+
- "isci"
24+
- "LDFLAGS"
25+
- "msbuild"
26+
- "msvc"
27+
- "msys"
28+
- "multilib"
29+
- "nothrow"
30+
- "Opencppcoverage"
31+
- "OSSDK"
32+
- "setx"
33+
- "untildify"
34+
- "vcpkg"
35+
- "visualc"
36+
- "visualcpp"
37+
- pnpm
38+
- Yahyaabadi
39+
- vcvarsall
40+
- kcov
41+
- choco
42+
- vsversion
43+
- pwsh
44+
- pypy
45+
- ghes
46+
- applellvm
47+
- xcrun
48+
- libstdc
49+
- libtinfo
50+
- libdw
51+
- npmrc
52+
- setupcpp
53+
- aarch
54+
- devel
55+
- aminya
56+
- caxa
57+
- libbinutils
58+
- tsbuildinfo
59+
- deps
60+
- mxschmitt
61+
- terserrc
62+
ignoreWords: []
63+
import: []
64+
dictionaryDefinitions: []
65+
dictionaries: []
66+
language: "en, en-GB"
67+
allowCompoundWords: true

package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@
2424
"pack.exe": "shx rm -rf ./dist/tsconfig.tsbuildinfo && node ./building/scripts/pack-exe.js",
2525
"prepare": "npm run build",
2626
"start.docker": "docker run -t setup_cpp .",
27-
"test": "run-p test.format test.lint test.tsc test.unit",
27+
"test": "run-p test.format test.lint test.cspell test.tsc test.unit",
28+
"test.cspell": "cspell lint --no-progress --show-suggestions",
2829
"test.format": "prettier . --check",
2930
"test.lint": "eslint .",
3031
"test.tsc": "tsc --noEmit",
@@ -54,6 +55,7 @@
5455
"caxa": "^2.1.0",
5556
"cross-env": "7.0.3",
5657
"cross-spawn": "^7.0.3",
58+
"cspell": "^5.18.5",
5759
"eslint": "^8.11.0",
5860
"eslint-config-atomic": "^1.17.0",
5961
"jest": "^27.5.1",

0 commit comments

Comments
 (0)