aboutsummaryrefslogtreecommitdiffstats
path: root/packages/migrations
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-11-21 19:47:24 +0800
committerFabio Berger <me@fabioberger.com>2018-11-21 19:47:24 +0800
commitdb26ca977f56468e1ce7dbb30ed38e537912e545 (patch)
tree887a8fbdad96d66994f18f3d2a8ed9d4fe9867ae /packages/migrations
parenta8803431b3e339552c989d7567bf6241f39a2bdf (diff)
downloaddexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.gz
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.bz2
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.lz
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.xz
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.tar.zst
dexon-sol-tools-db26ca977f56468e1ce7dbb30ed38e537912e545.zip
Create migrations doc reference page
Diffstat (limited to 'packages/migrations')
-rw-r--r--packages/migrations/package.json9
-rw-r--r--packages/migrations/src/index.ts2
-rw-r--r--packages/migrations/typedoc-tsconfig.json7
3 files changed, 17 insertions, 1 deletions
diff --git a/packages/migrations/package.json b/packages/migrations/package.json
index 8eaae96ba..688df5f04 100644
--- a/packages/migrations/package.json
+++ b/packages/migrations/package.json
@@ -13,7 +13,13 @@
"clean": "shx rm -rf lib",
"lint": "tslint --format stylish --project .",
"migrate:v2": "run-s build script:migrate:v2",
- "script:migrate:v2": "node ./lib/migrate.js --contracts-version 2.0.0"
+ "script:migrate:v2": "node ./lib/migrate.js --contracts-version 2.0.0",
+ "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --tsconfig typedoc-tsconfig.json --json $JSON_FILE_PATH $PROJECT_FILES"
+ },
+ "config": {
+ "postpublish": {
+ "assets": []
+ }
},
"license": "Apache-2.0",
"devDependencies": {
@@ -25,6 +31,7 @@
"npm-run-all": "^4.1.2",
"shx": "^0.2.2",
"tslint": "5.11.0",
+ "typedoc": "0.13.0",
"typescript": "3.0.1",
"yargs": "^10.0.3"
},
diff --git a/packages/migrations/src/index.ts b/packages/migrations/src/index.ts
index 8f629a24b..cfd41040a 100644
--- a/packages/migrations/src/index.ts
+++ b/packages/migrations/src/index.ts
@@ -1 +1,3 @@
+export { Provider, TxData, JSONRPCRequestPayload, JSONRPCErrorCallback, TxDataPayable, JSONRPCResponsePayload, JSONRPCResponseError } from 'ethereum-types';
+export { ContractAddresses } from '@0x/contract-addresses';
export { runMigrationsAsync, runMigrationsOnceAsync } from './migration';
diff --git a/packages/migrations/typedoc-tsconfig.json b/packages/migrations/typedoc-tsconfig.json
new file mode 100644
index 000000000..c9b0af1ae
--- /dev/null
+++ b/packages/migrations/typedoc-tsconfig.json
@@ -0,0 +1,7 @@
+{
+ "extends": "../../typedoc-tsconfig",
+ "compilerOptions": {
+ "outDir": "lib"
+ },
+ "include": ["./src/**/*", "./test/**/*"]
+}