packages/0x.js/monorepo_scripts/stagedocs.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

import { postpublishUtils } from '@0xproject/dev-utils';
import { execAsync } from 'async-child-process';
import * as _ from 'lodash';

import * as tsConfig from '../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 as any).include, '../types/src/index.ts'];
const fileIncludesAdjusted = postpublishUtils.adjustFileIncludePaths(fileIncludes, __dirname);
const projectFiles = fileIncludesAdjusted.join(' ');
const jsonFilePath = `${__dirname}/../${postpublishUtils.generatedDocsDirectoryName}/index.json`;
const version = process.env.DOCS_VERSION;

(async () => {
    const result = await execAsync(`JSON_FILE_PATH=${jsonFilePath} PROJECT_FILES="${projectFiles}" yarn docs:json`, {
        cwd,
    });
    if (!_.isEmpty(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(console.error);