diff options
author | Fabio Berger <me@fabioberger.com> | 2018-08-07 03:27:28 +0800 |
---|---|---|
committer | Fabio Berger <me@fabioberger.com> | 2018-08-07 03:27:28 +0800 |
commit | fdcb42d8e17f4f5f324dd644077a07cbd4be65c7 (patch) | |
tree | 246241c4cfbdc7167063d76a2f2f8d176fe0bce0 /packages | |
parent | 4e6322beb55302e10770c4e16bf480e17bbf27e9 (diff) | |
download | dexon-0x-contracts-fdcb42d8e17f4f5f324dd644077a07cbd4be65c7.tar.gz dexon-0x-contracts-fdcb42d8e17f4f5f324dd644077a07cbd4be65c7.tar.zst dexon-0x-contracts-fdcb42d8e17f4f5f324dd644077a07cbd4be65c7.zip |
Fix bug where we only rendered one TypeDoc JSON key per export, instead of all of them
Diffstat (limited to 'packages')
-rw-r--r-- | packages/monorepo-scripts/src/utils/publish_utils.ts | 14 | ||||
-rw-r--r-- | packages/react-docs/src/utils/typedoc_utils.ts | 11 |
2 files changed, 15 insertions, 10 deletions
diff --git a/packages/monorepo-scripts/src/utils/publish_utils.ts b/packages/monorepo-scripts/src/utils/publish_utils.ts index 2cf67946b..709a48799 100644 --- a/packages/monorepo-scripts/src/utils/publish_utils.ts +++ b/packages/monorepo-scripts/src/utils/publish_utils.ts @@ -18,12 +18,12 @@ interface ExportInfo { exportPathOrder: string[]; } -interface ExportNameToTypedocName { - [exportName: string]: string; +interface ExportNameToTypedocNames { + [exportName: string]: string[]; } interface Metadata { - exportPathToTypedocName: ExportNameToTypedocName; + exportPathToTypedocNames: ExportNameToTypedocNames; exportPathOrder: string[]; } @@ -224,10 +224,12 @@ export async function generateAndUploadDocsAsync(packageName: string, isStaging: }); // For each entry, see if it was exported in index.ts. If not, remove it. - const exportPathToTypedocName: ExportNameToTypedocName = {}; + const exportPathToTypedocNames: ExportNameToTypedocNames = {}; _.each(typedocOutput.children, (file, i) => { const exportPath = findExportPathGivenTypedocName(exportPathToExportedItems, packageName, file.name); - exportPathToTypedocName[exportPath] = file.name; + exportPathToTypedocNames[exportPath] = _.isUndefined(exportPathToTypedocNames[exportPath]) + ? [file.name] + : [...exportPathToTypedocNames[exportPath], file.name]; const exportItems = exportPathToExportedItems[exportPath]; _.each(file.children, (child, j) => { @@ -245,7 +247,7 @@ export async function generateAndUploadDocsAsync(packageName: string, isStaging: // Since we need additional metadata included in the doc JSON, we nest the TypeDoc JSON const docJson = { metadata: { - exportPathToTypedocName, + exportPathToTypedocNames, exportPathOrder, }, typedocJson: finalTypeDocOutput, diff --git a/packages/react-docs/src/utils/typedoc_utils.ts b/packages/react-docs/src/utils/typedoc_utils.ts index 01385c982..9ee1de2b4 100644 --- a/packages/react-docs/src/utils/typedoc_utils.ts +++ b/packages/react-docs/src/utils/typedoc_utils.ts @@ -60,14 +60,16 @@ export const typeDocUtils = { }, convertToDocAgnosticFormat(generatedDocJson: GeneratedDocJson, docsInfo: DocsInfo): DocAgnosticFormat { const exportPathOrder = generatedDocJson.metadata.exportPathOrder; - const exportPathToTypedocName = generatedDocJson.metadata.exportPathToTypedocName; + const exportPathToTypedocNames = generatedDocJson.metadata.exportPathToTypedocNames; const typeDocJson = generatedDocJson.typedocJson; // TODO: Extract the non typeDoc exports, and render them somehow const typeDocNameOrder = _.compact( - _.map(exportPathOrder, exportPath => { - return exportPathToTypedocName[exportPath]; - }), + _.flatten( + _.map(exportPathOrder, exportPath => { + return exportPathToTypedocNames[exportPath]; + }), + ), ); const docAgnosticFormat: DocAgnosticFormat = {}; @@ -121,6 +123,7 @@ export const typeDocUtils = { }); }); if (!_.isEmpty(typeEntities)) { + console.log('typeEntities', typeEntities); docsInfo.sections[constants.TYPES_SECTION_NAME] = constants.TYPES_SECTION_NAME; docsInfo.menu[constants.TYPES_SECTION_NAME] = [constants.TYPES_SECTION_NAME]; const docSection = typeDocUtils._convertEntitiesToDocSection( |