nodejs / nodejs/node

remove redundancy in node.config schema keys

Aperta
#60,904 10 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

config feature request stale
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?

Notice below how in the current schema, the namespaces "test" and "watch" are redundantly specified. This is the result of mapping the CLI args as-is.

{
    "$schema": "https://nodejs.org/dist/vX.Y.Z/docs/node-config-schema.json",
    "test": {
        "test-concurrency": 3
        "test-isolation": "process"
        "test-timeout": 5000
        "test-rerun-failures": true
        "test-only": true
        "test-force-exit": false
        "test-name-pattern": "^iso"
        "test-skip-pattern": "tree$"
        "test-global-setup": "setup-module.mjs"
        "experimental-test-coverage": true
        "test-coverage-exclude": "test/**"
        "test-coverage-include": "src/**"
        "test-coverage-branches": 100
        "test-coverage-functions": 100
        "test-coverage-lines": 100
        "test-reporter": ["dot", "spec", "lcov"]
        "test-reporter-destination": ["stdout", "test.report", "lcov.info"]
        "experimental-test-module-mocks": true
        "test-update-snapshots": true
    },
    "watch": {
        "watch-preserve-output": true
        "watch-path": "./src"
    }
} 
What is the feature you are proposing to solve the problem?

Instead, the namespace part of the CLI arg could automatically be mapped to a namespace within the config schema:

{
    "$schema": "https://nodejs.org/dist/vX.Y.Z/docs/node-config-schema.json",
    "test": {
        "concurrency": 3
        "isolation": "process"
        "timeout": 5000
        "rerun-failures": true
        "only": true
        "force-exit": false
        "name-pattern": "^iso"
        "skip-pattern": "tree$"
        "global-setup": "setup-module.mjs"
        "experimental-coverage": true
        "coverage-exclude": "test/**"
        "coverage-include": "src/**"
        "coverage-branches": 100
        "coverage-functions": 100
        "coverage-lines": 100
        "reporter": ["dot", "spec", "lcov"]
        "reporter-destination": ["stdout", "test.report", "lcov.info"]
        "experimental-module-mocks": true
        "test-update-snapshots": true
    },
    "watch": {
        "preserve-output": true
        "path": "./src"
    }
} 

Note that for "experimental-" CLI args, the mapped namespace occurs after that prefix.

We can take it a step further, apply the idea recursively, as below. This has the added of benefit fixing how destinations are specified when there are multiple test reporters.

{
    "$schema": "https://nodejs.org/dist/vX.Y.Z/docs/node-config-schema.json",
    "test": {
        "concurrency": 3
        "isolation": "process"
        "timeout": 5000
        "rerun-failures": true
        "only": true
        "force-exit": false
        "name-pattern": "^iso"
        "skip-pattern": "tree$"
        "global-setup": "setup-module.mjs"
        "experimental-coverage": {
            "exclude": "test/**"
            "include": "src/**"
            "branches": 100
            "functions": 100
            "lines": 100
        }
        "reporter": {
            "dot": {"destination": "stdout"}
            "spec": {"destination": "test.report"}
            "lcov": {"destination": "lcov.info"}
        }
        "experimental-module-mocks": true
        "update-snapshots": true
    },
    "watch": {
        "preserve-output": true
        "path": "./src"
    }
} 
What alternatives have you considered?

No response

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 tracciando la corrispondenza tra gli argomenti CLI di Node e lo schema di configurazione, quindi confronta come vengono generate attualmente le chiavi test e watch. Gli esempi dell’issue definiscono il risultato previsto: i prefissi degli namespace devono essere rimossi, le opzioni sperimentali gestite dopo il relativo prefisso e le destinazioni annidate di reporter mappate ricorsivamente.

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

Valutazione

Stack tecnologico
javascript, node.js
Ambito
cli, developer-experience
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.