[2f] Add TypeScript declarations, JSDoc, and fix nftMarkerCount/markerNFTCount naming
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 35/100
- issue の種類
- リファクタリング
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- javascript, typescript
調査の方向性
Start by inventorying the public methods in src/ARFset.js and related source files, then inspect examples for uses of nftMarkerCount and markerNFTCount. Done means the public API has TypeScript declarations, JSDoc with parameter and return information, and one consistent marker-count name throughout src/ and examples.
索引モデルが issue の本文から書いたものです。
説明
Summary
Add TypeScript declarations, JSDoc on all public methods, and resolve nftMarkerCount / markerNFTCount naming inconsistency
Environment
- Product/Service: FeatureSET-Display — JavaScript API
- Files:
src/ARFset.jsand related source files
Problem Description
Three related API-quality gaps:
- No type declarations: No
.d.tsfile exists, so TypeScript consumers get no type checking or IDE autocompletion. - No JSDoc: Public methods have no documentation, making the API opaque to new consumers.
- Naming inconsistency:
nftMarkerCount(field name) andmarkerNFTCount(local variable name) diverge — one of them is wrong, and the inconsistency is a footgun for callers.
Expected Behavior
- A
.d.tsdeclaration file (or TypeScript source) covers all public API surface. - Every public method has a JSDoc comment with parameter types, return type, and a one-line description.
nftMarkerCount/markerNFTCountare reconciled to a single consistent name throughout the codebase.
Actual Behavior
No type declarations, no JSDoc, inconsistent public naming.
Tasks
- Add TypeScript declarations (
.d.ts) — or convertsrc/to TypeScript outright - Add JSDoc on every public method
- Decide on naming:
nftMarkerCountvsmarkerNFTCountand rename consistently throughoutsrc/and any examples
Impact
Low — Developer experience and API usability. No runtime behavior change.
Additional Context
Converting src/ to TypeScript directly is the higher-value option (catches bugs at compile time, generates .d.ts automatically) but is a larger scope. Adding a hand-authored .d.ts is a quick win that unblocks TypeScript consumers immediately. The naming fix should happen regardless of which approach is chosen.
- 主要言語
- JavaScript
- スター
- 8
- フォーク
- 2
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
webarkit/FeatureSET-Display のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
-
難易度 4/5 3〜5日 初心者へのやさしさ 42/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 58/100
webarkit/FeatureSET-Display の issue をすべて見る
似ている issue
-
factory-active factory-automatic task-bug-reproduction-success task-identify-harness-labels-done task-identify-issue-type-done
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
メンテナーはふだん 1 日以内に返信
-
documentation
難易度 2/5 半日 初心者へのやさしさ 78/100
facioquo/stock-indicators-dotnet#2300 ·
メンテナーはふだん 1 日以内に返信
-
good first issue needs-triage priority: low
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
melodic-software/claude-code-plugins#6982 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
val() setter uses the first control's type for a mixed selection対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 半日 初心者へのやさしさ 85/100
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1〜3時間 初心者へのやさしさ 75/100
douglascrockford/Misty#35 ·
メンテナーはふだん 1 日以内に返信