Skip to content

Added knip config and action for unused files/exports - #90642

Merged
roryabraham merged 48 commits into
Expensify:mainfrom
shubham1206agra:knip-config
Jun 1, 2026
Merged

roryabraham merged 48 commits into
Expensify:mainfrom
shubham1206agra:knip-config

Conversation

@shubham1206agra

@shubham1206agra shubham1206agra commented May 14, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$ #86254

Tests

Please run smoke tests of the main flow: Sign in, Create Expense, Submit, etc

Offline tests

Same as Tests

QA Steps

Same as Tests

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

@github-actions

Copy link
Copy Markdown
Contributor

⚠️ This PR is possibly changing native code and/or updating libraries, it may cause problems with HybridApp. Please check if any patch updates are required in the HybridApp repo and run an AdHoc build to verify that HybridApp will not break. Ask Contributor Plus for help if you are not sure how to handle this. ⚠️

@shubham1206agra
shubham1206agra marked this pull request as ready for review May 14, 2026 11:40
@shubham1206agra
shubham1206agra requested review from a team as code owners May 14, 2026 11:40
@melvin-bot
melvin-bot Bot requested review from QichenZhu and flaviadefaria and removed request for a team May 14, 2026 11:40
@melvin-bot

melvin-bot Bot commented May 14, 2026

Copy link
Copy Markdown

@QichenZhu Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@melvin-bot
melvin-bot Bot removed the request for review from a team May 14, 2026 11:40
@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@roryabraham @Julesssss This PR adds the final knip config + action that will run on every PR. Please merge the PR with failing check as it will be stabilised once PR hits main

@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@MelvinBot Write up a slack post that will tell the users about knip and how to resolve knip errors. Take reference of this PR for help

@MelvinBot

Copy link
Copy Markdown
Contributor

Here's a draft Slack post about knip:


🔍 New CI Check: Knip (unused code detection)

We've added knip to our CI pipeline. It automatically detects unused files, exports, types, and dependencies in the codebase. Starting now, PRs that introduce new unused code will fail the "Knip check" CI step.

Important: knip will NOT fail on pre-existing unused code — it only compares your PR against main and flags newly introduced issues.

Common knip errors and how to fix them:

  1. Unused export — You exported a function/type/constant but nothing imports it. Either remove the export keyword or delete the symbol entirely if it's dead code.

  2. Unused file — A file exists but is never imported anywhere. Delete it if it's no longer needed.

  3. Unused type export — Same as unused export, but for TypeScript types. Remove the export or the type itself.

  4. Unused dependency — A package in package.json is never imported in code. Remove it with npm uninstall <package>.

How to debug locally:

# Run knip and see all current issues (JSON output):
KNIP=true npx knip --reporter json --no-exit-code > /tmp/knip-pr.json

# Or for a human-readable view:
KNIP=true npx knip

How the CI check works:

  • Knip runs on both your PR branch and main
  • A comparison script diffs the two reports
  • If your PR adds new findings that don't exist on main, the check fails
  • If your PR resolves existing findings, that's great — no penalty

What if knip flags something that's actually used?

Some code is used dynamically or by external tools that knip can't trace. In those cases, update knip.json to add the appropriate ignore entry. See the knip configuration docs for options like ignore, ignoreDependencies, and ignoreBinaries.

Reference PR: #90642

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: b13fadf95b

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread .github/scripts/compareKnipReports.ts Outdated
Comment thread scripts/compareKnipReports.ts

@Julesssss Julesssss left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Could you merge main and resolve the current check failures please

@roryabraham roryabraham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Also, let's add some documentation to a README

Comment thread .github/scripts/compareKnipReports.ts Outdated
Comment thread scripts/compareKnipReports.ts
Comment thread scripts/compareKnipReports.ts
Comment thread .github/workflows/knip.yml Outdated
Comment thread .github/workflows/knip.yml Outdated
Comment thread .github/workflows/knip.yml
Comment thread .github/workflows/knip.yml Outdated
Comment thread .github/workflows/knip.yml

@roryabraham roryabraham left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Meant to request changes

@roryabraham

Copy link
Copy Markdown
Contributor

I suggest we wait for the workflow to take effect and let the number of knip issues stabilize on main, then clean them up in one go.

That makes sense I think. Once we merge this PR, main will become the baseline. But we don't need to get knip passing on this PR necessarily

roryabraham
roryabraham previously approved these changes Jun 1, 2026
Comment thread .github/workflows/knip.yml Outdated
Comment thread config/eslint/eslint.seatbelt.tsv
Comment thread .github/workflows/knip.yml Outdated
Comment thread config/eslint/eslint.seatbelt.tsv
Co-authored-by: Shubham Agrawal <58412969+shubham1206agra@users.noreply.github.com>

@Julesssss Julesssss left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@Julesssss

Copy link
Copy Markdown
Contributor

@roryabraham changes since your last review feedback

@roryabraham
roryabraham merged commit 40cc2c4 into Expensify:main Jun 1, 2026
41 of 42 checks passed
@melvin-bot melvin-bot Bot added the Emergency label Jun 1, 2026
@melvin-bot

melvin-bot Bot commented Jun 1, 2026

Copy link
Copy Markdown

@roryabraham looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

🚧 @roryabraham has triggered a test Expensify/App build. You can view the workflow run here.

@roryabraham

Copy link
Copy Markdown
Contributor

knip was failing but should pass on other PRs after merging

@OSBotify

OSBotify commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify

OSBotify commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.3.91-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 No help site changes required — no draft PR created.

I reviewed the changes in this PR and there is nothing to document on the help site under App/docs/articles.

Why: This PR is an internal developer-tooling change. It:

  • Adds the knip configuration (knip.json) and a GitHub Action (.github/workflows/knip.yml) to detect unused files/exports
  • Removes unused exports and dead code across src/ that knip flagged

There are no user-facing changes: no modifications to src/languages/*, no new or changed UI copy, feature names, settings, tabs, or buttons, and no behavior changes. Help site articles document customer-facing product behavior, none of which is affected here.

@shubham1206agra, if you believe a user-facing behavior was actually changed by this PR and should be documented, let me know and I'll create the draft help site PR.

@izarutskaya

Copy link
Copy Markdown

Hi @shubham1206agra @JS00001 Is it enough tests included in the regression, let me know please? Thank you

@shubham1206agra

Copy link
Copy Markdown
Contributor Author

@izarutskaya You can do normal QA tests here. If anything pops out of ordinary, we will detect it.

@OSBotify

OSBotify commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 9.3.94-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

@MelvinBot

Copy link
Copy Markdown
Contributor

🤖 No help site changes required.

I reviewed the changes in this PR and confirmed that no updates to Expensify's help site files under App/docs/articles are needed, so I did not create a draft docs PR.

Why: This is a developer-tooling / code-quality change with no user-facing impact. It:

  • Adds knip config (knip.json, cspell.json, babel.config.js) and a CI workflow (.github/workflows/knip.yml) to detect unused files/exports/dependencies.
  • Removes dead code — unused exports, types, and a few unused files/helpers — across src/.

None of these changes add, remove, or modify any product feature, UI label, setting, or workflow that an end user would interact with. The linked issue #86254 is scoped as an Engineering "Task" (Knip audit), not a feature change. The help site documents user-facing product behavior, which is unchanged here.

@shubham1206agra — since there are no user-facing changes, there's no help site PR to review. If you believe a specific user-facing behavior was affected that I missed, reply with the detail and I'll take another look.

@OSBotify

OSBotify commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.3.94-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@shubham1206agra
shubham1206agra deleted the knip-config branch July 7, 2026 10:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants