truffle icon indicating copy to clipboard operation
truffle copied to clipboard

Typedoc missing on numerous types in @truffle/db

Open benjamincburns opened this issue 3 years ago • 1 comments

When I run [email protected] in the @truffle/db package, it gives me the following warnings.

Note that these are valid warnings, but to avoid dropping a pile of new warnings into the db build, I've disabled these warnings in #5423. As a result, please be sure to remove the validation: { notExported: false } config from the typedoc config in packages/truffle/db/typedoc.js on completion of this ticket.

Warning: CollectionProperty, defined at src/meta/collections.ts:57, is referenced by Meta.IdFields but not included in the documentation.
Warning: FilteredCollectionName, defined at src/meta/collections.ts:112, is referenced by Meta.MutableCollectionName but not included in the documentation.
Warning: ResourceFilter, defined at src/meta/collections.ts:77, is referenced by Meta.Resource but not included in the documentation.
Warning: Collection, defined at src/meta/collections.ts:34, is referenced by Meta.Resource but not included in the documentation.
Warning: Structure, defined at src/meta/batch.ts:162, is referenced by Meta.Batch.Inputs but not included in the documentation.
Warning: IdField, defined at src/meta/id/types.ts:10, is referenced by Meta.Id.StrictIdInput but not included in the documentation.
Warning: CollectionMutation, defined at src/meta/process/types.ts:165, is referenced by Meta.Process.Mutation but not included in the documentation.
Warning: ProcessResponse, defined at src/meta/process/types.ts:88, is referenced by Meta.Process.Process but not included in the documentation.
Warning: GraphQlRequest, defined at src/meta/process/types.ts:65, is referenced by Meta.Process.ProcessRequest but not included in the documentation.
Warning: Web3Request, defined at src/meta/process/types.ts:73, is referenced by Meta.Process.ProcessRequest but not included in the documentation.
Warning: CollectionQuery, defined at src/meta/process/types.ts:132, is referenced by Meta.Process.Query but not included in the documentation.
Warning: GraphQlRequestType, defined at src/meta/process/types.ts:36, is referenced by Meta.Process.RequestType but not included in the documentation.
Warning: Web3RequestType, defined at src/meta/process/types.ts:43, is referenced by Meta.Process.RequestType but not included in the documentation.
Warning: Common.Compilation, defined at ../compile-common/dist/src/types.d.ts:2, is referenced by Project.LoadCompile.Compilation but not included in the documentation.
Warning: Common.CompiledContract, defined at ../compile-common/dist/src/types.d.ts:49, is referenced by Project.LoadCompile.Contract but not included in the documentation.
Warning: Common.Source, defined at ../compile-common/dist/src/types.d.ts:12, is referenced by Project.LoadCompile.Source but not included in the documentation.
Warning: MutationPayload, defined at src/meta/collections.ts:142, is referenced by Meta.Workspace.add.add but not included in the documentation.
Warning: NetworkResource, defined at src/network/index.ts:34, is referenced by Network.Network.genesis.genesis but not included in the documentation.
Warning: Process, defined at src/process.ts:23, is referenced by Project.AssignNames.process.process but not included in the documentation.
Warning: ContractObject, defined at ../contract-schema/spec/index.d.ts:75, is referenced by Project.LoadMigrate.Batch.Artifact but not included in the documentation.
Warning: NetworkObject, defined at ../contract-schema/spec/index.d.ts:153, is referenced by Project.LoadMigrate.Batch.ArtifactNetwork but not included in the documentation.
Warning: CollectionNameStyle, defined at src/meta/collections.ts:63, is referenced by Meta.Graph.Definition.__type.names but not included in the documentation.
Warning: CollectionNameStyledAs, defined at src/meta/collections.ts:71, is referenced by Meta.Graph.Definition.__type.names but not included in the documentation.
Warning: SavedRecord, defined at src/meta/pouch/types.ts:21, is referenced by Meta.Pouch.Adapter.every.every but not included in the documentation.
Warning: MutationInput, defined at src/meta/collections.ts:135, is referenced by Meta.Workspace.add.add.input but not included in the documentation.
Warning: WorkflowCompileResult, defined at ../compile-common/dist/src/types.d.ts:72, is referenced by Project.LoadCompile.process.process.result but not included in the documentation.
Warning: Processor, defined at src/process.ts:31, is referenced by Project.ConnectedProject.run.run.processor but not included in the documentation.
Warning: RequestType, defined at src/process.ts:40, is referenced by Project.ConnectedProject.run.run.R but not included in the documentation.
Warning: Entry, defined at src/meta/batch.ts:172, is referenced by Meta.Batch.Options.__type.extract.extract but not included in the documentation.
Warning: Results, defined at src/meta/batch.ts:182, is referenced by Meta.Batch.Options.__type.process.process but not included in the documentation.
Warning: CollectionDatabases, defined at src/meta/pouch/adapters/base.ts:247, is referenced by Meta.Pouch.Adapters.Base.Databases.collections but not included in the documentation.
Warning: RecordReference, defined at src/meta/pouch/types.ts:26, is referenced by Meta.Pouch.Adapter.delete.delete.references but not included in the documentation.
Warning: Record, defined at src/meta/pouch/types.ts:16, is referenced by Meta.Pouch.Adapter.save.save.records but not included in the documentation.
Warning: Breadcrumb, defined at src/meta/batch.ts:164, is referenced by Meta.Batch.Options.__type.iterate.iterate.__type.breadcrumb but not included in the documentation.
Warning: Contract, defined at src/project/loadCompile/compilations.ts:14, is referenced by Project.LoadCompile.AddCompilations.process.__type.contract but not included in the documentation.
Warning: Source, defined at src/project/loadCompile/compilations.ts:28, is referenced by Project.LoadCompile.AddCompilations.process.__type.source but not included in the documentation.
Warning: Result, defined at src/meta/batch.ts:181, is referenced by Meta.Batch.Options.__type.convert.convert.options.__type.result but not included in the documentation.
Warning: Entries, defined at src/meta/batch.ts:173, is referenced by Meta.Batch.Options.__type.process.process.options.__type.entries but not included in the documentation

benjamincburns avatar Aug 10 '22 13:08 benjamincburns

Hm, since merging #6070, we no longer get these warnings. Of course that doesn't mean we don't want to address this even so!

haltman-at avatar Jun 05 '23 21:06 haltman-at