chore(scripts): document what each script does

Use `npm-scripts-info` to document the most important scripts.
This commit is contained in:
zkochan
2017-01-08 11:57:46 +02:00
parent 4689befcc3
commit 5dfa71daf7

View File

@@ -99,6 +99,7 @@
"ncp": "^2.0.0",
"nixt": "0.5.0",
"npm-run-all": "3.1.2",
"npm-scripts-info": "0.3.6",
"rimraf": "2.5.4",
"sepia": "2.0.2",
"standard": "8.6.0",
@@ -131,14 +132,18 @@
"url": "git+https://github.com/rstacruz/pnpm.git"
},
"scripts": {
"info": "npm-scripts-info",
"start": "npm run tsc -- --watch",
"?docs:build": "echo 'Generate the documentation website'",
"docs:build": "docpress build",
"?commit": "echo 'Run Git commit wizard'",
"commit": "git-cz",
"cover": "istanbul cover test/index.js",
"lint": "standard && tslint -c tslint.json --project .",
"sinopia": "sinopia -c ./sinopia/config.yaml",
"prebuild-sinopia": "rimraf sinopia/storage/",
"publish-test-packages": "sh test/packages/publish-all.sh",
"?build-sinopia": "echo 'Cache the sinopia store for faster tests execution'",
"build-sinopia": "npm-run-all -p -r sinopia publish-test-packages",
"test:tap": "ts-node test | tap-diff",
"test:e2e": "npm-run-all -p -r sinopia test:tap",
@@ -146,6 +151,7 @@
"test": "npm run lint && npm run test:e2e",
"posttest": "git checkout -- sinopia/storage/",
"prerelease": "npm run tsc && npm test",
"?release": "echo 'Publish pnpm'",
"release": "sh .scripts/release.sh",
"tsc": "rimraf lib && tsc",
"prepublish": "in-publish && echo 'You need to use \"npm run release\" to publish pnpm' && false || npm run tsc"