Convert 0x.js scripts to TS, move the prepublishUtils script to dev-utils
and also convert it to TS.
This commit is contained in:
@@ -1,5 +1,9 @@
|
||||
# CHANGELOG
|
||||
|
||||
## v0.2.1 - _TBD_
|
||||
|
||||
* Add postpublish utils
|
||||
|
||||
## v0.2.0 - _February 16, 2018_
|
||||
|
||||
* Remove subproviders (#392)
|
||||
|
@@ -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"
|
||||
},
|
||||
|
7
packages/dev-utils/src/globals.d.ts
vendored
7
packages/dev-utils/src/globals.d.ts
vendored
@@ -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[];
|
||||
}
|
||||
|
@@ -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';
|
||||
|
86
packages/dev-utils/src/postpublish_utils.ts
Normal file
86
packages/dev-utils/src/postpublish_utils.ts
Normal file
@@ -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,
|
||||
};
|
5
packages/dev-utils/src/utils.ts
Normal file
5
packages/dev-utils/src/utils.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
export const utils = {
|
||||
log(...args: any[]): void {
|
||||
console.log(...args); // tslint:disable-line:no-console
|
||||
},
|
||||
};
|
Reference in New Issue
Block a user