crossplane / crossplane/function-sdk-typescript

Standard/reusable CLI flags

Offen
#39 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
TypeScript
Sterne
3
Forks
2
Ø Merge
9 Std. 49 Min.
Gemergte PRs (30 T.)
14

Beschreibung

### 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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Compare the Go, Python, and TypeScript function templates to inventory their flags, environment variables, and defaults. Then inspect the TypeScript SDK entry points and determine how authors could import one standard CLI definition; done means the shared options and defaults have a single SDK source rather than duplicated template boilerplate.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
cli, developer-experience
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
48/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.