Facing Error: Assembly "@custom-cdk-constructs/base-pipeline" not found
- Dominant language
- TypeScript
- Stars
- 55
- Forks
- 18
- Avg merge
- 53m
- Merged PRs (30d)
- 5
Description
Currently we are exploring a way to generate documentation for our custom CDK construct.
We have created custom CDK contruct using following command
`npx cdk init lib --language=typescript`
and we tried to execute
`npx jsii-docgen`
And we faced following issue any help over here will be great.
`Error: Assembly "@custom-cdk-constructs/base-pipeline" not found
at TypeSystem.findAssembly (C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-reflect\lib\type-system.js:147:19)
at C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-docgen\lib\docgen\view\documentation.js:235:23
at async withTempDir (C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-docgen\lib\docgen\view\documentation.js:271:16)
at async Documentation.createAssembly (C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-docgen\lib\docgen\view\documentation.js:212:25)
at async Documentation.toJson (C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-docgen\lib\docgen\view\documentation.js:125:28)
at async Documentation.toMarkdown (C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-docgen\lib\docgen\view\documentation.js:170:23)
at async main (C:\Users\masked\AppData\Local\npm-cache\_npx\6d618b10e1acde92\node_modules\jsii-docgen\lib\cli.js:51:21)`
Do we need to do anything additional on our newly created construct apart from executing `npx jsii-docgen`
Contributor guide
Research direction
Start with the npx jsii-docgen invocation and trace the reported failure through jsii-reflect/lib/type-system.js, jsii-docgen/lib/docgen/view/documentation.js, and lib/cli.js. Determine what setup or input is required for the custom assembly, then document the required steps or make the command handle this case; done means the reported construct can be processed without the assembly-not-found error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, tooling
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100