nodejs / nodejs/node

JSON Schema validation in Node.js core

Aperta
#62,598 26 commenti 61 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

feature request
Lingua principale
JavaScript
Stelle
122k
Fork
37.3k
Merge medio
4g 2h
PR unite (30g)
283

Descrizione

What is the problem this feature will solve?

Hi all,

I wanted to open a discussion about whether JSON Schema validation could be a useful addition to Node.js core.

Current state

  • Node.js currently has no built-in JSON Schema validation
  • node.config.json (experimental) uses hand-written type checking against a JSON Schema 2020-12 definition generated from C++ option metadata
  • package.json parsing uses simdjson but has no schema validation, fields are extracted structurally
  • The only schema validation in the Node.js tree lives inside deps/npm (Ajv)

Potential use cases

  • Validate node.config.json against its own schema properly
  • Future validation for package.json fields (opt-in, non-breaking)
  • Expose as a built-in module (node:jsonschema) so userland doesn't need to pull in external validators

Context

I've been working on a project in this area, ata-validator, a JSON Schema validator built on simdjson and RE2. It currently passes 96.9% of the official JSON Schema Test Suite (Draft 2020-12) and falls back to a pure JS engine when native bindings aren't available.

I'm not proposing to land it as-is, I'd love to hear from the group first:

  1. Is there interest in having JSON Schema validation available in core?
  2. What would be the most useful entry point? (config validation, public API, both?)
  3. Any concerns about the dependency story? (RE2/abseil weight, simdjson already in core)

Happy to share benchmarks or more details if this sounds worth exploring.

fyi @Qard

What is the feature you are proposing to solve the problem?

A built-in JSON Schema validator, potentially exposed as node:jsonschema, that could also be used internally for validating node.config.json and other configuration files.

This would provide Node.js users with a fast, native JSON Schema (Draft 2020-12) validation capability without needing external dependencies.

What alternatives have you considered?
  • Continuing with hand-written validation for each config format individually,
    doesn't scale as more config formats are added

  • Bundling an existing JS-based validator like Ajv into core, lacks native performance benefits

  • Leaving JSON Schema validation entirely to userland

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia leggendo il percorso di validazione di node.config.json, la definizione di JSON Schema 2020-12 derivata dai metadati delle opzioni C++ e il codice di validazione dello schema in deps/npm. Confronta gli entry point proposti node:jsonschema, config-validation e package.json con l’uso esistente di Ajv. Il lavoro è completato quando sono stati concordati l’ambito e la strategia delle dipendenze prima di poter definire l’implementazione.

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

Valutazione

Stack tecnologico
javascript, node.js
Ambito
backend
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Tranquilla
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.