aboutsummaryrefslogtreecommitdiffstats
path: root/packages/sol-cov
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-18 22:08:52 +0800
committerFabio Berger <me@fabioberger.com>2018-03-18 22:08:52 +0800
commitb40fab35f6c1989fa391ac02c81150960270fc53 (patch)
treeec0cc8996db7bf40cc79c6382a3a6d186965beb1 /packages/sol-cov
parent644deee8b5ac16526e046b74e3a2ab41a50b6727 (diff)
downloaddexon-sol-tools-b40fab35f6c1989fa391ac02c81150960270fc53.tar.gz
dexon-sol-tools-b40fab35f6c1989fa391ac02c81150960270fc53.tar.zst
dexon-sol-tools-b40fab35f6c1989fa391ac02c81150960270fc53.zip
Add doc setup to sol-cov
Diffstat (limited to 'packages/sol-cov')
-rw-r--r--packages/sol-cov/package.json16
-rw-r--r--packages/sol-cov/src/monorepo_scripts/stagedocs.ts8
2 files changed, 23 insertions, 1 deletions
diff --git a/packages/sol-cov/package.json b/packages/sol-cov/package.json
index f3de566c1..21852c908 100644
--- a/packages/sol-cov/package.json
+++ b/packages/sol-cov/package.json
@@ -13,7 +13,20 @@
"test:circleci": "yarn test:coverage",
"run_mocha": "mocha lib/test/**/*_test.js",
"clean": "shx rm -rf lib scripts",
- "build": "copyfiles 'test/fixtures/**/*' ./lib && tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts"
+ "build": "copyfiles 'test/fixtures/**/*' ./lib && 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"
+ },
+ "config": {
+ "postpublish": {
+ "assets": [],
+ "docPublishConfigs": {
+ "extraFileIncludes": ["../types/src/index.ts"],
+ "s3BucketPath": "s3://doc-jsons/sol-cov/",
+ "s3StagingBucketPath": "s3://staging-doc-jsons/sol-cov/"
+ }
+ }
},
"repository": {
"type": "git",
@@ -53,6 +66,7 @@
"npm-run-all": "^4.1.2",
"shx": "^0.2.2",
"tslint": "5.8.0",
+ "typedoc": "0xProject/typedoc",
"typescript": "2.7.1",
"web3-typescript-typings": "^0.9.11"
}
diff --git a/packages/sol-cov/src/monorepo_scripts/stagedocs.ts b/packages/sol-cov/src/monorepo_scripts/stagedocs.ts
new file mode 100644
index 000000000..e732ac8eb
--- /dev/null
+++ b/packages/sol-cov/src/monorepo_scripts/stagedocs.ts
@@ -0,0 +1,8 @@
+import { postpublishUtils } from '@0xproject/monorepo-scripts';
+
+import * as packageJSON from '../package.json';
+import * as tsConfigJSON from '../tsconfig.json';
+
+const cwd = `${__dirname}/..`;
+// tslint:disable-next-line:no-floating-promises
+postpublishUtils.publishDocsToStagingAsync(packageJSON, tsConfigJSON, cwd);