Rename and/or replace `coverage:report` script

Abierto
  • ¿Algo no está bien?
#545 0 comentarios 2 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
cypress, typescript
Área
testing

Línea de trabajo

Comienza inspeccionando la entrada coverage:report en package.json y la configuración de cobertura de Cypress descrita en cypress.json y .nycrc. Determina si el alcance solicitado es un renombrado específico de Cypress o unas opciones de nyc configurables en cypress.json; se considera completado cuando la cobertura de Cypress sigue siendo configurable sin un nombre de script genérico y engañoso.

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

Descripción

Is your feature request related to a problem? Please describe.
Currently, if you want to have different nyc options for your Cypress tests (for example if you're using a different test runner for unit tests), the only way to pass custom options is to use the coverage:report script in package.json. This approach is problematic because it's essentially a magic script name—new developers coming on to a project would have no indication what this script is for. What's worse, because it's in package.json, you can't even add a code comment to explain it. Your only option is to add something to a README or other documentation and hope that people actually read it.

Describe the solution you'd like
The ideal solution would be to make this command (as well as nyc options in general) configurable in cypress.json instead of relying on a magic script.

But at the very least, I feel the script should be renamed to something that makes it clear that this is related to Cypress, such as cypress:coverage:report. The current name is completely generic, and sounds like it should be used by the developer for generating generalized coverage reports.

Describe alternatives you've considered
In theory one workaround for this situation is to simply set the desired nyc config in the project's global .nycrc and instead pass a custom config for the other (i.e., unit) test runner. But this is still problematic because it would still not be immediately obvious that the global .nycrc config is actually specific to Cypress (again, one cannot add comments to it because of the JSON format).

Additional context
Just to reiterate, this is chiefly for a scenario where a different nyc config is desired for different test runners.

Lenguaje dominante
TypeScript
Estrellas
440
Forks
114
Merge medio
42 min
PR fusionados (30 d)
19

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

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 cypress-io/code-coverage

Todos los issues de cypress-io/code-coverage

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.