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

This commit is contained in:
Fabio Berger
2018-03-12 22:13:24 +01:00
parent 745af5309d
commit ef6aa9f41b
13 changed files with 206 additions and 6 deletions

View File

@@ -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;
}

View File

@@ -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);

View File

@@ -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);

View File

@@ -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"
},

View File

@@ -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"]
}