Repository navigation
feat: export test documentation schemas from package root - #77
Open
ryanduguid wants to merge 1 commit into
Open
ryanduguid wants to merge 1 commit into
ryanduguid wants to merge 1 commit into
Conversation
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Schema types in
@cds-au/testdocscurrently require imports through internaldistpaths. This exports the existing test-documentation and changelog types, plustestDocSchemaandchangeLogSchema, from the package root. Existing deep imports, validators and document generators remain available. No schema definitions, dependencies or package layout change.The README includes TypeScript and JavaScript examples and a packed-package check. This addresses the import usability concern in #56 through the existing entry point; it does not relocate the published package root.
Verification:
node node_modules/typescript/bin/tsc).npm packtarball in a separate consumer directory.node test/package-imports.js <consumer>passed on Windows with Node 18.20.8 and 24.19.0: public types, invalid typed input, legacy type imports, runtime schema contents, existing API exports and CLI help.git diff --checkpassed.Existing verification blockers, observed before the change:
npm run buildcompiles successfully, then fails becausecopy-additionaltries to copy the absentcli/config.json.npm run lintfails becausetslintis not installed or declared in the package manifest.Full documentation generation and Linux execution were not verified. The package has no existing test script; the new check uses the installed TypeScript compiler and Node's standard library.