diff options
author | Fabio Berger <me@fabioberger.com> | 2018-03-04 23:33:58 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-03-04 23:33:58 +0800 |
commit | 9ac1cce26fcf17d161b7d67b3240728d623a1085 (patch) | |
tree | b00482542d91e1374f1a470314afc26957d2f35b /packages/0x.js/scripts | |
parent | 02f82be094dbaf92a1ae6752b9f05dbf6188cf86 (diff) | |
parent | 0a597c94d6359c34dc0ab2d3cc4e1dfecaecf18a (diff) | |
download | dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.tar dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.tar.gz dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.tar.bz2 dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.tar.lz dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.tar.xz dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.tar.zst dexon-0x-contracts-9ac1cce26fcf17d161b7d67b3240728d623a1085.zip |
Merge branch 'development' into improveLedgerSubprovider
* development: (28 commits)
Remove unnecessary type assertion
Fix comments
Add comments
Don't need any external packages for 0x connect docs yet
Instead of adding `@0xproject/types` to tsconfig.json, let's only add it when calling TypeDoc
Fix styling
Make prettier ignore postpublish_utils
Add hack comment
Add comment about typeDoc versions
Add support for merging multiple topLevel packages under a single section. For now, we simply merge the two package's children (works well for merging 0x.js types and @0xproject/types)
Because we now include non-0x.js source, the keys changed. Needed to add both for backward compatibility with old doc JSON's
Add support for backward compatibility for TypeDoc versions <0.9.0
Consolidate all same exports together
Add @0xproject/types to 0x.js tsconfig `include` so that TypeDoc also includes these types in the generated doc JSON
Fix small bug where onHover type declarations with comments was taking up the entire window width
Update to custom typeDoc fork with latest version (TS 2.7.0 support) + a bug fix allowing us to defer to the `include` in tsconfig.json on which files to run through TypeDoc
Move web3 typings from devDeps to deps
remove extrenuous comma
Add PR number
Add changelog entries from types and utils
...
# Conflicts:
# packages/subproviders/CHANGELOG.md
Diffstat (limited to 'packages/0x.js/scripts')
-rw-r--r-- | packages/0x.js/scripts/postpublish.js | 9 | ||||
-rw-r--r-- | packages/0x.js/scripts/stagedocs.js | 33 |
2 files changed, 28 insertions, 14 deletions
diff --git a/packages/0x.js/scripts/postpublish.js b/packages/0x.js/scripts/postpublish.js index 7cbabd8f6..1a9ab73ea 100644 --- a/packages/0x.js/scripts/postpublish.js +++ b/packages/0x.js/scripts/postpublish.js @@ -1,9 +1,16 @@ const execAsync = require('async-child-process').execAsync; const postpublish_utils = require('../../../scripts/postpublish_utils'); const packageJSON = require('../package.json'); +const tsConfig = require('../tsconfig.json'); const cwd = __dirname + '/..'; const subPackageName = packageJSON.name; +// Include any external packages that are part of the 0x.js public interface +// to this array so that TypeDoc picks it up and adds it to the Docs JSON +// So far, we only have @0xproject/types as part of 0x.js's public interface. +const fileIncludes = [...tsConfig.include, '../types/src/index.ts']; +const fileIncludesAdjusted = postpublish_utils.adjustFileIncludePaths(fileIncludes, __dirname); +const projectFiles = fileIncludesAdjusted.join(' '); const S3BucketPath = 's3://0xjs-docs-jsons/'; let tag; @@ -20,7 +27,7 @@ postpublish_utils .then(function(release) { console.log('POSTPUBLISH: Release successful, generating docs...'); const jsonFilePath = __dirname + '/../' + postpublish_utils.generatedDocsDirectoryName + '/index.json'; - return execAsync('JSON_FILE_PATH=' + jsonFilePath + ' PROJECT_DIR=' + __dirname + '/.. yarn docs:json', { + return execAsync('JSON_FILE_PATH=' + jsonFilePath + ' PROJECT_FILES="' + projectFiles + '" yarn docs:json', { cwd, }); }) diff --git a/packages/0x.js/scripts/stagedocs.js b/packages/0x.js/scripts/stagedocs.js index b48c23851..f0ba55205 100644 --- a/packages/0x.js/scripts/stagedocs.js +++ b/packages/0x.js/scripts/stagedocs.js @@ -1,24 +1,31 @@ const execAsync = require('async-child-process').execAsync; const postpublish_utils = require('../../../scripts/postpublish_utils'); +const tsConfig = require('../tsconfig.json'); const cwd = __dirname + '/..'; const S3BucketPath = 's3://staging-0xjs-docs-jsons/'; +// Include any external packages that are part of the 0x.js public interface +// to this array so that TypeDoc picks it up and adds it to the Docs JSON +// So far, we only have @0xproject/types as part of 0x.js's public interface. +const fileIncludes = [...tsConfig.include, '../types/src/index.ts']; +const fileIncludesAdjusted = postpublish_utils.adjustFileIncludePaths(fileIncludes, __dirname); +const projectFiles = fileIncludesAdjusted.join(' '); const jsonFilePath = __dirname + '/../' + postpublish_utils.generatedDocsDirectoryName + '/index.json'; const version = process.env.DOCS_VERSION; -execAsync('JSON_FILE_PATH=' + jsonFilePath + ' PROJECT_DIR=' + __dirname + '/.. yarn docs:json', { +execAsync('JSON_FILE_PATH=' + jsonFilePath + ' PROJECT_FILES="' + projectFiles + '" yarn docs:json', { cwd, }) -.then(function(result) { - if (result.stderr !== '') { - throw new Error(result.stderr); - } - const fileName = 'v' + version + '.json'; - const s3Url = S3BucketPath + fileName; - return execAsync('S3_URL=' + s3Url + ' yarn upload_docs_json', { - cwd, + .then(function(result) { + if (result.stderr !== '') { + throw new Error(result.stderr); + } + const fileName = 'v' + version + '.json'; + const s3Url = S3BucketPath + fileName; + return execAsync('S3_URL=' + s3Url + ' yarn upload_docs_json', { + cwd, + }); + }) + .catch(function(err) { + console.log(err); }); -}) -.catch(function(err) { - console.log(err); -}); |