Improve `gen-schema-doc` script dev experience

Aperta
#1,280 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
48/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
javascript, python
Ambito
tooling

Direzione di ricerca

Inizia eseguendo lo script gen-schema-doc senza aver installato json-schema-for-humans e analizza l’entry point sottostante doc-schema.js e il suo errore attuale. Il lavoro è terminato quando la dipendenza Python mancante è documentata oppure lo script segnala un requisito descrittivo invece di un errore criptico.

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

Descrizione

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.

Lingua principale
TypeScript
Stelle
263
Fork
185
Merge medio
2g 15h
PR unite (30g)
39

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

Tutte le issue di finos/git-proxy

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.