fix-angular-fixmes

作者: bitwarden

解決 Bitwarden 客戶端程式碼庫中 eslint-disable 抑制註解的問題,透過修復根本原因。當使用者要求「修復 FIXME」時使用,…

npx skills add https://github.com/bitwarden/clients --skill fix-angular-fixmes

Key rules

  • Fix the underlying issue — never just delete the suppression comment and leave broken code.
  • Remove the complete comment block: FIXME line (if any) + TODO: Skipped block (if any) + eslint-disable-next-line line.
  • Both FIXME-paired and standalone suppressions are the same migration debt.
  • For Angular migration rules, prefer CLI schematics over manual edits.
  • Do NOT convert service observables to signals (ADR-0027).
  • For OnPush and signals patterns, the angular-modernization skill is the authoritative source — this skill only owns the ESLint suppression mechanics.

Step 1: Discover all suppressions

Use the Grep tool to find suppressions in the target path:

  • Pattern eslint-disable — finds all eslint suppressions
  • Pattern FIXME.*CL- — finds Angular FIXME-tracked ones specifically

Group results by rule name. Two forms appear in this codebase:

Form A — FIXME-paired (a FIXME tracking comment sits above the disable):

// FIXME(https://bitwarden.atlassian.net/browse/CL-764): Migrate to OnPush
// eslint-disable-next-line @angular-eslint/prefer-on-push-component-change-detection

Form B — Standalone (disable without a FIXME, or with a CLI skip comment):

// eslint-disable-next-line @angular-eslint/prefer-on-push-component-change-detection
// TODO: Skipped for signal migration because:
//  Accessor inputs cannot be migrated as they are too complex.
// FIXME(https://bitwarden.atlassian.net/browse/CL-903): Migrate to Signals
// eslint-disable-next-line @angular-eslint/prefer-signals

Both forms must be fixed the same way.

Rule reference

CategoryRuleSection below
Angular@angular-eslint/prefer-on-push-component-change-detectionOnPush
Angular@angular-eslint/prefer-signalsSignals
Angular@angular-eslint/prefer-output-emitter-refSignals
Angular template@angular-eslint/template/button-has-typeHTML rules
TypeScript@typescript-eslint/no-floating-promisesno-floating-promises
TypeScript@typescript-eslint/no-unused-varsno-unused-vars
TypeScript@typescript-eslint/no-unsafe-function-typeno-unsafe-function-type
RxJSrxjs/no-async-subscriberxjs rules
RxJSrxjs-angular/prefer-takeuntilrxjs rules
Bitwarden@bitwarden/platform/no-enumsno-enums
Bitwarden@bitwarden/components/no-bwi-class-usageHTML rules
Generalno-restricted-importsno-restricted-imports
Generalno-consoleno-console
Generalno-emptyno-empty
Generalbare // eslint-disable-next-linebare disable
Tailwindtailwindcss/no-custom-classnameHTML rules

OnPush

Rule: @angular-eslint/prefer-on-push-component-change-detection

Follow the OnPush guidance in the angular-modernization skill (add changeDetection: ChangeDetectionStrategy.OnPush, remove ChangeDetectorRef if only used for detectChanges()). Then remove the FIXME + eslint-disable-next-line lines.

@Directive does not support changeDetection — skip OnPush for pure directives.

Signals

Rules: @angular-eslint/prefer-signals, @angular-eslint/prefer-output-emitter-ref

Applies to @Input(), @Output(), @ViewChild, @ContentChild.

Follow the Signal Inputs, Outputs, and Queries guidance in the angular-modernization skill (prefer CLI schematics, then manual conversion). After each migration, manually remove the FIXME and eslint-disable-next-line lines, and any // TODO: Skipped for signal migration because: comment blocks.

Do NOT convert service observables to signals — only component-local state and decorator bindings (ADR-0027).

no-floating-promises

Rule: @typescript-eslint/no-floating-promises

A returned Promise is not handled. Pick one fix:

// 1. Await it (preferred in async functions)
await this.router.navigate(["/login"]);

// 2. void — explicit fire-and-forget
void this.router.navigate(["/login"]);

// 3. Chain .catch() for explicit error handling
this.router.navigate(["/login"]).catch((err) => this.logService.error(err));

Use void for navigation or toast calls that genuinely don't need awaiting. Use await when the result matters or you're already in an async context.

no-unused-vars

Rule: @typescript-eslint/no-unused-vars

// Remove unused variable
const unused = computeSomething(); // delete this line

// Or prefix with _ if it must be declared (e.g. destructuring)
const [_first, second] = array;

// Or suppress a catch variable (TypeScript 4.0+)
try { ... } catch { ... } // omit the variable entirely

no-unsafe-function-type

Rule: @typescript-eslint/no-unsafe-function-type

Replace the generic Function type with a specific signature:

Before

private callback: Function;

After — use the actual signature

private callback: () => void;
// or for unknown signatures:
private callback: (...args: unknown[]) => unknown;

RxJS rules

Rules: rxjs/no-async-subscribe, rxjs-angular/prefer-takeuntil

rxjs/no-async-subscribe — async callback inside .subscribe() swallows errors:

Before

this.service.data$.subscribe(async (value) => {
  await this.process(value);
});

