Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Converge connection getter and command helper names across modules

オープン
#1,538 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
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 の本文から書いたものです。

説明

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.
主要言語
TypeScript
スター
2.6k
フォーク
274
平均マージ
1日 14時間
マージ済み PR(30日)
44

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

testcontainers/testcontainers-node のほかの issue

testcontainers/testcontainers-node の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。