chore: update knip config

[RebeccaStevens]

PR Checklist

• Addresses an existing open issue
• That issue was marked as status: accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

When not in production mode, entry files should include test files.
When in production mode, project files should not include test files.

[RebeccaStevens]

Using this config, knip pass in #33 with flag --production. It still fails when not running in production mode.

[JoshuaKGoldberg]

Marking this as blocked on resolving discussion in webpro-nl/knip#62 - in case it ends up impacting us here.

[webpro]

Just saying, in the meantime you could add the specific files as entry files to unblock this

[codecov]

Codecov Report

Merging #40 (418eae9) into main (591db49) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #40   +/-   ##
=======================================
  Coverage   19.74%   19.74%           
=======================================
  Files          15       15           
  Lines         395      395           
  Branches      161      161           
=======================================
  Hits           78       78           
  Misses        299      299           
  Partials       18       18           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[RebeccaStevens]

in the meantime you could add the specific files as entry files

Just made this change.

I also made it so that knip is called in the ci both with and without --production.

[JoshuaKGoldberg]

Requesting changes only in that I'd like to see how to make lint:knip:production fail, the code LGTM!

[RebeccaStevens]

I'd like to see how to make lint:knip:production fail

If you make a new file (src/foo.ts) and put an export in it (export const foo = 1), both the version of knip will report this unused exported. If you then create a test file for that file (stc/foo.test.ts) and import the export (import { foo } from "./foo"), now only the production version of knip will fail.

At least that's how it should work. I did some testing though and it seems like something with the glob patterns isn't work as expected. I'll look into this. - Push a fix for this. Issue was cause by unexpected default glob pattern being added to our defined ones.

[RebeccaStevens]

@webpro It doesn't seem to currently be possible to use a single config file for our use case.

Essentially, we want this config, but with the comment addressed.

{
	"$schema": "https://unpkg.com/knip@next/schema.json",
	"entry": ["src/**/index.ts!", "src/**/*.test.ts"],
	"project": [
		"src/**/*.ts!",
		"!src/test/**/*.ts!", // <-- We want these "not" globs to only apply in production mode.
		"!src/**/*.test.ts!"  // <-- Using a separate production specific config seems to be the only way to currently achieve this.
	]
}

When using config that runs logic (e.g. knip.ts), it would be great if we could access a isProduction variable.

[webpro]

Sorry for the late reply, but somehow today this popped up in the back of my mind. Any chance you could give it a shot with the latest Knip v1? I think you don't need any configuration anymore for either dev or production mode :)

[webpro]

Ah scratch that, it's almost true, you would still need to add **/index.ts as entry files (as that is fixed only in v2).

[JoshuaKGoldberg]

💯 thanks!

Whenever you're happy to merge, let's do it!