forcedotcom / forcedotcom/code-analyzer

[Feature Request] Config check CLI commands for external config files

Abierto
#2,029 0 comentarios 0 reacciones 0 asignados Ver en GitHub
Lenguaje dominante
TypeScript
Estrellas
240
Forks
52
Merge medio
1 d 23 h
PR fusionados (30 d)
5

Descripción

### Product Area

The "code-analyzer" CLI

### Your Need or Problem

Currently, when I recreate my config file (after modifying my custom PMD ruleset), it gives an error if my PMD file has a problem.

This is good.

However, it would be BETTER if I could run a code-analyzer command that would validate my PMD files that are mentioned in my config file WITHOUT regenerating my config file. It would just be simpler while I'm updating things. Then I would, of course, have to redo the config command.

### Your Desired Solution

Please add a command

`sf code-analyzer config check --engine pmd,eslint --config-file code-analyzer.yml`

that looks at the PMD rulesets referenced in `code-analyzer.yml` and runs `pmd --debug check -d -R -f text` or a similar command.

For the ESLint config referenced in `code-analyzer.yml` it runs `npx eslint --inspect-config` or a similar command.

I **know** that rulesets/configs are validated when listing rules, but I don't want any output beyond "Your config file is valid" or "These are the problems in your config file" for this request.

### Alternatives Considered

1. Run `echo 'y' | sf code-analyzer config --include-unmodified-rules --rule-selector all --config-file code-analyzer.yml --output-file code-analyzer.yml` to regenerate `code-analyzer.yml`
2. Run `sf code-analyzer rules --rule-selector pmd --rule-selector eslint`

### Additional Context (Screenshots, Files, etc)

_No response_

### Workaround

I can do what I want within other commands, but breaking it out would speed some work.

### Urgency

Low

Guía de contribución

Abrir la guía de contribución

Línea de trabajo

Comienza por el comando config existente de la CLI code-analyzer y el manejo de config-file; compara cómo se validan actualmente los PMD rulesets y las ESLint configs al regenerar o listar reglas. Se considera terminado cuando un comando config check acepta las opciones indicadas e informa únicamente de problemas de validez o configuración para los engines seleccionados.

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

Evaluación

Stack tecnológico
eslint, typescript
Área
cli, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
Estado de actividad
Tranquilo
Claridad
Bastante claro
Aptitud para principiantes
48/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.