Skip to content

Commit 13c1151

Browse files
oliversalzburgoliversalzburg
committed
docs: Update repository scripts
1 parent 97b01fc commit 13c1151

16 files changed

+191
-47
lines changed

‎package.json-scripts.json‎

Lines changed: 62 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,22 @@
3333
"isGlobal": false,
3434
"isRootManifest": false
3535
},
36+
{
37+
"manifestPath": "package.json",
38+
"projectName": "kitten-scientists",
39+
"scriptName": "build",
40+
"scriptCode": "yarn run build:all",
41+
"isGlobal": false,
42+
"isRootManifest": true
43+
},
3644
{
3745
"manifestPath": "package.json",
3846
"projectName": "kitten-scientists",
3947
"scriptName": "build:all",
4048
"scriptCode": "tsc --build",
4149
"isGlobal": true,
42-
"isRootManifest": true
50+
"isRootManifest": true,
51+
"description": "Builds all TypeScript workspaces."
4352
},
4453
{
4554
"manifestPath": "packages/action-automatic-releases/package.json",
@@ -73,13 +82,22 @@
7382
"isGlobal": false,
7483
"isRootManifest": false
7584
},
85+
{
86+
"manifestPath": "package.json",
87+
"projectName": "kitten-scientists",
88+
"scriptName": "clean",
89+
"scriptCode": "yarn run clean:all",
90+
"isGlobal": false,
91+
"isRootManifest": true
92+
},
7693
{
7794
"manifestPath": "package.json",
7895
"projectName": "kitten-scientists",
7996
"scriptName": "clean:all",
8097
"scriptCode": "rm -rf packages/*/build packages/*/tsconfig.tsbuildinfo",
8198
"isGlobal": true,
82-
"isRootManifest": true
99+
"isRootManifest": true,
100+
"description": "Cleans all TypeScript build output from all workspaces."
83101
},
84102
{
85103
"manifestPath": "packages/kittensgame/package.json",
@@ -88,7 +106,7 @@
88106
"scriptCode": "bash ./scripts/build-development-container.sh",
89107
"isGlobal": true,
90108
"isRootManifest": false,
91-
"description": "Builds the Development Container."
109+
"description": "Builds the [Development Container](../../development.md#development-with-kittens-game-container)."
92110
},
93111
{
94112
"manifestPath": "packages/kittensgame/package.json",
@@ -97,7 +115,7 @@
97115
"scriptCode": "bash ./scripts/rebuild-development-container.sh",
98116
"isGlobal": true,
99117
"isRootManifest": false,
100-
"description": "Rebuilds the development container.\n\nYou're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container."
118+
"description": "Rebuilds the [Development Container](../../development.md#development-with-kittens-game-container).\n\nYou're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container."
101119
},
102120
{
103121
"manifestPath": "packages/kittensgame/package.json",
@@ -106,7 +124,7 @@
106124
"scriptCode": "bash ./scripts/run-development-container.sh",
107125
"isGlobal": true,
108126
"isRootManifest": false,
109-
"description": "Builds the development container and starts it."
127+
"description": "Builds the [Development Container](../../development.md#development-with-kittens-game-container) and starts it."
110128
},
111129
{
112130
"manifestPath": "packages/documentation/package.json",
@@ -124,7 +142,7 @@
124142
"scriptCode": "nsd --cwd=$INIT_CWD --docs-location=\"packages/documentation/docs/reference/Repository Scripts/\"",
125143
"isGlobal": true,
126144
"isRootManifest": false,
127-
"description": "Update the scripts documentation that you are looking at right now."
145+
"description": "Update the scripts reference that you are looking at right now."
128146
},
129147
{
130148
"manifestPath": "packages/documentation/package.json",
@@ -180,6 +198,14 @@
180198
"isRootManifest": false,
181199
"description": "Builds the Kitten Scientists userscript and watches all files for changes. If changes are detected, the script is rebuilt.\n\n!!! warning\n\n This watcher has caused problems in the past, generating broken output. Use at your own risk."
182200
},
201+
{
202+
"manifestPath": "package.json",
203+
"projectName": "kitten-scientists",
204+
"scriptName": "lint",
205+
"scriptCode": "yarn run lint:all",
206+
"isGlobal": false,
207+
"isRootManifest": true
208+
},
183209
{
184210
"manifestPath": "package.json",
185211
"projectName": "kitten-scientists",
@@ -221,85 +247,103 @@
221247
"isGlobal": false,
222248
"isRootManifest": false
223249
},
250+
{
251+
"manifestPath": "package.json",
252+
"projectName": "kitten-scientists",
253+
"scriptName": "test",
254+
"scriptCode": "yarn run test:all",
255+
"isGlobal": false,
256+
"isRootManifest": true
257+
},
224258
{
225259
"manifestPath": "package.json",
226260
"projectName": "kitten-scientists",
227261
"scriptName": "test:all",
228-
"scriptCode": "yarn workspaces foreach --all --parallel --verbose run test",
262+
"scriptCode": "yarn workspaces foreach --all --exclude kitten-scientists --parallel --verbose run test",
229263
"isGlobal": true,
230-
"isRootManifest": true
264+
"isRootManifest": true,
265+
"description": "Runs unit tests in all workspaces."
231266
},
232267
{
233268
"manifestPath": "packages/action-automatic-releases/package.json",
234269
"projectName": "@kitten-science/action-automatic-releases",
235270
"scriptName": "test:coverage",
236271
"scriptCode": "c8 --reporter html-spa --reporter text node --enable-source-maps $(yarn bin mocha) ./build/*.test.js",
237272
"isGlobal": true,
238-
"isRootManifest": false
273+
"isRootManifest": false,
274+
"description": "Runs unit tests in all workspaces and collects code coverage information."
239275
},
240276
{
241277
"manifestPath": "packages/action-commit-validator/package.json",
242278
"projectName": "@kitten-science/action-commit-validator",
243279
"scriptName": "test:coverage",
244280
"scriptCode": "c8 --reporter html-spa --reporter text node --enable-source-maps $(yarn bin mocha) ./build/*.test.js",
245281
"isGlobal": true,
246-
"isRootManifest": false
282+
"isRootManifest": false,
283+
"description": "Runs unit tests in all workspaces and collects code coverage information."
247284
},
248285
{
249286
"manifestPath": "packages/action-label-manager/package.json",
250287
"projectName": "@kitten-science/action-label-manager",
251288
"scriptName": "test:coverage",
252289
"scriptCode": "c8 --reporter html-spa --reporter text node --enable-source-maps $(yarn bin mocha) ./build/*.test.js",
253290
"isGlobal": true,
254-
"isRootManifest": false
291+
"isRootManifest": false,
292+
"description": "Runs unit tests in all workspaces and collects code coverage information."
255293
},
256294
{
257295
"manifestPath": "packages/action-release-info/package.json",
258296
"projectName": "@kitten-science/action-release-info",
259297
"scriptName": "test:coverage",
260298
"scriptCode": "c8 --reporter html-spa --reporter text node --enable-source-maps $(yarn bin mocha) ./build/*.test.js",
261299
"isGlobal": true,
262-
"isRootManifest": false
300+
"isRootManifest": false,
301+
"description": "Runs unit tests in all workspaces and collects code coverage information."
263302
},
264303
{
265304
"manifestPath": "package.json",
266305
"projectName": "kitten-scientists",
267306
"scriptName": "test:coverage:all",
268-
"scriptCode": "yarn workspaces foreach --all --parallel --verbose run test:coverage",
307+
"scriptCode": "yarn workspaces foreach --all --exclude kitten-scientists --parallel --verbose run test:coverage",
269308
"isGlobal": true,
270-
"isRootManifest": true
309+
"isRootManifest": true,
310+
"description": "Runs the `test:coverage` script in all workspaces."
271311
},
272312
{
273313
"manifestPath": "packages/action-automatic-releases/package.json",
274314
"projectName": "@kitten-science/action-automatic-releases",
275315
"scriptName": "test:inspect",
276316
"scriptCode": "node $(yarn bin mocha) --inspect ./build/*.test.js",
277317
"isGlobal": true,
278-
"isRootManifest": false
318+
"isRootManifest": false,
319+
"description": "Runs unit tests and lets you attach a debugger."
279320
},
280321
{
281322
"manifestPath": "packages/action-commit-validator/package.json",
282323
"projectName": "@kitten-science/action-commit-validator",
283324
"scriptName": "test:inspect",
284325
"scriptCode": "node $(yarn bin mocha) --inspect ./build/*.test.js",
285326
"isGlobal": true,
286-
"isRootManifest": false
327+
"isRootManifest": false,
328+
"description": "Runs unit tests and lets you attach a debugger."
287329
},
288330
{
289331
"manifestPath": "packages/action-label-manager/package.json",
290332
"projectName": "@kitten-science/action-label-manager",
291333
"scriptName": "test:inspect",
292334
"scriptCode": "node $(yarn bin mocha) --inspect ./build/*.test.js",
293335
"isGlobal": true,
294-
"isRootManifest": false
336+
"isRootManifest": false,
337+
"description": "Runs unit tests and lets you attach a debugger."
295338
},
296339
{
297340
"manifestPath": "packages/action-release-info/package.json",
298341
"projectName": "@kitten-science/action-release-info",
299342
"scriptName": "test:inspect",
300343
"scriptCode": "node $(yarn bin mocha) --inspect ./build/*.test.js",
301344
"isGlobal": true,
302-
"isRootManifest": false
345+
"isRootManifest": false,
346+
"description": "Runs unit tests and lets you attach a debugger."
303347
},
304348
{
305349
"manifestPath": "package.json",

‎packages/documentation/docs/reference/Repository Scripts/.build$$all.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
_documentation pending_
12+
Builds all TypeScript workspaces.

‎packages/documentation/docs/reference/Repository Scripts/.build.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## build
2+
3+
- Project: `kitten-scientists`
4+
- Source:
5+
6+
```shell
7+
yarn run build:all
8+
```
9+
10+
- Description:
11+
12+
_documentation pending_

‎packages/documentation/docs/reference/Repository Scripts/.clean$$all.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
_documentation pending_
12+
Cleans all TypeScript build output from all workspaces.

‎packages/documentation/docs/reference/Repository Scripts/.clean.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## clean
2+
3+
- Project: `kitten-scientists`
4+
- Source:
5+
6+
```shell
7+
yarn run clean:all
8+
```
9+
10+
- Description:
11+
12+
_documentation pending_

‎packages/documentation/docs/reference/Repository Scripts/.devcontainer$$build.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
Builds the Development Container.
12+
Builds the [Development Container](../../development.md#development-with-kittens-game-container).

‎packages/documentation/docs/reference/Repository Scripts/.devcontainer$$rebuild.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
- Description:
1111

12-
Rebuilds the development container.
12+
Rebuilds the [Development Container](../../development.md#development-with-kittens-game-container).
1313

1414
You're going to want to rebuild your development container every once in a while to ensure you're using the latest version of Kittens Game in your container.

‎packages/documentation/docs/reference/Repository Scripts/.devcontainer$$run.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
Builds the development container and starts it.
12+
Builds the [Development Container](../../development.md#development-with-kittens-game-container) and starts it.

‎packages/documentation/docs/reference/Repository Scripts/.docs$$nsd.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@
99

1010
- Description:
1111

12-
Update the scripts documentation that you are looking at right now.
12+
Update the scripts reference that you are looking at right now.

‎packages/documentation/docs/reference/Repository Scripts/.lint.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
## lint
2+
3+
- Project: `kitten-scientists`
4+
- Source:
5+
6+
```shell
7+
yarn run lint:all
8+
```
9+
10+
- Description:
11+
12+
_documentation pending_

0 commit comments

Comments
 (0)