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

Converge connection getter and command helper names across modules

Aperta
  • Qualcosa non va?
#1,538 0 commenti 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
48/100
Tipo di issue
Refactoring
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
api

Direzione di ricerca

Start by comparing the named getters, credential setters, and command helpers in packages/modules/*/src/*-*.ts, then read the add-module skill and coordinate the old-name handling with #1518. Decide and document shared naming patterns, including protocol-specific URLs and command helpers; done means the affected modules follow those patterns, old names remain deprecated aliases, and the skill records the convention.

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

Descrizione

enhancement minor

What happens

Modules name the same concept differently, so moving from one module to another means checking the docs each time.

Connection string getters:

Method Modules
getConnectionUri() azurecosmosdb, cockroachdb, localstack, mariadb, mssqlserver, mysql, postgresql
getConnectionString() azureservicebus, azurite, hivemq, mongodb, mosquitto
getConnectionUrl() clickhouse, minio, redis, valkey
getUrl() couchdb, influxdb, oraclefree
getHttpUrl() arangodb, chromadb, clickhouse, elasticsearch, opensearch
getHttpUri(), getBoltUri() neo4j

Other address getters use get*Endpoint (azurecosmosdb, azurite, etcd, gcloud, ollama) and get*Address (qdrant, redpanda, vault, weaviate).

Credential setters: most modules use withUsername and withPassword. mysql and mariadb use withUserPassword and withRootPassword.

Command helpers on started containers:

  • executeCliCmd(cmd, additionalFlags) in redis and valkey
  • executeQuery(query, additionalFlags, isRoot) in mysql
  • execVaultCommands(commands) in vault

Expected

  • One name for "the string a client library connects with", used by every module that has one.
  • One naming pattern for protocol-specific URLs and for command helpers.
  • The old names stay as deprecated aliases.
  • The convention is written into the add-module skill so new modules follow it.

Where

packages/modules/*/src/*-container.ts.

Notes

  • .NET puts GetConnectionString() on a shared IDatabaseContainer interface that every database module implements. A shared interface here would also let helpers accept "any database container".
  • Adding aliases is minor. Removing the old names would be major.

Dependencies

  • Nothing blocks this. It can start now.
  • Coordinate with #1518: for the old names.
Lingua principale
TypeScript
Stelle
2.6k
Fork
274
Merge medio
1g 14h
PR unite (30g)
44

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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 testcontainers/testcontainers-node

Tutte le issue di testcontainers/testcontainers-node

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.