aboutsummaryrefslogtreecommitdiffstats
path: root/packages/monorepo-scripts
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-22 02:07:20 +0800
committerFabio Berger <me@fabioberger.com>2018-08-22 02:07:20 +0800
commit6b838c034a3a489ae0b962af820270eafc52c377 (patch)
treeb972b83d2f3618edf319795accb143c6dc4ccb2b /packages/monorepo-scripts
parent8bb7b5b543c4d914067b6bbb269be9cc2ac7f647 (diff)
downloaddexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.tar
dexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.tar.gz
dexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.tar.bz2
dexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.tar.lz
dexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.tar.xz
dexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.tar.zst
dexon-sol-tools-6b838c034a3a489ae0b962af820270eafc52c377.zip
Modify script so it can generate docs for a specific package or all packages with doc pages, add doc gen test to CircleCi runs
Diffstat (limited to 'packages/monorepo-scripts')
-rw-r--r--packages/monorepo-scripts/src/doc_gen_configs.ts14
-rw-r--r--packages/monorepo-scripts/src/doc_generate_and_upload.ts9
-rw-r--r--packages/monorepo-scripts/src/types.ts1
-rw-r--r--packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts81
4 files changed, 65 insertions, 40 deletions
diff --git a/packages/monorepo-scripts/src/doc_gen_configs.ts b/packages/monorepo-scripts/src/doc_gen_configs.ts
index 52cbc4f59..a7314776e 100644
--- a/packages/monorepo-scripts/src/doc_gen_configs.ts
+++ b/packages/monorepo-scripts/src/doc_gen_configs.ts
@@ -2,6 +2,20 @@ import { DocGenConfigs } from './types';
export const docGenConfigs: DocGenConfigs = {
DOC_JSON_VERSION: '0.0.1',
+ // Packages for which doc pages exist
+ PACKAGES_WITH_DOC_PAGES: [
+ '0x.js',
+ 'connect',
+ 'json-schemas',
+ 'subproviders',
+ 'web3-wrapper',
+ 'contract-wrappers',
+ 'order-utils',
+ 'order-watcher',
+ 'sol-compiler',
+ 'sol-cov',
+ 'ethereum-types',
+ ];
EXTERNAL_TYPE_TO_LINK: {
Array: 'https://developer.mozilla.org/pt-PT/docs/Web/JavaScript/Reference/Global_Objects/Array',
BigNumber: 'http://mikemcl.github.io/bignumber.js',
diff --git a/packages/monorepo-scripts/src/doc_generate_and_upload.ts b/packages/monorepo-scripts/src/doc_generate_and_upload.ts
index 77dc2f323..7b6f2d9f0 100644
--- a/packages/monorepo-scripts/src/doc_generate_and_upload.ts
+++ b/packages/monorepo-scripts/src/doc_generate_and_upload.ts
@@ -4,9 +4,10 @@ import { DocGenerateAndUploadUtils } from './utils/doc_generate_and_upload_utils
const args = yargs
.option('package', {
- describe: 'Monorepo sub-package for which to generate DocJSON',
+ describe:
+ 'Monorepo sub-package for which to generate DocJSON. If not supplied, it will do all defined in docGenConfigs.',
type: 'string',
- demandOption: true,
+ demandOption: false,
})
.option('isStaging', {
describe: 'Whether we wish to publish docs to staging or production',
@@ -22,10 +23,10 @@ const args = yargs
.example("$0 --package '0x.js' --isStaging true", 'Full usage example').argv;
(async () => {
- const packageName = args.package;
+ const packageNameIfExists = args.package;
const isStaging = args.isStaging;
const shouldUploadDocs = args.shouldUpload;
- const docGenerateAndUploadUtils = new DocGenerateAndUploadUtils(packageName, isStaging, shouldUploadDocs);
+ const docGenerateAndUploadUtils = new DocGenerateAndUploadUtils(packageNameIfExists, isStaging, shouldUploadDocs);
await docGenerateAndUploadUtils.generateAndUploadDocsAsync();
})();
diff --git a/packages/monorepo-scripts/src/types.ts b/packages/monorepo-scripts/src/types.ts
index 3c2ec5069..b87cc47eb 100644
--- a/packages/monorepo-scripts/src/types.ts
+++ b/packages/monorepo-scripts/src/types.ts
@@ -52,6 +52,7 @@ export interface Package {
export interface DocGenConfigs {
DOC_JSON_VERSION: string;
+ PACKAGES_WITH_DOC_PAGES: string[];
EXTERNAL_TYPE_TO_LINK: { [externalType: string]: string };
EXTERNAL_EXPORT_TO_LINK: { [externalExport: string]: string };
CLASSES_WITH_HIDDEN_CONSTRUCTORS: string[];
diff --git a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
index 7e8bd07da..c84413e64 100644
--- a/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
+++ b/packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
@@ -13,7 +13,7 @@ import { utils } from './utils';
export class DocGenerateAndUploadUtils {
private _isStaging: boolean;
private _shouldUploadDocs: boolean;
- private _packageName: string;
+ private _packageNameIfExists: string;
private _omitExports: string[];
private _packagePath: string;
private _exportPathToExportedItems: ExportPathToExportedItems;
@@ -156,21 +156,21 @@ export class DocGenerateAndUploadUtils {
};
return exportInfo;
}
- constructor(packageName: string, isStaging: boolean, shouldUploadDocs: boolean) {
+ constructor(packageNameIfExists: string, isStaging: boolean, shouldUploadDocs: boolean) {
this._isStaging = isStaging;
- this._packageName = packageName;
+ this._packageNameIfExists = packageNameIfExists;
this._shouldUploadDocs = shouldUploadDocs;
- this._packagePath = `${constants.monorepoRootPath}/packages/${packageName}`;
+ this._packagePath = `${constants.monorepoRootPath}/packages/${packageNameIfExists}`;
this._monoRepoPkgNameToPath = {};
const monorepoPackages = utils.getPackages(constants.monorepoRootPath);
_.each(monorepoPackages, p => (this._monoRepoPkgNameToPath[p.packageJson.name] = p.location));
const pkg = _.find(monorepoPackages, monorepoPackage => {
- return _.includes(monorepoPackage.packageJson.name, packageName);
+ return _.includes(monorepoPackage.packageJson.name, packageNameIfExists);
});
if (_.isUndefined(pkg)) {
- throw new Error(`Couldn't find a package.json for ${packageName}`);
+ throw new Error(`Couldn't find a package.json for ${packageNameIfExists}`);
}
this._packageJson = pkg.packageJson;
this._omitExports = _.get(this._packageJson, 'config.postpublish.omitExports', []);
@@ -191,17 +191,26 @@ export class DocGenerateAndUploadUtils {
}
}
public async generateAndUploadDocsAsync(): Promise<void> {
+ if (!_.isUndefined(this._packageNameIfExists)) {
+ await this.generateAndUploadDocsForPackageAsync(this._packageNameIfExists);
+ } else {
+ for (const packageName of docGenConfigs.PACKAGES_WITH_DOC_PAGES) {
+ await this.generateAndUploadDocsForPackageAsync(packageName);
+ }
+ }
+ }
+ private async generateAndUploadDocsForPackageAsync(packageName: string): Promise<void> {
// For each dep that is another one of our monorepo packages, we fetch it's index.ts
// and see which specific files we must pass to TypeDoc, in order to generate a Doc JSON
// the includes everything exported by the public interface.
- const typeDocExtraFileIncludes: string[] = this._getTypeDocFileIncludesForPackage();
+ const typeDocExtraFileIncludes: string[] = this._getTypeDocFileIncludesForPackage(packageName);
// In order to avoid TS errors, we need to pass TypeDoc the package's global.d.ts file
typeDocExtraFileIncludes.push(path.join(this._packagePath, 'src', 'globals.d.ts'));
const jsonFilePath = path.join(this._packagePath, 'generated_docs', 'index.json');
const projectFiles = typeDocExtraFileIncludes.join(' ');
- const cwd = path.join(constants.monorepoRootPath, 'packages', this._packageName);
+ const cwd = path.join(constants.monorepoRootPath, 'packages', packageName);
// HACK: For some reason calling `typedoc` command directly from here, even with `cwd` set to the
// packages root dir, does not work. It only works when called via a `package.json` script located
// in the package's root.
@@ -211,18 +220,18 @@ export class DocGenerateAndUploadUtils {
const typedocOutputString = readFileSync(jsonFilePath).toString();
const typedocOutput = JSON.parse(typedocOutputString);
- let modifiedTypedocOutput = this._standardizeTypedocOutputTopLevelChildNames(typedocOutput);
- modifiedTypedocOutput = this._pruneTypedocOutput(modifiedTypedocOutput);
+ let modifiedTypedocOutput = this._standardizeTypedocOutputTopLevelChildNames(typedocOutput, packageName);
+ modifiedTypedocOutput = this._pruneTypedocOutput(modifiedTypedocOutput, packageName);
- if (!_.includes(docGenConfigs.TYPES_ONLY_LIBRARIES, this._packageName)) {
- const propertyName = ''; // Root has no property name
+ if (!_.includes(docGenConfigs.TYPES_ONLY_LIBRARIES, packageName)) {
+ const propertyName = ''; // Root has no property name
const referenceNames = DocGenerateAndUploadUtils._getAllReferenceNames(
propertyName,
modifiedTypedocOutput,
[],
);
- this._lookForUnusedExportedTypesThrowIfExists(referenceNames, modifiedTypedocOutput);
- this._lookForMissingReferenceExportsThrowIfExists(referenceNames);
+ this._lookForUnusedExportedTypesThrowIfExists(referenceNames, modifiedTypedocOutput, packageName);
+ this._lookForMissingReferenceExportsThrowIfExists(referenceNames, packageName);
}
// Some of our packages re-export external package exports in their index.ts
@@ -240,9 +249,7 @@ export class DocGenerateAndUploadUtils {
});
if (!_.isEmpty(externalExportsWithoutLinks)) {
throw new Error(
- `Found the following external exports in ${
- this._packageName
- }'s index.ts:\n ${externalExportsWithoutLinks.join(
+ `Found the following external exports in ${packageName}'s index.ts:\n ${externalExportsWithoutLinks.join(
'\n',
)}\nThey are missing from the EXTERNAL_EXPORT_TO_LINK mapping. Add them and try again.`,
);
@@ -250,7 +257,7 @@ export class DocGenerateAndUploadUtils {
const exportPathToTypedocNames: ExportNameToTypedocNames = {};
_.each(modifiedTypedocOutput.children, file => {
- const exportPath = this._findExportPathGivenTypedocName(file.name);
+ const exportPath = this._findExportPathGivenTypedocName(file.name, packageName);
exportPathToTypedocNames[exportPath] = _.isUndefined(exportPathToTypedocNames[exportPath])
? [file.name]
: [...exportPathToTypedocNames[exportPath], file.name];
@@ -271,16 +278,16 @@ export class DocGenerateAndUploadUtils {
writeFileSync(jsonFilePath, JSON.stringify(docJson, null, 2));
if (this._shouldUploadDocs) {
- await this._uploadDocsAsync(jsonFilePath, cwd);
+ await this._uploadDocsAsync(jsonFilePath, cwd, packageName);
}
}
- private async _uploadDocsAsync(jsonFilePath: string, cwd: string) {
+ private async _uploadDocsAsync(jsonFilePath: string, cwd: string, packageName: string) {
const fileName = `v${this._packageJson.version}.json`;
utils.log(`GENERATE_UPLOAD_DOCS: Doc generation successful, uploading docs... as ${fileName}`);
const S3BucketPath = this._isStaging
- ? `s3://staging-doc-jsons/${this._packageName}/`
- : `s3://doc-jsons/${this._packageName}/`;
+ ? `s3://staging-doc-jsons/${packageName}/`
+ : `s3://doc-jsons/${packageName}/`;
const s3Url = `${S3BucketPath}${fileName}`;
await execAsync(
`aws s3 cp ${jsonFilePath} ${s3Url} --profile 0xproject --grants read=uri=http://acs.amazonaws.com/groups/global/AllUsers --content-type application/json`,
@@ -297,7 +304,7 @@ export class DocGenerateAndUploadUtils {
/**
* Look for types that are used by the public interface but are missing from a package's index.ts
*/
- private _lookForMissingReferenceExportsThrowIfExists(referenceNames: string[]): void {
+ private _lookForMissingReferenceExportsThrowIfExists(referenceNames: string[], packageName: string): void {
const allExportedItems = _.flatten(_.values(this._exportPathToExportedItems));
const missingReferences: string[] = [];
_.each(referenceNames, referenceName => {
@@ -310,7 +317,7 @@ export class DocGenerateAndUploadUtils {
});
if (!_.isEmpty(missingReferences)) {
throw new Error(
- `${this._packageName} package needs to export: \n${missingReferences.join(
+ `${packageName} package needs to export: \n${missingReferences.join(
'\n',
)} \nFrom it\'s index.ts. If any are from external dependencies, then add them to the EXTERNAL_TYPE_TO_LINK mapping.`,
);
@@ -319,7 +326,11 @@ export class DocGenerateAndUploadUtils {
/**
* Look for exported types that are not used by the package's public interface
*/
- private _lookForUnusedExportedTypesThrowIfExists(referenceNames: string[], typedocOutput: any): void {
+ private _lookForUnusedExportedTypesThrowIfExists(
+ referenceNames: string[],
+ typedocOutput: any,
+ packageName: string,
+ ): void {
const exportedTypes = DocGenerateAndUploadUtils._getAllTypeNames(typedocOutput, []);
const excessiveReferences = _.difference(exportedTypes, referenceNames);
const excessiveReferencesExceptIgnored = _.difference(
@@ -328,7 +339,7 @@ export class DocGenerateAndUploadUtils {
);
if (!_.isEmpty(excessiveReferencesExceptIgnored)) {
throw new Error(
- `${this._packageName} package exports BUT does not need: \n${excessiveReferencesExceptIgnored.join(
+ `${packageName} package exports BUT does not need: \n${excessiveReferencesExceptIgnored.join(
'\n',
)} \nin it\'s index.ts. Remove them then try again.`,
);
@@ -340,10 +351,10 @@ export class DocGenerateAndUploadUtils {
* - the constructor is to be ignored
* - it begins with an underscore (i.e is private)
*/
- private _pruneTypedocOutput(typedocOutput: any): any {
+ private _pruneTypedocOutput(typedocOutput: any, packageName: string): any {
const modifiedTypedocOutput = _.clone(typedocOutput);
_.each(typedocOutput.children, (file, i) => {
- const exportPath = this._findExportPathGivenTypedocName(file.name);
+ const exportPath = this._findExportPathGivenTypedocName(file.name, packageName);
const exportItems = this._exportPathToExportedItems[exportPath];
_.each(file.children, (child, j) => {
const isNotExported = !_.includes(exportItems, child.name);
@@ -377,12 +388,12 @@ export class DocGenerateAndUploadUtils {
* monorepo). In order to enforce that the names are always prefixed with the package's name, we check and add
* them here when necessary.
*/
- private _standardizeTypedocOutputTopLevelChildNames(typedocOutput: any): any {
+ private _standardizeTypedocOutputTopLevelChildNames(typedocOutput: any, packageName: string): any {
const modifiedTypedocOutput = _.clone(typedocOutput);
_.each(typedocOutput.children, (child, i) => {
if (!_.includes(child.name, '/src/')) {
const nameWithoutQuotes = child.name.replace(/"/g, '');
- const standardizedName = `"${this._packageName}/src/${nameWithoutQuotes}"`;
+ const standardizedName = `"${packageName}/src/${nameWithoutQuotes}"`;
modifiedTypedocOutput.children[i].name = standardizedName;
}
});
@@ -391,13 +402,13 @@ export class DocGenerateAndUploadUtils {
/**
* Maps back each top-level TypeDoc JSON object name to the exportPath from which it was generated.
*/
- private _findExportPathGivenTypedocName(typedocName: string): string {
+ private _findExportPathGivenTypedocName(typedocName: string, packageName: string): string {
const typeDocNameWithoutQuotes = _.replace(typedocName, /"/g, '');
const sanitizedExportPathToExportPath: { [sanitizedName: string]: string } = {};
const exportPaths = _.keys(this._exportPathToExportedItems);
const sanitizedExportPaths = _.map(exportPaths, exportPath => {
if (_.startsWith(exportPath, './')) {
- const sanitizedExportPath = path.join(this._packageName, 'src', exportPath);
+ const sanitizedExportPath = path.join(packageName, 'src', exportPath);
sanitizedExportPathToExportPath[sanitizedExportPath] = exportPath;
return sanitizedExportPath;
}
@@ -438,7 +449,7 @@ export class DocGenerateAndUploadUtils {
});
return externalExports;
}
- private _getTypeDocFileIncludesForPackage(): string[] {
+ private _getTypeDocFileIncludesForPackage(packageName: string): string[] {
let typeDocExtraFileIncludes: string[] = [];
_.each(this._exportPathToExportedItems, (exportedItems, exportPath) => {
const isInternalToPkg = _.startsWith(exportPath, '.');
@@ -464,9 +475,7 @@ export class DocGenerateAndUploadUtils {
}
if (!_.startsWith(innerExportPath, './')) {
throw new Error(
- `GENERATE_UPLOAD_DOCS: WARNING - ${
- this._packageName
- } is exporting one of ${innerExportItems} which is
+ `GENERATE_UPLOAD_DOCS: WARNING - ${packageName} is exporting one of ${innerExportItems} which is
itself exported from an external package. To fix this, export the external dependency directly,
not indirectly through ${innerExportPath}.`,
);