chore(tooling): install knip and remove unused files / dependencies #3106

jeanpierrecarvalho · 2024-09-11T16:45:48Z

chore(tooling): install knip and remove unused files / dependencies

Changes Made:

Installed knip to analyze unused files and dependencies
Removed unused files and dependencies identified by knip
Add some folders to be ignored by knip

Details of Changes:

Added knip to the project as a dev dependency to improve project cleanliness and remove dead code
Ran an analysis using knip and removed files that were no longer in use or required by the project
Updated related configurations and documentation to reflect the changes

Additional Details:

These changes help streamline the project and reduce clutter, improving overall maintainability
No functional changes were introduced; the focus was solely on project hygiene and code cleanup

What is next?

pnpm knip can run in the pre-commit hook OR / AND
can be added to GHA on PR creation OR / AND
can be added to release process and tag creation

netlify · 2024-09-11T16:46:10Z

✅ Deploy Preview for fakerjs ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`7f2b642`
🔍 Latest deploy log	https://app.netlify.com/sites/fakerjs/deploys/66e2fdc208f09f000873ec85
😎 Deploy Preview	https://deploy-preview-3106.fakerjs.dev
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

codecov · 2024-09-11T16:49:31Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.97%. Comparing base (18ab2c7) to head (7f2b642).
Report is 16 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next    #3106      +/-   ##
==========================================
+ Coverage   99.96%   99.97%   +0.01%     
==========================================
  Files        2776     2776              
  Lines      226260   226260              
  Branches      945      592     -353     
==========================================
+ Hits       226183   226206      +23     
+ Misses         77       54      -23

see 1 file with indirect coverage changes

package.json

test/internal/mersenne-test-utils.ts

knip.config.ts

ST-DDT · 2024-09-12T12:44:52Z

package.json

@@ -94,12 +95,6 @@
  ],
  "devDependencies": {
    "@actions/github": "6.0.0",
-    "@algolia/client-search": "5.2.3",


It looks like this dependency is now, optional. It would be good if somebody could test that as well.

Thinking: I wonder when that change happened.

package.json

ST-DDT · 2024-09-12T12:47:06Z

.github/renovate.json5

@@ -57,7 +57,7 @@
    },
    {
      "groupName": "doc-dependencies",
-      "matchPackageNames": ["@algolia/client-search", "ts-morph", "vitepress"]
+      "matchPackageNames": ["ts-morph", "vitepress"]


We should probably add vue/vue-tsc/@vueuse/core in here too. (Different PR)

I will create a new PR for that 🙏🏻

ST-DDT · 2024-09-12T12:51:17Z

package.json

@@ -30,7 +30,8 @@
    "docs:test:e2e:open": "run-p --race docs:serve \"cypress open\"",
    "release": "commit-and-tag-version",
    "prepublishOnly": "pnpm run clean && pnpm install && pnpm run build",
-    "preflight": "pnpm install && run-s generate format lint build test:update-snapshots ts-check"
+    "preflight": "pnpm install && run-s generate format lint build test:update-snapshots ts-check",
+    "knip": "knip"


If this something we should run as part of preflight? Or in our CI to find these as early as possible?

Preflight is already slow enough 😀

Just ran the preflight and yes, it's painful ahhahahah Do we need to do this preflight like that? Why the process is not splited using git hooks e.g and run, only if needed. We can perform some tasks only in the files in stage, using lint-staged e.g, WDYT? I can draw a proposal and explain my pov better

@matthewmayer @ST-DDT

i think it would be good to open a separate discussion on ways to speed up preflight

Agreed! I will create that discussion and add my thought there 🙏🏻

ST-DDT · 2024-09-12T16:14:44Z

Team Decision

For now, we don't see a need to keep knip permanently in the project.
But we would like to have the one time cleanup anyway.

Do you know how good the github ci integration of knip is?
aka does it show the errors only in the build logs or also as error markers in the PullRequest?

We will discuss this some more in the next team-meeting with other team members.

ST-DDT · 2024-09-16T18:47:18Z

package.json

@@ -94,12 +95,6 @@
  ],
  "devDependencies": {
    "@actions/github": "6.0.0",
-    "@algolia/client-search": "5.2.3",


Please create a separate PR that remove this dependency. That way it is easier to test for breaking changes.

ST-DDT · 2024-09-16T18:47:33Z

package.json

@@ -132,7 +127,6 @@
    "typescript": "5.5.4",
    "typescript-eslint": "8.3.0",
    "validator": "13.12.0",
-    "vite": "5.4.2",


Please create a separate PR that remove this dependency. That way it is easier to test for breaking changes.

jeanpierrecarvalho added 2 commits September 11, 2024 17:32

chore(root): install knip and remove unused dev dependencies

a16b460

chore(root): add ignore files to knip

7a02d9c

jeanpierrecarvalho requested a review from a team as a code owner September 11, 2024 16:45

prisis reviewed Sep 11, 2024

View reviewed changes

package.json Show resolved Hide resolved

prisis reviewed Sep 11, 2024

View reviewed changes

test/internal/mersenne-test-utils.ts Outdated Show resolved Hide resolved

ST-DDT reviewed Sep 12, 2024

View reviewed changes

ST-DDT added c: chore PR that doesn't affect the runtime behavior p: 1-normal Nothing urgent c: dependencies Pull requests that adds/updates a dependency s: needs decision Needs team/maintainer decision c: infra Changes to our infrastructure or project setup labels Sep 12, 2024

ST-DDT assigned jeanpierrecarvalho Sep 12, 2024

ST-DDT added this to the vAnytime milestone Sep 12, 2024

jeanpierrecarvalho added 5 commits September 12, 2024 15:17

fix: solve import syntax

45339eb

refactor: remove workspaces on knip.config

7dff3e9

fix: remove version range

3d3dcde

chore: regenerate lockfile

9b4d789

fix: set single export on mersenne test utils

7f2b642

ST-DDT mentioned this pull request Sep 14, 2024

chore(deps): update eslint #3100

Merged

1 task

ST-DDT added the needs rebase There is a merge conflict label Sep 16, 2024

ST-DDT requested changes Sep 16, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(tooling): install knip and remove unused files / dependencies #3106

chore(tooling): install knip and remove unused files / dependencies #3106

jeanpierrecarvalho commented Sep 11, 2024

netlify bot commented Sep 11, 2024 •

edited

Loading

codecov bot commented Sep 11, 2024 •

edited

Loading

ST-DDT Sep 12, 2024

ST-DDT Sep 12, 2024

jeanpierrecarvalho Sep 12, 2024

ST-DDT Sep 12, 2024

matthewmayer Sep 12, 2024

jeanpierrecarvalho Sep 12, 2024

jeanpierrecarvalho Sep 12, 2024

matthewmayer Sep 12, 2024

jeanpierrecarvalho Sep 12, 2024

ST-DDT commented Sep 12, 2024

ST-DDT Sep 16, 2024

ST-DDT Sep 16, 2024

chore(tooling): install knip and remove unused files / dependencies #3106

Are you sure you want to change the base?

chore(tooling): install knip and remove unused files / dependencies #3106

Conversation

jeanpierrecarvalho commented Sep 11, 2024

netlify bot commented Sep 11, 2024 • edited Loading

✅ Deploy Preview for fakerjs ready!

codecov bot commented Sep 11, 2024 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ST-DDT commented Sep 12, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

netlify bot commented Sep 11, 2024 •

edited

Loading

codecov bot commented Sep 11, 2024 •

edited

Loading