Convert 0x.js scripts to TS, move the prepublishUtils script to dev-utils and also convert it to TS.

.gitignore

@@ -75,3 +75,6 @@ bin/
 
 # generated contract artifacts
 packages/contracts/src/artifacts
+
+# Monorepo scripts
+packages/0x.js/scripts

package.json

@@ -16,12 +16,8 @@
         "mnemonic": "concert load couple harbor equip island argue ramp clarify fence smart topic"
     },
     "devDependencies": {
-        "@0xproject/utils": "^0.4.1",
-        "async-child-process": "^1.1.1",
         "ethereumjs-testrpc": "^6.0.3",
         "lerna": "^2.5.1",
-        "prettier": "^1.11.1",
-        "publish-release": "0xproject/publish-release",
-        "semver-sort": "^0.0.4"
+        "prettier": "^1.11.1"
     }
 }

packages/0x.js/monorepo_scripts/globals.d.ts

@@ -0,0 +1,12 @@
+declare module 'async-child-process';
+declare module 'publish-release';
+
+// semver-sort declarations
+declare module 'semver-sort' {
+    const desc: (versions: string[]) => string[];
+}
+
+declare module '*.json' {
+    const value: any;
+    export default value;
+}

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

@@ -0,0 +1,44 @@
+import { postpublishUtils } from '@0xproject/dev-utils';
+import { execAsync } from 'async-child-process';
+import * as _ from 'lodash';
+
+import * as packageJSON from '../package.json';
+import * as tsConfig from '../tsconfig.json';
+
+const cwd = `${__dirname}/..`;
+const subPackageName = (packageJSON as any).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 as any).include, '../types/src/index.ts'];
+const fileIncludesAdjusted = postpublishUtils.adjustFileIncludePaths(fileIncludes, __dirname);
+const projectFiles = fileIncludesAdjusted.join(' ');
+const S3BucketPath = 's3://0xjs-docs-jsons/';
+
+(async () => {
+    const tagAndVersion = await postpublishUtils.getLatestTagAndVersionAsync(subPackageName);
+    const tag = tagAndVersion.tag;
+    const version = tagAndVersion.version;
+
+    const releaseName = postpublishUtils.getReleaseName(subPackageName, version);
+    const assets = [`${__dirname}/../_bundles/index.js`, `${__dirname}/../_bundles/index.min.js`];
+    const release = await postpublishUtils.publishReleaseNotesAsync(tag, releaseName, assets);
+
+    // tslint:disable-next-line:no-console
+    console.log('POSTPUBLISH: Release successful, generating docs...');
+    const jsonFilePath = `${__dirname}/../${postpublishUtils.generatedDocsDirectoryName}/index.json`;
+
+    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`;
+    // tslint:disable-next-line:no-console
+    console.log(`POSTPUBLISH: Doc generation successful, uploading docs... as ${fileName}`);
+    const s3Url = S3BucketPath + fileName;
+    return execAsync(`S3_URL=${s3Url} yarn upload_docs_json`, {
+        cwd,
+    });
+})().catch(console.error);

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

@@ -0,0 +1,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);

packages/0x.js/package.json

@@ -14,7 +14,7 @@
     "scripts": {
         "build:watch": "tsc -w",
         "prebuild": "run-s clean generate_contract_wrappers",
-        "build": "run-p build:umd:prod build:commonjs; exit 0;",
+        "build": "run-p build:scripts build:umd:prod build:commonjs; exit 0;",
         "docs:json": "typedoc --excludePrivate --excludeExternals --target ES5 --json $JSON_FILE_PATH $PROJECT_FILES",
         "upload_docs_json": "aws s3 cp generated_docs/index.json $S3_URL --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json",
         "generate_contract_wrappers": "node ../abi-gen/lib/index.js --abis 'src/artifacts/@(Exchange|Token|TokenTransferProxy|EtherToken|TokenRegistry|DummyToken).json' --template ../contract_templates/contract.handlebars --partials '../contract_templates/partials/**/*.handlebars' --output src/contract_wrappers/generated --backend ethers && prettier --write 'src/contract_wrappers/generated/**.ts'",
@@ -27,6 +27,7 @@
         "clean": "shx rm -rf _bundles lib test_temp",
         "build:umd:prod": "NODE_ENV=production webpack",
         "build:commonjs": "tsc && copyfiles -u 2 './src/artifacts/**/*.json' ./lib/src/artifacts;",
+        "build:scripts": "tsc --p ./tsconfig_monorepo.json",
         "test:commonjs": "run-s build:commonjs run_mocha",
         "run_mocha": "mocha lib/test/**/*_test.js --timeout 10000 --bail --exit"
     },

packages/0x.js/tsconfig_monorepo.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../../tsconfig",
+    "compilerOptions": {
+        "outDir": "scripts",
+        "noImplicitThis": false,
+        "rootDir": "./monorepo_scripts"
+    },
+    "include": ["./monorepo_scripts/**/*", "../../node_modules/web3-typescript-typings/index.d.ts"]
+}

packages/dev-utils/CHANGELOG.md

@@ -1,5 +1,9 @@
 # CHANGELOG
 
+## v0.2.1 - _TBD_
+
+    * Add postpublish utils
+
 ## v0.2.0 - _February 16, 2018_
 
     * Remove subproviders (#392)

packages/dev-utils/package.json

@@ -43,7 +43,9 @@
         "@0xproject/utils": "^0.4.1",
         "ethereumjs-util": "^5.1.2",
         "lodash": "^4.17.4",
+        "publish-release": "0xproject/publish-release",
         "request-promise-native": "^1.0.5",
+        "semver-sort": "^0.0.4",
         "web3": "^0.20.0",
         "web3-provider-engine": "^13.0.1"
     },

packages/dev-utils/src/globals.d.ts

@@ -1,2 +1,9 @@
 declare module 'web3-provider-engine';
 declare module 'web3-provider-engine/subproviders/rpc';
+declare module 'async-child-process';
+declare module 'publish-release';
+
+// semver-sort declarations
+declare module 'semver-sort' {
+    const desc: (versions: string[]) => string[];
+}

packages/dev-utils/src/index.ts

@@ -2,3 +2,4 @@ export { RPC } from './rpc';
 export { BlockchainLifecycle } from './blockchain_lifecycle';
 export { web3Factory } from './web3_factory';
 export { constants as devConstants } from './constants';
+export { postpublishUtils } from './postpublish_utils';

packages/dev-utils/src/postpublish_utils.ts

@@ -0,0 +1,86 @@
+import { promisify } from '@0xproject/utils';
+import { execAsync } from 'async-child-process';
+import * as _ from 'lodash';
+import * as publishRelease from 'publish-release';
+import semverSort = require('semver-sort');
+
+import { utils } from './utils';
+
+const publishReleaseAsync = promisify(publishRelease);
+const githubPersonalAccessToken = process.env.GITHUB_PERSONAL_ACCESS_TOKEN_0X_JS;
+const generatedDocsDirectoryName = 'generated_docs';
+
+export interface TagAndVersion {
+    tag: string;
+    version: string;
+}
+
+export const postpublishUtils = {
+    getLatestTagAndVersionAsync(subPackageName: string): Promise<TagAndVersion> {
+        const subPackagePrefix = `${subPackageName}@`;
+        const gitTagsCommand = `git tag -l "${subPackagePrefix}*"`;
+        return execAsync(gitTagsCommand).then((result: any) => {
+            if (!_.isEmpty(result.stderr)) {
+                throw new Error(result.stderr);
+            }
+            const tags = result.stdout.trim().split('\n');
+            const versions = tags.map((tag: string) => {
+                return tag.slice(subPackagePrefix.length);
+            });
+            const sortedVersions = semverSort.desc(versions);
+            const latestVersion = sortedVersions[0];
+            const latestTag = subPackagePrefix + latestVersion;
+            return {
+                tag: latestTag,
+                version: latestVersion,
+            };
+        });
+    },
+    publishReleaseNotesAsync(tag: string, releaseName: string, assets: string[]) {
+        utils.log('POSTPUBLISH: Releasing ', releaseName, '...');
+        return publishReleaseAsync({
+            token: githubPersonalAccessToken,
+            owner: '0xProject',
+            repo: '0x.js',
+            tag,
+            name: releaseName,
+            notes: 'N/A',
+            draft: false,
+            prerelease: false,
+            reuseRelease: true,
+            reuseDraftOnly: false,
+            assets,
+        });
+    },
+    getReleaseName(subPackageName: string, version: string): string {
+        const releaseName = `${subPackageName} v${version}`;
+        return releaseName;
+    },
+    async standardPostPublishAsync(subPackageName: string): Promise<void> {
+        const result: TagAndVersion = await this.getLatestTagAndVersionAsync(subPackageName);
+        const releaseName = this.getReleaseName(subPackageName, result.version);
+        const assets: string[] = [];
+        await this.publishReleaseNotesAsync(result.tag, releaseName, assets);
+    },
+    adjustFileIncludePaths(fileIncludes: string[], cwd: string): string[] {
+        const fileIncludesAdjusted = _.map(fileIncludes, fileInclude => {
+            let path;
+            if (_.startsWith(fileInclude, '../')) {
+                path = `${cwd}/../${fileInclude}`;
+            } else if (_.startsWith(fileInclude, './')) {
+                path = `${cwd}/../${fileInclude.substr(2)}`;
+            } else {
+                path = `${cwd}/${fileInclude}`;
+            }
+
+            // HACK: tsconfig.json needs wildcard directory endings as `/**/*`
+            // but TypeDoc needs it as `/**` in order to pick up files at the root
+            if (_.endsWith(path, '/**/*')) {
+                path = path.slice(0, -2);
+            }
+            return path;
+        });
+        return fileIncludesAdjusted;
+    },
+    generatedDocsDirectoryName,
+};

packages/dev-utils/src/utils.ts

@@ -0,0 +1,5 @@
+export const utils = {
+    log(...args: any[]): void {
+        console.log(...args); // tslint:disable-line:no-console
+    },
+};