Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

CLI: rethink step validation

Aperta
  • Qualcosa non va?
#1,407 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
cli

Direzione di ricerca

Inizia dall’attuale punto di ingresso della CLI per la validazione di workflow-structure ed esamina il JSON schema esistente. Confronta i tre approcci proposti, inclusa la selezione della versione per lo schema comune di portabilità e il flag opzionale --validate. Il lavoro è completato quando la politica di validazione è definita con sufficiente chiarezza da distinguere il rilevamento degli errori di battitura dalla compatibilità con chiavi di workflow più recenti.

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

Descrizione

CLI DevX

The CLI has logic to validate the structure of a workflow.

The idea here is that if a user mis-types a key like "adapatator", the CLI will catch the error and flag them.

What with all the focus on sync and portability, it's way more likely that a workflow will be machine generated now, and so won't have those typos.

But if the app adds a new key to the workflow, the CLI will refuse to execute it - even if it's a step it doesn't care about.

I would like to think about the following options:

  • Use the common portability spec schema to validate against. The app does have a JSON schema. If the workflow or owning project has aversion, use that, else use latest. This relates to https://github.com/OpenFn/lightning/issues/4734
  • Add a --validate flag which will validate a workflow for you, if you want it (a bit like a circle CI yaml linter app)
  • only validate keys that the CLI cares about, and ignore the rest
Lingua principale
TypeScript
Stelle
21
Fork
23
Merge medio
1g 4h
PR unite (30g)
20

Preparare l'ambiente

Non abbiamo ancora controllato i file di configurazione di questo progetto. Parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

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 OpenFn/kit

Tutte le issue di OpenFn/kit

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.