Added doc json generation and uploading to Web3Wrapper package
This commit is contained in:
@@ -1,6 +1,6 @@
|
||||
## @0xproject/web3-wrapper
|
||||
|
||||
Wrapped version of web3 with a nicer interface that is used across 0x projects and packages
|
||||
Wrapped version of web3 with a nicer interface that is used across 0x projects and packages. Visit [the docs](0xproject.com/docs/web3_wrapper).
|
||||
|
||||
## Installation
|
||||
|
||||
|
||||
@@ -8,7 +8,18 @@
|
||||
"build:watch": "tsc -w",
|
||||
"build": "tsc && copyfiles -u 2 './lib/monorepo_scripts/**/*' ./scripts",
|
||||
"clean": "shx rm -rf lib scripts",
|
||||
"lint": "tslint --project . 'src/**/*.ts'"
|
||||
"lint": "tslint --project . 'src/**/*.ts'",
|
||||
"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": {
|
||||
"docPublishConfigs": {
|
||||
"extraFileIncludes": ["../types/src/index.ts"],
|
||||
"s3BucketPath": "s3://web3-wrapper-docs-json/",
|
||||
"s3StagingBucketPath": "s3://staging-web3-wrapper-docs-json/"
|
||||
}
|
||||
}
|
||||
},
|
||||
"license": "Apache-2.0",
|
||||
"repository": {
|
||||
@@ -27,6 +38,7 @@
|
||||
"npm-run-all": "^4.1.2",
|
||||
"shx": "^0.2.2",
|
||||
"tslint": "5.8.0",
|
||||
"typedoc": "0xProject/typedoc",
|
||||
"typescript": "2.7.1"
|
||||
},
|
||||
"dependencies": {
|
||||
|
||||
8
packages/web3-wrapper/src/monorepo_scripts/stagedocs.ts
Normal file
8
packages/web3-wrapper/src/monorepo_scripts/stagedocs.ts
Normal file
@@ -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);
|
||||
Reference in New Issue
Block a user