Skip to content

style: fix all JSDoc lint warnings in scratch-gui #316

@takaokouji

Description

@takaokouji

Goal

scratch-gui パッケージの ESLint JSDoc ルールによる 23 個の warning をすべて除去し、lint を warning-free にする。

Affected Files

  • src/containers/ruby-downloader.jsx@param 名が関数引数と不一致(converted を削除)
  • src/containers/ruby-tab/furigana-renderer.js@param 不足(text, fontSize
  • src/lib/furigana-annotator.js@param 不足(source, node x2)
  • src/lib/furigana-call-helpers.js@param 不足(node, extensionName
  • src/lib/module-sync.js — ブロック説明後の余分な空行
  • src/lib/ruby-generator/data.js@param/@returns 不足 + @ruby エスケープ
  • src/lib/ruby-generator/face_sensing.js — JSDocコメント不足
  • src/lib/ruby-to-blocks-converter/looks.js@param 不足(converter, arg
  • src/lib/ruby-to-blocks-converter/node-utils.js@ruby エスケープ
  • src/lib/ruby-to-blocks-converter/variables.js@a エスケープ + Objectobject + @param 不足 + @ruby エスケープ
  • src/lib/version-checker.js@returns 説明不足

Implementation Steps

  • Phase 1: 全10ファイルのJSDocコメントを修正し、lint warning を 0 にする
    • @param 不足 → 追加
    • @param 名不一致 → 削除
    • @ruby/@a インラインタグ → バッククォートでエスケープ
    • Objectobject(型名小文字化)
    • @returns 不足/説明不足 → 追加
    • require-jsdoc → JSDocコメント追加
    • tag-lines → 余分な空行削除
    • lint 確認 → commit & push → PR 作成

Definition of Done

  • lint が warning 0 で pass
  • CI green

Test Plan

Type Timing Target
lint 修正後 npm run lint で warning 0 を確認
CI push 後 全テストスイートが green

Risks & Open Questions

なし。すべて機械的なJSDocコメントの修正であり、コードの動作には影響しない。

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions