Additional fields meta schema / JSON Schema linting rules?

Aperta
#115 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
javascript

Direzione di ricerca

Inizia esaminando la gestione attuale da parte di jsonschema2md degli schemi senza titoli e il modo in cui il README generato collega i file. Chiarisci se il lavoro debba fornire un metaschema per i campi aggiuntivi, un elenco di regole di linting o entrambi; il lavoro è completo quando esiste un ambito documentato e concordato, con il comportamento o gli artefatti corrispondenti.

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

Descrizione

enhancement

Background:
I work on JSON Schema the specification.
I'm developing a "JSON Schema Linter" rule listing, and collaborating with an existing tool for linting.

I've been further testing jsonschema2md, and found that using my existing schemas, I've encountered issues such as the main readme.md didn't include links to the files, which was because my schemas had no title.

Linting, to check the schemas have a title, would be useful, right?
You could add a warning or even enable via option, a mode which errors should specific linting rules fail.

It would be super if you could create one of or both of the following.

  • A meta-schema for the additional fields you've added to make more useful documentation
  • A list of linting rules which would be useful to this tool
Lingua principale
JavaScript
Stelle
724
Fork
151
Merge medio
13h 49m
PR unite (30g)
5

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 adobe/jsonschema2md

Tutte le issue di adobe/jsonschema2md

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.