Expose defineConfig on a ./config entrypoint - #1960
Merged
Merged
Conversation
Member
|
Thanks Rizwan, and everyone involved! Nice teamwork y'all 🫶 |
Member
|
🚀 This pull request is included in v6.33.0. See Release 6.33.0 for release notes. Using Knip in a commercial project? Please consider becoming a sponsor. |
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.
Closes #1941
Adds a
defineConfighelper on a separate./configentrypoint, following @iiroj's suggestion in the issue.A separate entrypoint keeps the helper and its type resolving through one specifier, so the existing
.map stays as it is and nothing new gets pulled in from the index file when a config is loaded../sessionwas already the precedent for a second entrypoint, so the shape matches that.The helper returns its argument unchanged, so it is types only at runtime.
KnipConfigisRawConfiguration | ((options: ParsedCLIArgs) => RawConfiguration | Promise<RawConfiguration>), so both the object form and the sync and async function forms already documented on the Dynamic Configuration page go through it without a second overload.Checked before opening:
pnpm knipandpnpm knip:production --strictboth run clean on this repo, so the new export is picked up as an entry through the exports map rather than reported as unusedknip/configundermoduleResolution: nodenext. Object form and async function form both pass,entry: 42fails with the underlyingstring | string[] | undefined, so the type is coming through the emitted declaration and not being widenednpm packincludesdist/config.jsanddist/config.d.tspnpm run cicleanDocs section added to Dynamic Configuration. Happy to drop the docs or the whole thing if you would rather keep the config typed with
satisfies KnipConfig.