feat(monorepo-scripts): add AssetBuyerError to IGNORED_EXCESSIVE_TYPES

This commit is contained in:
Brandon Millman
2018-10-15 10:51:38 -07:00
parent 4976b34738
commit 2c286ad897
3 changed files with 16 additions and 2 deletions

View File

@@ -1,4 +1,12 @@
[
{
"version": "1.0.6",
"changes": [
{
"note": "Add AssetBuyerError to the IGNORED_EXCESSIVE_TYPES array"
}
]
},
{
"timestamp": 1534210131,
"version": "1.0.5",

View File

@@ -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'],

View File

@@ -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.`,
);
}
}