aboutsummaryrefslogtreecommitdiffstats
path: root/packages
diff options
context:
space:
mode:
authorFabio Berger <me@fabioberger.com>2018-08-22 00:16:00 +0800
committerFabio Berger <me@fabioberger.com>2018-08-22 00:16:00 +0800
commita7468eb858bc730d4b7ca92260314cfa0c51416b (patch)
tree01646317ef72cc0242cc060e86879203debfd7a9 /packages
parent7553411fb2c0483e08046a85cc3b694e2063cbfd (diff)
downloaddexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.tar
dexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.tar.gz
dexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.tar.bz2
dexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.tar.lz
dexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.tar.xz
dexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.tar.zst
dexon-0x-contracts-a7468eb858bc730d4b7ca92260314cfa0c51416b.zip
Don't check if types are used for libraries only include types
Diffstat (limited to 'packages')
-rw-r--r--packages/monorepo-scripts/src/doc_gen_configs.ts3
-rw-r--r--packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts8
2 files changed, 10 insertions, 1 deletions
diff --git a/packages/monorepo-scripts/src/doc_gen_configs.ts b/packages/monorepo-scripts/src/doc_gen_configs.ts
index 83fae1e7c..52cbc4f59 100644
--- a/packages/monorepo-scripts/src/doc_gen_configs.ts
+++ b/packages/monorepo-scripts/src/doc_gen_configs.ts
@@ -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'],
};
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 adb898628..cc4d70d63 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
@@ -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