diff options
| author | Fabio Berger <me@fabioberger.com> | 2018-08-15 08:55:38 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2018-08-15 08:55:38 +0800 |
| commit | 3b8a343711e0b23a453a1466411e2b9ca68eb0b2 (patch) | |
| tree | aaba0533cc27ca67b7b21cac33cdabfbf1a2060e | |
| parent | 83e3bb899ed88c8ac32331d2f1b533e52d5ad8cd (diff) | |
| download | dexon-0x-contracts-3b8a343711e0b23a453a1466411e2b9ca68eb0b2.tar.gz dexon-0x-contracts-3b8a343711e0b23a453a1466411e2b9ca68eb0b2.tar.zst dexon-0x-contracts-3b8a343711e0b23a453a1466411e2b9ca68eb0b2.zip | |
Add version to our custom DocJson format
| -rw-r--r-- | packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts index 2bc5441fc..d791b010f 100644 --- a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts +++ b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts @@ -18,7 +18,8 @@ interface ExportNameToTypedocNames { [exportName: string]: string[]; } -// TODO: Add the EXTERNAL_TYPE_TO_LINK mapping to the Doc JSON +const DOC_JSON_VERSION = '0.0.1'; + const EXTERNAL_TYPE_TO_LINK: { [externalType: string]: string } = { BigNumber: 'http://mikemcl.github.io/bignumber.js', Error: 'https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/v9/index.d.ts#L134', @@ -199,6 +200,7 @@ export async function generateAndUploadDocsAsync(packageName: string, isStaging: // Since we need additional metadata included in the doc JSON, we nest the TypeDoc JSON const docJson = { + version: DOC_JSON_VERSION, metadata: { exportPathToTypedocNames, exportPathOrder, |