aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrandon Millman <brandon.millman@gmail.com>2018-10-16 01:51:38 +0800
committerBrandon Millman <brandon.millman@gmail.com>2018-10-17 01:00:49 +0800
commit2c286ad897d7ae9f2dcc48919033fb0d1c026641 (patch)
treea0edc594b31df5316c3f5924bcc0a36c454540cf
parent4976b3473893befeb538c57ca6f8010722addd07 (diff)
downloaddexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.tar
dexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.tar.gz
dexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.tar.bz2
dexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.tar.lz
dexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.tar.xz
dexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.tar.zst
dexon-sol-tools-2c286ad897d7ae9f2dcc48919033fb0d1c026641.zip
feat(monorepo-scripts): add AssetBuyerError to IGNORED_EXCESSIVE_TYPES
-rw-r--r--packages/monorepo-scripts/CHANGELOG.json8
-rw-r--r--packages/monorepo-scripts/src/doc_gen_configs.ts8
-rw-r--r--packages/monorepo-scripts/src/utils/doc_generate_and_upload_utils.ts2
3 files changed, 16 insertions, 2 deletions
diff --git a/packages/monorepo-scripts/CHANGELOG.json b/packages/monorepo-scripts/CHANGELOG.json
index 3b8684fab..4fd87c1d8 100644
--- a/packages/monorepo-scripts/CHANGELOG.json
+++ b/packages/monorepo-scripts/CHANGELOG.json
@@ -1,5 +1,13 @@
[
{
+ "version": "1.0.6",
+ "changes": [
+ {
+ "note": "Add AssetBuyerError to the IGNORED_EXCESSIVE_TYPES array"
+ }
+ ]
+ },
+ {
"timestamp": 1534210131,
"version": "1.0.5",
"changes": [
diff --git a/packages/monorepo-scripts/src/doc_gen_configs.ts b/packages/monorepo-scripts/src/doc_gen_configs.ts
index e3ddeddc9..3d5c97dc4 100644
--- a/packages/monorepo-scripts/src/doc_gen_configs.ts
+++ b/packages/monorepo-scripts/src/doc_gen_configs.ts
@@ -43,7 +43,13 @@ export const docGenConfigs: DocGenConfigs = {
// Some types are not explicitly part of the public interface like params, return values, etc... But we still
// 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'],
+ IGNORED_EXCESSIVE_TYPES: [
+ 'NonceSubproviderErrors',
+ 'Web3WrapperErrors',
+ 'ContractWrappersError',
+ 'OrderError',
+ 'AssetBuyerError',
+ ],
// 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 4fea94414..547b65eeb 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
@@ -331,7 +331,7 @@ export class DocGenerateAndUploadUtils {
throw new Error(
`${this._packageName} package exports BUT does not need: \n${excessiveReferencesExceptIgnored.join(
'\n',
- )} \nin it\'s index.ts. Remove them then try again.`,
+ )} \nin it\'s index.ts. Remove them then try again OR if we still want them exported (e.g error enum types), then add them to the IGNORED_EXCESSIVE_TYPES array.`,
);
}
}