Skip to content

Commit 82b09e0

Browse files
committed
Updates on docs
1 parent 95b8346 commit 82b09e0

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

package.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@
3232
"@commitlint/cli": "^16.2.3",
3333
"@commitlint/config-conventional": "^16.2.1",
3434
"@types/node": "^17.0.21",
35+
"@bitjson/npm-scripts-info": "^1.0.0",
3536
"adr-tools": "^2.0.4",
3637
"alex": "^9.1.0",
3738
"all-contributors-cli": "^6.20.0",
@@ -174,6 +175,7 @@
174175
"crowdin:pull": "crowdin pull --skip-untranslated-strings",
175176
"crowdin:upload": "crowdin --config crowdin.yml upload sources --auto-update -b $(git rev-parse --abbrev-ref HEAD)",
176177
"csv:view": "pspg -s 17 --csv \"datas.csv\"",
178+
"describe": "npm-scripts-info",
177179
"deploy": "deploy-to-gh-pages --local --update site",
178180
"deps": "npm install",
179181
"docker:build": "docker build -f ./distribution/docker-images/dev.Dockerfile -t $npm_package_config_image .",
@@ -293,6 +295,19 @@
293295
"validate:commit": "validate-commit-msg",
294296
"zip": "zip -r $npm_package_config_image.zip ./site"
295297
},
298+
"scripts-info": {
299+
"info": "Display information about the package scripts",
300+
"build": "Clean and rebuild the project",
301+
"fix": "Try to automatically fix any linting problems",
302+
"test": "Lint and unit test the project",
303+
"watch": "Watch and rebuild the project on save, then rerun relevant tests",
304+
"cov": "Rebuild, run tests, then create and open the coverage report",
305+
"doc": "Generate HTML API documentation and open it in a browser",
306+
"doc:json": "Generate API documentation in typedoc JSON format",
307+
"version": "Bump package.json version, update CHANGELOG.md, tag release",
308+
"reset": "Delete all untracked files and reset the repo to the last commit",
309+
"prepare-release": "One-step: clean, build, test, publish docs, and prep a release"
310+
},
296311
"targets": {
297312
"default": {
298313
"distDir": ".",

0 commit comments

Comments
 (0)