After — move async work into the pipe

this.service.data$
  .pipe(
    switchMap((value) => this.process(value)),
    takeUntilDestroyed(),
  )
  .subscribe();

rxjs-angular/prefer-takeuntil — subscription without cleanup:

Before

this.service.data$.subscribe((value) => {
  this.data = value;
});

After — add takeUntilDestroyed() (call in constructor or use destroyRef)

constructor() {
  this.service.data$
    .pipe(takeUntilDestroyed())
    .subscribe((value) => { this.data = value; });
}

no-enums

Rule: @bitwarden/platform/no-enums

Convert TypeScript enums to const objects with type aliases (ADR-0025):

Before

enum CipherType {
  Login = 1,
  SecureNote = 2,
}

After

export const CipherType = Object.freeze({ Login: 1, SecureNote: 2 } as const);
export type CipherType = (typeof CipherType)[keyof typeof CipherType];

Update all import sites — the usage (CipherType.Login) stays the same.

no-restricted-imports

Rule: no-restricted-imports

The import is from a path that the ESLint config forbids. Steps:

  1. Read the context around the import to understand what is being imported.
  2. Check eslint.config.mjs at the repo root (or the nearest config) for the no-restricted-imports rule to find the allowed alternative path.
  3. Replace the import with the allowed path and remove the suppression.

Common cases: importing platform-internal modules directly instead of through the public API, or test-only helpers in non-test files.

no-console

Rule: no-console

// Remove debug statements
console.log("debug"); // delete

// Replace with the application logging service
this.logService.error("Something failed", error);

In test files (*.spec.ts), a console.error or console.warn spy may be intentional — in that case, set up the spy properly rather than suppressing:

jest.spyOn(console, "error").mockImplementation(() => {});

no-empty

Rule: no-empty

Empty catch blocks silently swallow errors:

Before

try {
  await something();
  // eslint-disable-next-line no-empty
} catch {}

After — handle or log the error

try {
  await something();
} catch (e) {
  // Intentionally ignored — operation is best-effort
}

// Or log it
try {
  await something();
} catch (e) {
  this.logService.warning("Operation failed", e);
}

Bare disable

Rule: bare // eslint-disable-next-line (no rule specified)

This disables ALL rules for the next line, which is always wrong. Steps:

  1. Remove the suppression and run npm run lint:fix to see which specific rule triggers.
  2. Fix the underlying issue using the appropriate section above.
  3. If the violation truly cannot be fixed (rare), replace the bare disable with a specific named rule.

HTML rules

@angular-eslint/template/button-has-type — Add an explicit type to every <button>:

Before

<button (click)="save()">Save</button>

After

<button type="button" (click)="save()">Save</button>
<!-- or type="submit" inside a <form> -->

@bitwarden/components/no-bwi-class-usage — Replace raw bwi-* icon classes with the <bit-icon> component or the appropriate icon token.

tailwindcss/no-custom-classname — Use a Tailwind utility class with the tw- prefix, or register the class in the Tailwind safelist. Never use arbitrary custom class names.

Step 2: Cleanup checklist per fixed instance

  • // FIXME(…) line removed (if present)
  • // TODO: Skipped for signal migration because: … block removed (all lines, if present)
  • // eslint-disable-next-line … line removed
  • Unused imports removed; new imports added as needed
  • All in-class usages updated (e.g. signal reads need ())

Step 3: Validate

npm run lint:fix

Fix any errors that remain. Run npm run test if behaviour-critical code was changed.

來自 bitwarden 的更多技能

figma-to-angular
bitwarden
此技能可將 Figma 設計規格轉換為 Bitwarden Clients 單一儲存庫中,具備 Storybook 故事的完整 Angular 元件。輸出結果應在視覺上符合設計,同時遵循所有程式碼庫慣例。
force-multiplier
bitwarden
將單一意圖同時套用於多個目標——例如 Bitwarden 生態系中的一組儲存庫,或單一 monorepo 內的多個專案——以 N 個一致的操作來執行,…
analyzing-git-sessions
bitwarden
分析指定時間範圍或提交範圍內的 Git 提交與變更,提供結構化摘要,適用於程式碼審查、回顧會議、工作日誌或工作階段…
coordinating-cross-team-breakdown
bitwarden
協調跨團隊審查與簽核 Bitwarden 技術分解。用於識別受影響團隊、建立第三部分簽核表格、追蹤…
assessing-jira-issue-relevance
bitwarden
當使用者提供單一Jira議題金鑰,並詢問該議題是否仍相關、仍適用、仍待處理、仍是錯誤、已修復,或可否……時使用。
assessing-test-coverage
bitwarden
用於判斷特定變更(PR、Jira key、Tech Breakdown 文件、Testmo CSV、變更路徑或具名……)已存在哪些測試覆蓋範圍時使用。
retrospecting
bitwarden
對 Claude Code 工作階段進行全面分析,檢視 Git 歷史記錄、對話日誌、程式碼變更,並收集使用者回饋以產生…
reviewing-incremental-changes
bitwarden
在重新審視已有評論的PR,或回應開發者在初次審查後的變更時,使用此技能。適用於存在PR討論串或…的情況。