[No QA] docs: update CONSISTENCY-5 to clarify eslint-disable vs SEATBELT_INCREASE#90297
Conversation
|
@stitesExpensify 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] |
…EASE eslint-disable hides violations permanently from the baseline, so it should only be used for deliberate, permanent suppressions. For temporary suppressions, SEATBELT_INCREASE is preferred. Align the rule with the guidance added to LINTING.md. Co-authored-by: Cursor <cursoragent@cursor.com>
314eedc to
83a48cd
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 83a48cdaca
ℹ️ 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".
Add one more parent directory segment to the relative path so it correctly resolves from .claude/skills/coding-standards/rules/ to contributingGuides/LINTING.md at the repo root. Co-authored-by: Rory Abraham <roryabraham@users.noreply.github.com>
Reviewer Checklist
Screenshots/VideosAndroid: HybridAppAndroid: mWeb ChromeiOS: HybridAppiOS: mWeb SafariMacOS: Chrome / Safari |
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚀 Deployed to staging by https://github.com/stitesExpensify in version: 9.3.76-0 🚀
|
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.77-3 🚀
|
Explanation of Change
Updates the
CONSISTENCY-5coding standard rule to align with the updated guidance inLINTING.md.The key additions:
Clarifies when
eslint-disableis appropriate — only for permanent suppressions where the rule genuinely does not apply to a specific case. The rule now explains thateslint-disablehides violations from the seatbelt baseline entirely, so they can never be fixed unless the comment is removed.Points to
SEATBELT_INCREASEas the preferred alternative for temporary suppressions — this keeps violations visible in the baseline so they can be addressed later.Adds a "also consider flagging" guidance in the Review Metadata section so reviewers know to suggest
SEATBELT_INCREASEwhen they seeeslint-disableused for convenience rather than as a deliberate permanent exception.The justification comment requirement is unchanged — it's still required whenever
eslint-disableis used.Fixed Issues
$
Tests
None.
Offline tests
n/a
QA Steps
None.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectioncanBeMissingparam foruseOnyxtoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop