Converge connection getter and command helper names across modules
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 48/100
- Issue 类型
- 重构
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
- 领域
- api
调研方向
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.
由索引模型根据 Issue 内容生成。
描述
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 valkeyexecuteQuery(query, additionalFlags, isRoot)in mysqlexecVaultCommands(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-moduleskill so new modules follow it.
Where
packages/modules/*/src/*-container.ts.
Notes
- .NET puts
GetConnectionString()on a sharedIDatabaseContainerinterface 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 bemajor.
Dependencies
- Nothing blocks this. It can start now.
- Coordinate with #1518: for the old names.
- 主要语言
- TypeScript
- 星标
- 2.6k
- 派生
- 274
- 平均合并
- 1 天 14 小时
- 30 天内合并 PR
- 44
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
testcontainers/testcontainers-node 的其他 Issue
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 74/100
testcontainers/testcontainers-node#1539 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 82/100
testcontainers/testcontainers-node#1533 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 77/100
testcontainers/testcontainers-node#1531 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 76/100
testcontainers/testcontainers-node#1529 ·
维护者通常 1 天内回复
-
enhancement minor
难度 2/5 1-3 小时 新手友好度 78/100
testcontainers/testcontainers-node#1528 ·
维护者通常 1 天内回复
查看 testcontainers/testcontainers-node 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 68/100
apache/rocketmq-dashboard#6872 ·
维护者通常 3 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 70/100
fab-geocommuns/RNB-site#539 ·
维护者通常 2 天内回复
-
Guest multiview tile label leaks raw virtual-source-id "Whip" instead of the guest name / slot label未关闭
难度 2/5 1-3 小时 新手友好度 62/100
Eyevinn/open-live-studio#211 ·
维护者通常 1 天内回复
-
documentation good first issue
难度 2/5 半天 新手友好度 72/100
sujithputta02/Esapay#13 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
ehmpathy/rhachet-roles-bhuild#468 ·
维护者通常 1 天内回复