chore: fix TypeScript code quality violations from May 2026 audit

Aperta Adatta ai principianti
#420 21 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Una pull request collegata è già stata integrata.

  • #1230 di @prx-my — integrata

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
84/100
Tipo di issue
Refactoring
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
cli, tooling

Direzione di ricerca

Scegli un punto e commenta l’issue prima di iniziare. Leggi il file indicato e le costanti o i messaggi esistenti nelle vicinanze, mantieni le grafie e l’ambito specificati, quindi esegui npm test e npm run build; completato significa che il refactoring selezionato è completo senza combinare i punti.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

enhancement good first issue help wanted refactor

Small, self-contained refactors from a code-quality audit. Each bullet below is its own task and its own PR - please do not try to do them all in one. Comment on the issue saying which one you are taking so others can see, though the first working PR is the one that lands.

Re-verified against main on 2026-09-16, so the counts and paths below are current.

1. Extract the CLI flag literals in src/cli/args.ts

39 distinct flag strings ("--json", "--all", "--offline" and so on) appear as inline literals, 55 occurrences in total. Extract them into named constants so a typo becomes a compile error rather than a silently unrecognised flag. src/constants.ts already holds this kind of thing (DEFAULT_BATCH_SIZE, CACHE_TTL_MS) and is a reasonable home, or a dedicated src/cli/flags.ts if that reads better.

Good first issue. Mechanical, but please keep the flag spellings byte-identical - the tests and the docs both depend on them.

2. Extract the install command in src/utils/update-check.ts

src/utils/update-check.ts:98 has npm install -g cve-lite-cli inline. The registry URL right above it is already a named constant (NPM_REGISTRY_URL), so this is following an established pattern in the same file.

Good first issue, genuinely a few lines.

3. De-duplicate the flag-conflict errors in src/cli/validate.ts

Seven near-identical --X cannot be used with --Y messages. Extract a helper that takes the two flag names and builds the message, so the wording stays consistent when the eighth one is added.

4. Add braces to the remaining single-line if statements

Corrected 2026-09-27: ten in src/cli/args.ts and one in src/index.ts:131, so eleven in total. This previously said eight and one. For example src/cli/args.ts:74:

if (!val) throw new Error("--ca-cert requires a path argument");

Note this was previously filed as #1089 and closed as not-planned, so it is genuinely still open. There is no linter enforcing it yet; adding ESLint with curly is tracked separately as #1091, and that will supersede this task if it lands first.

Not in scope

scanPackages in src/scanner.ts is 1122 lines and well past our 60-line guideline, but it is core scanner internals and is being handled in-house. Please do not refactor it as part of this issue.

Already fixed, please do not re-report

The original May 2026 audit listed several items that have since been resolved. Leaving them here so nobody spends time re-finding them:

  • Nested ternary in src/output/formatters.ts - now an else-if chain
  • batchSize / searchDepth - now DEFAULT_BATCH_SIZE / DEFAULT_SEARCH_DEPTH in src/constants.ts
  • Cache TTL - now CACHE_TTL_MS
  • The npm registry URL - now NPM_REGISTRY_URL
  • The src/index.ts line references from the old audit are stale; that file was reduced from 973 lines to 191 in #1129, and the advisory-DB warnings it mentioned now live in src/scan/single-scan.ts
Before you open a PR

Run npm test and npm run build. Keep each PR to one bullet above.

Lingua principale
TypeScript
Stelle
801
Fork
204
Merge medio
3g 11h
PR unite (30g)
135

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OWASP/cve-lite-cli

Tutte le issue di OWASP/cve-lite-cli

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.