crowetic/protocol
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Don't check if types are used for libraries only include types

Browse Source
This commit is contained in:
Fabio Berger
2018-08-21 17:16:00 +01:00
parent 7553411fb2
commit a7468eb858
2 changed files with 10 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
packages/monorepo-scripts/src/doc_gen_configs.ts
View File

@@ -38,4 +38,7 @@ export const docGenConfigs: DocGenConfigs = {
// want them exported. E.g error enum types that can be thrown by methods. These must be manually added to this
// config
IGNORED_EXCESSIVE_TYPES: ['NonceSubproviderErrors', 'Web3WrapperErrors', 'ContractWrappersError', 'OrderError'],
// Some libraries only export types. In those cases, we cannot check if the exported types are part of the
// "exported public interface". Thus we add them here and skip those checks.
TYPES_ONLY_LIBRARIES: ['ethereum-types', 'types'],
};

8
packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts
View File

@@ -212,10 +212,16 @@ export class DocGenerateAndUploadUtils {
let modifiedTypedocOutput = this._standardizeTypedocOutputTopLevelChildNames(typedocOutput);
modifiedTypedocOutput = this._pruneTypedocOutput(modifiedTypedocOutput);
if (!_.includes(docGenConfigs.TYPES_ONLY_LIBRARIES, this._packageName)) {
const propertyName = ''; // Root has no property name
const referenceNames = DocGenerateAndUploadUtils._getAllReferenceNames(propertyName, modifiedTypedocOutput, []);
const referenceNames = DocGenerateAndUploadUtils._getAllReferenceNames(
propertyName,
modifiedTypedocOutput,
[],
);
this._lookForUnusedExportedTypesThrowIfExists(referenceNames, modifiedTypedocOutput);
this._lookForMissingReferenceExportsThrowIfExists(referenceNames);
}
// Some of our packages re-export external package exports in their index.ts
// Typedoc is incapable of rendering these packages, so we need to special-case them