Export the types used in public method signatures
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 78/100
- issue の種類
- 機能追加
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- docker, node.js, typescript
調査の方向性
packages/testcontainers/src/index.tsから始め、そのエクスポートをissueに記載された公開シグネチャと比較します。関連する型宣言とメソッドシグネチャを読んで、どの型が不足しているか確認してください。issueでは、AbstractWaitStrategyもエクスポートされていないものとして挙げられています。エクスポートされたシグネチャで使われているすべての型を、パッケージのエントリーポイントからインポートできれば完了です。
索引モデルが issue の本文から書いたものです。
説明
What happens
Several types appear in public method signatures but are not exported from packages/testcontainers/src/index.ts, so consumers cannot name them. That makes it awkward to build arguments in a helper, annotate a variable, or write a wrapper.
| Type | Appears in |
|---|---|
BindMount |
withBindMounts |
TmpFs |
withTmpFs |
Ulimits |
withUlimits |
ExtraHost |
withExtraHosts |
ResourcesQuota |
withResourcesQuota |
DirectoryToCopy |
withCopyDirectoriesToContainer, copyDirectoriesToContainer |
ArchiveToCopy |
withCopyArchivesToContainer |
BuildArgs |
GenericContainerBuilder.withBuildArgs |
HttpWaitStrategy |
return type of Wait.forHttp |
CompositeWaitStrategy |
return type of Wait.forAll |
ShellWaitStrategy |
return type of Wait.forSuccessfulCommand |
StartedGenericContainer |
return type of StartedDockerComposeEnvironment.getContainer |
ComposeDownOptions |
StartedDockerComposeEnvironment.down, StoppedDockerComposeEnvironment.down |
ComposeOptions |
DockerComposeEnvironment.withClientOptions |
Reaper |
return type of getReaper |
Ports, HostPortBindings, HealthCheckStatus, NetworkSettings |
fields of the exported InspectResult |
AbstractWaitStrategy is not exported either. A custom wait strategy that is not a StartupCheckStrategy has to implement WaitStrategy directly and re-implement the timeout bookkeeping (withStartupTimeout, isStartupTimeoutSet, getStartupTimeout).
Expected
Every type that appears in an exported signature is exported from index.ts. AGENTS.md already asks for this when a type becomes part of the public API.
Where
packages/testcontainers/src/index.ts.
Notes
getContainercould return theStartedTestContainerinterface instead of exporting the concreteStartedGenericContainerclass.npm run knipdoes not catch these, because the types are used by other files.- A check that fails when an exported signature references an unexported type would stop this recurring.
Dependencies
- Nothing blocks this. It can start now.
- 主要言語
- TypeScript
- スター
- 2.6k
- フォーク
- 274
- 平均マージ
- 1日 14時間
- マージ済み PR（30日）
- 44
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 日以内に返信
-
bug patch
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
testcontainers/testcontainers-node#1526 ·
メンテナーはふだん 1 日以内に返信
testcontainers/testcontainers-node の issue をすべて見る
似ている issue
-
ui(ListToolbar): search takes the full row on a phone instead of sharing it with the result countオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 64/100
メンテナーはふだん 1 日以内に返信
-
priority:high
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
immich-app/immich#32426 ·
メンテナーはふだん 1 日以内に返信
-
documentation good first issue hacktoberfest help wanted
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
libredb/libredb-studio#1756 ·
メンテナーはふだん 1 日以内に返信