aboutsummaryrefslogtreecommitdiffstats
path: root/packages/0x.js/scripts/postpublish.js
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-03-04 04:44:44 +0800
committerFabio Berger <me@fabioberger.com>2018-03-04 04:44:44 +0800
commitdf4db8fa4c19d2ef0a311d201061ba732ce0eb97 (patch)
treee5fcbc5612296eaa8b368c264259001e0172e4f1 /packages/0x.js/scripts/postpublish.js
parente11e26a35274a96fd2d4b7f37e60b89220115994 (diff)
parentbd85fe0af3ce201710f92b995cf25dfc96fba953 (diff)
downloaddexon-0x-contracts-df4db8fa4c19d2ef0a311d201061ba732ce0eb97.tar.gz
dexon-0x-contracts-df4db8fa4c19d2ef0a311d201061ba732ce0eb97.tar.zst
dexon-0x-contracts-df4db8fa4c19d2ef0a311d201061ba732ce0eb97.zip
Merge branch '0x.js/updateTypeDoc' into extractDocs
* 0x.js/updateTypeDoc: 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 Update yarn.lock
Diffstat (limited to 'packages/0x.js/scripts/postpublish.js')
-rw-r--r--packages/0x.js/scripts/postpublish.js9
1 files changed, 8 insertions, 1 deletions
diff --git a/packages/0x.js/scripts/postpublish.js b/packages/0x.js/scripts/postpublish.js
index de2c5158e..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 + ' yarn docs:json', {
+ return execAsync('JSON_FILE_PATH=' + jsonFilePath + ' PROJECT_FILES="' + projectFiles + '" yarn docs:json', {
cwd,
});
})