magic-number: numbers that are already named are reported (regex contents, `?? N` config fallbacks, parameter defaults, product factors, radix)

オープン
#431 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
45/100
issue の種類
バグ
明瞭さ
おおむね明確
活発さ
活発
技術スタック
typescript
領域
tooling

調査の方向性

Start with magic-number-prevention.ts, especially lines 168–177 and 224–227, and trace how the detector masks source text and exempts named values. Review its tests for regex literals, nullish coalescing, defaults, products, collections, radix arguments, and template substitutions; the issue gives example source patterns but does not name test files. Done when those false findings are excluded and template substitutions are scanned, while the listed real magic-number findings remain detectable.

索引モデルが issue の本文から書いたものです。

説明

bug

Found in the 8.0.0 self-audit triage: RoC 7.29.1 (npm, 5fc54afe) on a clean clone of develop at 2d2fa9a, with typescript resolvable (verdict compliance, 0 failed / 46 warnings). The bucket method and per-law tables are kept by QA; counts are from that run.

What happens

Magic Number Prevention reported 302 literals in 106 files; 40 files contain only these kinds of false findings (re-run of the detector's own loop, 0 mismatches):

  • inside regex literals (75 literals): skipped but not blanked (magic-number-prevention.ts:224-227), so {0,300} is a "magic number";
  • config.thresholds?.x ?? 50 (55): the config key names the number; the exemption only accepts const X = or key: on the same line (:168-177), and misses ?? at the end of the previous line;
  • later factors of a named product (MAX_AGE = 24 * 60 * 60 * 1000, 10), parameter/destructuring defaults (before = 50, 8), elements of a named Set, parseInt(x, 16).
    Also a false negative: ${…} inside template literals is blanked, so slice(0, 57) there is never seen.

Real debt remains (66 files): score deductions (score -= 25), unnamed length limits (the same .slice(0, 80) in 5 files), ratio cutoffs, version checks.

Suggested direction

Blank regex contents; treat as named: <chain> ?? N, ident = N in parameters/destructuring, every factor of a product whose first factor is exempt, elements of a named array/Set, the radix argument; scan template substitutions.

主要言語
TypeScript
スター
0
フォーク
0
平均マージ
38分
マージ済み PR(30日)
96

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Rule-Of-Code/RoC のほかの issue

Rule-Of-Code/RoC の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。