Skip to content

chore: add knip and remove dead code #437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cameri merged 3 commits into from
Apr 10, 2026
Merged

chore: add knip and remove dead code #437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
062d6cb
chore: add knip and remove unused dependencies
Anshumancanrock Apr 10, 2026
93ced67
chore: remove dead source files
Anshumancanrock Apr 10, 2026
2c6b63c
chore: remove tests for deleted runes modules
Anshumancanrock Apr 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions .knip.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"$schema": "https://unpkg.com/knip@2/schema.json",
"entry": [
"src/index.ts",
"src/import-events.ts",
"knexfile.js"
],
"project": [
"src/**/*.ts"
],
"ignoreFiles": [],
"commitlint": false,
"eslint": false,
"github-actions": false,
"husky": false,
"mocha": false,
"nyc": false,
"semantic-release": false
Comment on lines +12 to +18
Copy link
Copy Markdown
Owner

@cameri cameri Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@phoenix-server what do each of these lines do when using Knip? Should these be false for this project?

Copy link
Copy Markdown
Contributor Author

@Anshumancanrock Anshumancanrock Apr 10, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @cameri , These are Knip "plugins" that auto-detect dependencies by reading each tool's config file. Setting them to false disables that detection.

However, with --production (which our npm run knip script uses), these flags have no effect as --production already skips devDependency analysis entirely. So they're redundant.

They only matter if someone runs npx knip without --production, where the plugins would flag ~17 devDependencies (like chai, sinon, mochawesome, rxjs, ts-node-dev, etc.) as unused even though they're used by tests/tooling.

I can remove them to keep the config minimal since --production handles it, or keep them as a safety net for manual runs. Happy to go either way , what do you prefer?

Copy link
Copy Markdown
Owner

@cameri cameri Apr 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, I just wanted to know what they meant.

}
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@ before making a change.

Please keep the conversations civil, respectful and focus on the topic being discussed.

## Local Quality Checks

Run dead code and dependency analysis before opening a pull request:

```
npm run knip
```

`npm run lint` now runs Knip first, then ESLint.

## Pull Request Process

1. Update the relevant documentation with details of changes to the interface, this includes new environment
Expand Down
Loading
Loading