Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Converge connection getter and command helper names across modules

Đang mở
  • Có gì không ổn?
#1,538 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
48/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
typescript
Lĩnh vực
api

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
TypeScript
Star
2.6k
Fork
274
Merge trung bình
1 ngày 14 giờ
Pull request đã merge (30 ngày)
44

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của testcontainers/testcontainers-node

Tất cả issue của testcontainers/testcontainers-node

Issue tương tự

Thêm issue về TypeScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.