[Feature Request] Extend @optional decorator with groups

Aperta
#1,096 8 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
1-2 giorni
Idoneità per principianti
53/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
typescript
Ambito
backend

Direzione di ricerca

Start by locating the code that parses and validates @optional decorators, then read its existing tests for optional environment variables. Add coverage for a group with all variables absent, all present, and only one present; the issue’s example expects the partial group to fail validation. The issue does not name files or tests, so use the decorator implementation and its tests to establish the current behavior.

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

Descrizione

enhancement
Description

Allow @optional decorators to include an argument to define a group so that a whole group is either defined or not.

Example
# Microsoft OAuth client. Set together with its secret and tenant.
# @optional(microsoft)
MICROSOFT_CLIENT_ID=

# Secret belonging to the Microsoft OAuth client above.
# @sensitive @optional(microsoft)
MICROSOFT_CLIENT_SECRET=

This will throw if only one of the group variables is defined

Motivation

It is common to have multiple variables that are optional as a whole, but required if one is defined

Proposed Solution

No response

Alternatives

A new decorator defining the name and the included variables

# @optionalGroup(google, GOOGLE_DRIVE_CLIENT_ID, GOOGLE_DRIVE_CLIENT_SECRET)
Additional Information

No response

Lingua principale
TypeScript
Stelle
4.9k
Fork
140
Merge medio
2g 3h
PR unite (30g)
35

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: 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 dmno-dev/varlock

Tutte le issue di dmno-dev/varlock

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.