Improve `gen-schema-doc` script dev experience

Abierto
#1,280 0 comentarios 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
48/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
javascript, python
Área
tooling

Línea de trabajo

Comienza ejecutando el script gen-schema-doc sin tener instalado json-schema-for-humans e inspecciona el punto de entrada subyacente doc-schema.js y su error actual. El trabajo estará terminado cuando la dependencia de Python que falta esté documentada o el script indique un requisito descriptivo en lugar de mostrar un error críptico.

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

Descripción

enhancement tech-debt

Right now, executing the gen-schema-doc script without setting things up correctly, results in a cryptic error that doesn't tell you that the Python library json-schema-for-humans is needed to run the underlying doc-schema.js script.

Simply executing pip install json-schema-for-humans beforehand fixes this (assuming pip is available). We should either document this somewhere, or make sure that the doc-schema.js script gives a more descriptive error when failing.

Lenguaje dominante
TypeScript
Estrellas
263
Forks
185
Merge medio
2 d 15 h
PR fusionados (30 d)
39

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 finos/git-proxy

Todos los issues de finos/git-proxy

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.