chore: fix TypeScript code quality violations from May 2026 audit

Abierto Apto para principiantes
#420 21 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Ya se ha fusionado un pull request relacionado.

  • #1230 de @prx-my — fusionado

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
84/100
Tipo de issue
Refactorización
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
typescript
Área
cli, tooling

Línea de trabajo

Elige un punto y comenta en el issue antes de empezar. Lee el archivo indicado y las constantes o mensajes existentes cercanos, conserva las grafías y el alcance especificados y luego ejecuta npm test y npm run build; estar terminado significa que la refactorización seleccionada está completa sin combinar puntos.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
TypeScript
Estrellas
801
Forks
204
Merge medio
3 d 11 h
PR fusionados (30 d)
135

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OWASP/cve-lite-cli

Todos los issues de OWASP/cve-lite-cli

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.