feat: replace ts-prune with knip #174

webpro · 2023-01-08T01:02:25Z

Noticed the other day (from release-it/release-it#964) that this repo might benefit from Knip, so here I am introducing Knip to find unused files, dependencies and exports.

Docs: https://github.com/webpro/knip/blob/next/README.md. Knip v1 is almost out, this PR holds v1.0.0-beta.9 but the API shouldn't change anymore, so that should not affect this PR.

Some remarks for now:

In the dependency department, there are still a few false positives that will sort themselves out with new plugins for vitest and npm-package-json-lint
It does look like yargs is unused and can be removed?
Seems like knip and ts-prune agree about there being no unused exports... Obviously it's up to you what to do with this.

Would you be interested at all in having Knip in this repo? Happy to answer any questions or feedback you might have.

Fixes #192

JoshuaKGoldberg · 2023-01-08T18:29:25Z

.eslintrc.cjs

@@ -12,7 +12,7 @@ module.exports = {
 	overrides: [
 		{
 			extends: ["plugin:markdown/recommended"],
-			files: ["**/*.{md}"],
+			files: ["**/*.md"],


Heh, nice catch. If you can pull this out into a separate PR I'd be happy to pull it in quickly.

Hmm, this is probably what's causing https://github.com/JoshuaKGoldberg/template-typescript-node-package/actions/runs/3943867603/jobs/6749189690:

/home/runner/work/template-typescript-node-package/template-typescript-node-package/README.md 96:1 error Parsing error: ESLint was configured to run on `<tsconfigRootDir>/README.md/2_2.ts` using `parserOptions.project`: <tsconfigRootDir>/tsconfig.eslint.json

Should probably split this out into a separate issue & PR. I can take a look at this too if you don't have time. ❤️

Maybe it's convenient to leave it in this PR? Eventually it's caused by different backing glob parsers (in ESLint and Knip), but necessary for green lights in this PR.

codecov-commenter · 2023-01-08T18:29:27Z

Codecov Report

Merging #174 (d3da106) into main (f25d5a8) will not change coverage.
The diff coverage is n/a.

❗ Current head d3da106 differs from pull request most recent head aca704b. Consider uploading reports for the commit aca704b to get more accurate results

@@            Coverage Diff            @@
##              main      #174   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines            6         6           
  Branches         3         3           
=========================================
  Hits             6         6

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

JoshuaKGoldberg

Hey again @webpro! Nice to see a tool getting worked on that can holistically tackle unused code/dependency detection. I'm up for trying it out! Especially since it's already spotted yargs as an unnecessary dependency. 😄

But, a few blockers:

There shouldn't be any false positives
Let's get it running in CI with a GitHub Action
You'll want to remove ts-prune in this PR too, since it'll now be redundant
The dependency on an explicit esbuild version

pnpm-lock.yaml

package.json

webpro · 2023-01-09T09:26:31Z

Hey again @webpro! Nice to see a tool getting worked on that can holistically tackle unused code/dependency detection. I'm up for trying it out! Especially since it's already spotted yargs as an unnecessary dependency. 😄

Great, happy to hear you are interested!

But, a few blockers:

There shouldn't be any false positives

Let's get it running in CI with a GitHub Action

You'll want to remove ts-prune in this PR too, since it'll now be redundant

The dependency on an explicit esbuild version

Things are sorted out, except for the esbuild dependency, since Knip needs to require/import configuration files.

webpro · 2023-01-09T14:32:21Z

Just saw that markdownlint is now also unused as Knip also requires a custom dependency resolver to find it in extends.

Also enabled production mode:

$ knip --production
Unused exports in namespaces (1)
greet  src/greet.ts

If interested, read more at https://github.com/webpro/knip/tree/next#production-mode

package.json

JoshuaKGoldberg

Ok this is looking great, thanks @webpro! I looked at this more closely and think this is the last list of things to request:

ts-prune is still referenced in the README.md. It should be replaced with knip.
- Would you like the honors of writing the marketing text for it? 😁
knip.jsonc references the setup/ directory. But the setup script removes that directory. The setup script should be augmented to change knip.jsonc to no longer reference setup/

Do you have time to make these changes? Absolutely no worries if not, I should Soon ™️ 🙂

webpro · 2023-01-18T07:15:18Z

Ok this is looking great, thanks @webpro! I looked at this more closely and think this is the last list of things to request:

ts-prune is still referenced in the README.md. It should be replaced with knip.

Would you like the honors of writing the marketing text for it? 😁

Done :)

knip.jsonc references the setup/ directory. But the setup script removes that directory. The setup script should be augmented to change knip.jsonc to no longer reference setup/

The entry files reference the two script/setup*.js files, is that not correct?

Do you have time to make these changes? Absolutely no worries if not, I should Soon ™️ 🙂

Sure, just pushed the changes.

JoshuaKGoldberg · 2023-01-19T00:08:23Z

The entry files reference the two script/setup*.js files, is that not correct?

...sort of!

In more detail: the repo contains a script/ folder that includes a setup.js file. That file is meant to be run (pnpm run setup) when someone forks the template. "Setup" here refers to assorted repo tasks such as renaming to their repo name, populating GitHub labels, etc.

The setup script is also meant to remove the setup/ directory and any references to setup scripts. Which it should because there's no need to keep that directory around once a repo has been set up! So, anything referring to the setup/ directory should be removed as a part of script/setup.js

Does that all sound reasonable to you? (This repo is still new and I'm still learning how to document+explain it!)

webpro · 2023-01-19T10:51:12Z

Ah, that makes sense. I've now actually ran the setup. You may want to remove the chalk dependency then, too, Knip thinks it's no longer in use after running the setup :)

Ideally, the script entries in knip.jsonc are removed during setup? So that the setup*.js files are still linted before that.

JoshuaKGoldberg · 2023-01-19T15:49:02Z

remove the chalk dependency then, too

Another win for Knip! 😄 #193

Ideally, the script entries in knip.jsonc are removed during setup? So that the setup*.js files are still linted before that.

Yes!

webpro · 2023-01-19T17:19:41Z

Alright, I prefer to leave the rest of the project-specific things and scripts to you. Let's get this PR merged?

JoshuaKGoldberg · 2023-01-19T17:23:47Z

JoshuaKGoldberg

🚀

webpro · 2023-01-22T02:24:09Z

Nice!

JoshuaKGoldberg · 2023-01-27T11:39:46Z

@allcontributors add @webpro for feature tooling

allcontributors · 2023-01-27T11:39:55Z

@JoshuaKGoldberg

I've put up a pull request to add @webpro! 🎉

JoshuaKGoldberg reviewed Jan 8, 2023

View reviewed changes

JoshuaKGoldberg requested changes Jan 8, 2023

View reviewed changes

pnpm-lock.yaml Outdated Show resolved Hide resolved

package.json Show resolved Hide resolved

JoshuaKGoldberg mentioned this pull request Jan 8, 2023

Suggestion: a more explanatory name? webpro/knip#38

Closed

webpro added 5 commits January 9, 2023 10:20

chore: add knip + config

cb7a31d

chore: simplify glob pattern for eslint markdown override

b4dabe0

chore: remove ts-prune & replace workflow

c746909

chore: add dependencies to ignore (until Knip has related plugins)

28e2343

chore: remove unused yargs package

027b74e

webpro force-pushed the feature/introduce-knip branch from c8b891f to 027b74e Compare January 9, 2023 09:24

webpro added 2 commits January 9, 2023 15:29

chore: add markdownlint to ignored dependencies

a57d831

chore: enable production mode in knip's config

e97cf85

JoshuaKGoldberg added 2 commits January 17, 2023 15:56

Merge branch 'main'

bea9307

Sorting, and removed yargs

44a4b84

JoshuaKGoldberg mentioned this pull request Jan 17, 2023

🚀 Feature: Replace ts-prune with Knip #192

Closed

3 tasks

JoshuaKGoldberg reviewed Jan 17, 2023

View reviewed changes

package.json Show resolved Hide resolved

JoshuaKGoldberg requested changes Jan 17, 2023

View reviewed changes

JoshuaKGoldberg added the status: waiting for author Needs an action taken by the original poster label Jan 17, 2023

JoshuaKGoldberg and others added 3 commits January 17, 2023 16:33

Add knip to cspell.json

0b98b1c

chore: remove dependencies now having plugins in Knip config

89e69fd

docs: replace ts-prune with knip

74fd751

JoshuaKGoldberg mentioned this pull request Jan 19, 2023

🐛 Bug: Setup script should also uninstall chalk #193

Closed

3 tasks

JoshuaKGoldberg added 3 commits January 20, 2023 10:50

Fix lint

82564e3

Updated docs and setup script

52173f6

Bump knip and ignore eslint-plugin-markdown

d3da106

JoshuaKGoldberg removed the status: waiting for author Needs an action taken by the original poster label Jan 20, 2023

Simplify output knip.jsonc

aca704b

JoshuaKGoldberg approved these changes Jan 20, 2023

View reviewed changes

JoshuaKGoldberg changed the title ~~chore: introduce knip~~ feat: introduce knip Jan 20, 2023

JoshuaKGoldberg changed the title ~~feat: introduce knip~~ feat: replace ts-prune with knip Jan 20, 2023

JoshuaKGoldberg merged commit c652bda into JoshuaKGoldberg:main Jan 20, 2023

webpro deleted the feature/introduce-knip branch January 22, 2023 02:24

allcontributors bot mentioned this pull request Jan 27, 2023

docs: add webpro as a contributor for tool #207

Merged

Repository owner deleted a comment from allcontributors bot Jan 27, 2023

JoshuaKGoldberg mentioned this pull request Jan 27, 2023

🛠 Tooling: Simplify ESLint markdown glob / figure out .md vs .ts file path resolutions #208

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: replace ts-prune with knip #174

feat: replace ts-prune with knip #174

webpro commented Jan 8, 2023 •

edited by JoshuaKGoldberg

JoshuaKGoldberg Jan 8, 2023

JoshuaKGoldberg Jan 17, 2023

webpro Jan 18, 2023

codecov-commenter commented Jan 8, 2023 •

edited

JoshuaKGoldberg left a comment

webpro commented Jan 9, 2023

webpro commented Jan 9, 2023

JoshuaKGoldberg left a comment •

edited

webpro commented Jan 18, 2023

JoshuaKGoldberg commented Jan 19, 2023

webpro commented Jan 19, 2023 •

edited

JoshuaKGoldberg commented Jan 19, 2023

webpro commented Jan 19, 2023

JoshuaKGoldberg commented Jan 19, 2023

JoshuaKGoldberg left a comment

webpro commented Jan 22, 2023

JoshuaKGoldberg commented Jan 27, 2023

allcontributors bot commented Jan 27, 2023

feat: replace ts-prune with knip #174

feat: replace ts-prune with knip #174

Conversation

webpro commented Jan 8, 2023 • edited by JoshuaKGoldberg

JoshuaKGoldberg Jan 8, 2023

Choose a reason for hiding this comment

JoshuaKGoldberg Jan 17, 2023

Choose a reason for hiding this comment

webpro Jan 18, 2023

Choose a reason for hiding this comment

codecov-commenter commented Jan 8, 2023 • edited

Codecov Report

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

webpro commented Jan 9, 2023

webpro commented Jan 9, 2023

JoshuaKGoldberg left a comment • edited

Choose a reason for hiding this comment

webpro commented Jan 18, 2023

JoshuaKGoldberg commented Jan 19, 2023

webpro commented Jan 19, 2023 • edited

JoshuaKGoldberg commented Jan 19, 2023

webpro commented Jan 19, 2023

JoshuaKGoldberg commented Jan 19, 2023

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

webpro commented Jan 22, 2023

JoshuaKGoldberg commented Jan 27, 2023

allcontributors bot commented Jan 27, 2023

webpro commented Jan 8, 2023 •

edited by JoshuaKGoldberg

codecov-commenter commented Jan 8, 2023 •

edited

JoshuaKGoldberg left a comment •

edited

webpro commented Jan 19, 2023 •

edited