Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

New JSON generator schema

Fermée
  • Quelque chose ne va pas ?
#214 6 commentaires 3 réactions 2 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

@avivkeller y travaille déjà.

Depuis le 15/9/2026.

Évaluation

Cette issue n'a pas encore été évaluée.

Description

Web Generator
Enter your suggestions in details:

Background

This issue is regarding the new format for the JSON generator.
It only pertains to the format of the JSON files, the implementation details will be discussed once a censensus is reached here.

Why a new format?

There are a handful of issues with the current format, with some of the main ones being:

  • Maintainability
    • Without a pre-defined schema, it can be harder to tell where a property should be expected to go within the output
    • There isn't a great way to communicate changes to this schema when they happen
  • Consumability
    • Users don't know what to expect without going through the generator's code or looking through all of the outputted JSON files
    • The current format represents some fields in unfortunate ways (i.e. Markdown being parsed in HTML for descriptions)

Relevant: DefinitelyTyped/DefinitelyTyped#70298, nodejs/api-docs-tooling#57

The new format

The newly proposed schema for json generator is available here.
An example of it being used for Buffer is available here.

The new proposed schema for the json-all generator is available here.
An example of it being used is available here.

Key Points

JSON Schema

The new formats have JSON schemas defined. This gives us three main advantages over the current format:

  1. Consumers know what to expect
  2. We can version the output files in a standardized way (via the $id property)
  3. The schemas can be used to generate the types used within the JSON generator. This will help with maintaining the generator in the long run since we don't have to worry about them getting out of sync.
JSDoc Property Names

JSDoc keys (i.e. @name, @type) are used in the format.
This is mainly to make the files easier to consume.

TODOs

Here's what's left to be done with the new format:

Langage dominant
JavaScript
Étoiles
65
Forks
71
Merge moyen
4 j 15 h
PR mergées (30 j)
33

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de nodejs/doc-kit

Toutes les issues de nodejs/doc-kit

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.