crossplane / crossplane/function-sdk-typescript

Standard/reusable CLI flags

Aperta
#39 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
enhancement
Lingua principale
TypeScript
Stelle
3
Fork
2
Merge medio
9h 49m
PR unite (30g)
14

Descrizione

### What problem are you facing?

Each function author today copies CLI boilerplate (mainly flags, environment variables, and defaults) from the function templates (Go, Python, TS). This leads to eventual inconsistency across functions (env var names drift, each author may decide, e.g. GRPC_MESSAGE_SIZE vs MAX_RECV_MESSAGE_SIZE), some functions miss env tags entirely (e.g. DEBUG), etc.

On top of that, there's no single source of truth and when new standard option is added or a default changes, every function must be updated independently. There is no mechanism to propagate changes.

Standardization of CLI arguments/env variables might become useful for 3rd party tooling (e.g. crossplane-diff) which may need to flag all functions in the composition pipeline at the same time (e.g. programmatically raise the max GRPC size in all functions).

### How could this Function help solve your problem?
Move the standard CLI definition into the SDK, in order to eliminate copy&paste and give authors a single import.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Confronta i template delle funzioni Go, Python e TypeScript per inventariare i relativi flag, le variabili d’ambiente e i valori predefiniti. Poi esamina gli entry point dell’SDK TypeScript e determina come gli autori potrebbero importare una definizione CLI standard; il lavoro è completato quando le opzioni e i valori predefiniti condivisi hanno un’unica fonte nell’SDK invece di essere duplicati nel boilerplate dei template.

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

Valutazione

Stack tecnologico
typescript
Ambito
cli, developer-experience
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
48/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.