Build: Use Knip for project linting #29111
Merged
Conversation
This file contains 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
|
Initial results are lengthy but useful. Took quite a few samples and this list is actionable if you'd ask me. What do you think? Should the issues be dealt with in this PR too? Perhaps that's a bit much, but let's discuss. Here's the starting point: Unused files (25)Unused dependencies (152)Unused devDependencies (42)Referenced optional peerDependencies (6)Unlisted dependencies (28)Unlisted binaries (71)Unresolved imports (9)Unused exports (275)Unused exported types (146)Unused exported enum members (8)Duplicate exports (4) |
|
Going to make a new "github-collapsible" reporter for output like this btw 😅 |
webpro
force-pushed
the
chore/add-knip
branch
from
1511e46
to
9f15da5
Compare
valentinpalkovic
added
build
☁️ Nx Cloud ReportCI is running/has finished running commands for commit 84236d8. As they complete they will appear below. Click to see the status, the terminal output, and the build insights. 📂 See all runs for this CI Pipeline Execution ✅ Successfully ran 1 targetSent with 💌 from NxCloud. |
|
Damn that's a lot of dirt to cleanup! 😅 I can't verify all of it, but a big portion of this looks good and really useful list!
|
Good! Knip isn't perfect and there will be false positives, but I think, say, 90% accuracy is way more useful than not using Knip at all.
I think the end goal is to have CI fail if Knip finds something. We're not there yet, and as it's a bit much I guess there should be a plan first. Depending on things like project/team organization, available resources, time, etc.:
I'll hit you up on Discord so we can discuss further if you'd like. Btw there's a Knip GitHub Action (3rd party).
In general, if both the root and the descendent workspace list a dependency, and the dependency is referenced only in the descendent workspace, it'll be reported as unused in the root workspace. That said, dependencies for a specific workspace can be ignored like so: |
|
Nice! Then my suggestion is to add this to the CircleCI configuration with Will you add the CI step and then this might be ready for review? |
webpro
force-pushed
the
chore/add-knip
branch
2 times, most recently
from
bb851c7
to
438a4e6
Compare
webpro
force-pushed
the
chore/add-knip
branch
from
438a4e6
to
01cca67
Compare
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
5 file(s) reviewed, 1 comment(s)
Edit PR Review Bot Settings
| for (const configKey of Object.keys(baseConfig.workspaces)) { | ||
| if (match([wsDir], configKey)) { | ||
| const manifest = await import(join(baseDir, wsDir, 'package.json')); | ||
| const configEntries = (config.workspaces[configKey].entry as string[]) ?? []; |
There was a problem hiding this comment.
logic: This line assumes config.workspaces[configKey].entry is always defined. Add a check to ensure it exists before casting.
yannbf
changed the title
ndelangen
approved these changes
Sep 26, 2024
10 tasks
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 #29106
What I did
package.json#bundlerentries as entry pathsChecklist for Contributors
Manual testing
Documentation
N/A?
Checklist for Maintainers
When this PR is ready for testing, make sure to add
ci:normal,ci:mergedorci:dailyGH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found incode/lib/cli/src/sandbox-templates.tsMake sure this PR contains one of the labels below:
Available labels
bug: Internal changes that fixes incorrect behavior.maintenance: User-facing maintenance tasks.dependencies: Upgrading (sometimes downgrading) dependencies.build: Internal-facing build tooling & test updates. Will not show up in release changelog.cleanup: Minor cleanup style change. Will not show up in release changelog.documentation: Documentation only changes. Will not show up in release changelog.feature request: Introducing a new feature.BREAKING CHANGE: Changes that break compatibility in some way with current major version.other: Changes that don't fit in the above categories.🦋 Canary release
This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the
@storybookjs/coreteam here.core team members can create a canary release here or locally with
gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>Greptile Summary
This PR introduces Knip, a tool for identifying unused files and exports, to the Storybook project with custom configuration.
scripts/knip.config.tswith project-specific settings and dynamic bundler entry detectionnormal,merged,daily) after thebuildjobknipscript to rootpackage.jsonandcode/package.jsonfor easy executionknipdependency inscripts/package.jsonfor development purposes