aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-18 22:08:37 +0800
committerFabio Berger <me@fabioberger.com>2018-03-18 22:08:37 +0800
commit644deee8b5ac16526e046b74e3a2ab41a50b6727 (patch)
treef6522a54c9a5ea243aaccde3248236b011cdc629
parentc7302c46e57c4646dbbd0004e09e987b720b5815 (diff)
downloaddexon-0x-contracts-644deee8b5ac16526e046b74e3a2ab41a50b6727.tar.gz
dexon-0x-contracts-644deee8b5ac16526e046b74e3a2ab41a50b6727.tar.zst
dexon-0x-contracts-644deee8b5ac16526e046b74e3a2ab41a50b6727.zip
Standardize all doc commands and add `docs:stage` shortcut
-rw-r--r--packages/0x.js/package.json7
-rw-r--r--packages/connect/package.json7
-rw-r--r--packages/deployer/package.json1
-rw-r--r--packages/json-schemas/package.json1
-rw-r--r--packages/web3-wrapper/package.json1
5 files changed, 11 insertions, 6 deletions
diff --git a/packages/0x.js/package.json b/packages/0x.js/package.json
index 4bc0cc193..3c2322227 100644
--- a/packages/0x.js/package.json
+++ b/packages/0x.js/package.json
@@ -15,8 +15,6 @@
"build:watch": "tsc -w",
"prebuild": "run-s clean generate_contract_wrappers",
"build": "run-p build:umd:prod build:commonjs; exit 0;",
- "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
- "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json",
"generate_contract_wrappers": "node ../abi-gen/lib/index.js --abis 'src/artifacts/@(Exchange|Token|TokenTransferProxy|EtherToken|TokenRegistry|DummyToken).json' --template ../contract_templates/contract.handlebars --partials '../contract_templates/partials/**/*.handlebars' --output src/contract_wrappers/generated --backend ethers && prettier --write 'src/contract_wrappers/generated/**.ts'",
"lint": "tslint --project . 'src/**/*.ts' 'test/**/*.ts'",
"test:circleci": "run-s test:coverage",
@@ -28,7 +26,10 @@
"build:umd:prod": "NODE_ENV=production webpack",
"build:commonjs": "tsc && copyfiles -u 2 './src/artifacts/**/*.json' ./lib/src/artifacts && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
"test:commonjs": "run-s build:commonjs run_mocha",
- "run_mocha": "mocha lib/test/**/*_test.js --timeout 10000 --bail --exit"
+ "run_mocha": "mocha lib/test/**/*_test.js --timeout 10000 --bail --exit",
+ "docs:stage": "yarn build && node ./scripts/stagedocs.js",
+ "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
+ "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
},
"config": {
"artifacts": "TokenTransferProxy Exchange TokenRegistry Token EtherToken",
diff --git a/packages/connect/package.json b/packages/connect/package.json
index 63ca61693..01806092d 100644
--- a/packages/connect/package.json
+++ b/packages/connect/package.json
@@ -15,15 +15,16 @@
"build:watch": "tsc -w",
"build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
"clean": "shx rm -rf _bundles lib test_temp scripts",
- "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
- "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json",
"copy_test_fixtures": "copyfiles -u 2 './test/fixtures/**/*.json' ./lib/test/fixtures",
"lint": "tslint --project . 'src/**/*.ts' 'test/**/*.ts'",
"run_mocha": "mocha lib/test/**/*_test.js",
"test": "run-s clean build copy_test_fixtures run_mocha",
"test:coverage": "nyc npm run test --all && yarn coverage:report:lcov",
"coverage:report:lcov": "nyc report --reporter=text-lcov > coverage/lcov.info",
- "test:circleci": "yarn test:coverage"
+ "test:circleci": "yarn test:coverage",
+ "docs:stage": "yarn build && node ./scripts/stagedocs.js",
+ "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
+ "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
},
"config": {
"postpublish": {
diff --git a/packages/deployer/package.json b/packages/deployer/package.json
index 346b967e2..8194fffcd 100644
--- a/packages/deployer/package.json
+++ b/packages/deployer/package.json
@@ -15,6 +15,7 @@
"migrate": "npm run build; node lib/src/cli.js migrate",
"lint": "tslint --project . 'src/**/*.ts' 'test/**/*.ts'",
"test:circleci": "yarn test:coverage",
+ "docs:stage": "yarn build && node ./scripts/stagedocs.js",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
"upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
},
diff --git a/packages/json-schemas/package.json b/packages/json-schemas/package.json
index a63d435ab..09cad732b 100644
--- a/packages/json-schemas/package.json
+++ b/packages/json-schemas/package.json
@@ -14,6 +14,7 @@
"run_mocha": "mocha lib/test/**/*_test.js",
"clean": "shx rm -rf _bundles lib test_temp scripts",
"build": "tsc && copyfiles -u 3 './lib/src/monorepo_scripts/**/*' ./scripts",
+ "docs:stage": "yarn build && node ./scripts/stagedocs.js",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
"upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
},
diff --git a/packages/web3-wrapper/package.json b/packages/web3-wrapper/package.json
index 9b41f1de6..58f3f1083 100644
--- a/packages/web3-wrapper/package.json
+++ b/packages/web3-wrapper/package.json
@@ -9,6 +9,7 @@
"build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts",
"clean": "shx rm -rf lib scripts",
"lint": "tslint --project . 'src/**/*.ts'",
+ "docs:stage": "yarn build && node ./scripts/stagedocs.js",
"docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
"upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json"
},