Regression: game.js still holds eight jobs in one 1,862-line scope

未關閉
#171 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
35/100
Issue 類型
重構
描述清晰度
基本清楚
活躍度
活躍
技術堆疊
javascript
領域
backend

研究方向

Read js/game.js alongside js/notation.js, js/saved-game.js, and js/rules.js; start with the proposed playersFromPGN and replayUndoStack extractions and add direct unit tests for them. Then review statusForOutcome, describeMove, and the material count, using tests/helpers/load-game.js and npm test as described. Done means steps 1–4 are extracted, each extraction is committed separately, and the full suite passes after each.

由索引模型根據 Issue 內容生成。

描述

severity: medium tech-debt

Summary

#89 split some UI code out (game-ui.js), but js/game.js is still one 1,862-line script. It shares about 30 mutable top-level lets across eight jobs and is the most-changed file in the repo (74 of the last 200 commits). Several functions in it are pure, or close to pure, and can move out with little risk.

Where

  • js/game.js:6-56: live state, about 30 lets
  • js/game.js:357-595: review and autoplay
  • js/game.js:1101-1215: clock
  • js/game.js:1345-1430: persistence and replay
  • js/game.js:1599-1764: PGN/FEN export and import
  • js/game.js:1766-1862: exports, including 15 getters only tests use

Details

The file's own section comments list its jobs: move flow, review and autoplay, ending a game without a move, the computer opponent, the clock, hints, persistence and replay, past games, view models, and PGN/FEN import and export.

Functions here that are pure or nearly pure:

  • replayUndoStack(start, moves, saved), around line 1400
  • playersFromPGN(text), around line 1720
  • statusForOutcome, around line 717
  • the material count in updateCapturedDisplay, around lines 1496-1501
  • isThreefoldRepetition, around line 1293

Impact

Every recent feature (Redo, the Play button, random side, rebuilding the undo stack on load) had to edit this file and keep all of its globals in mind. Pure logic in it can only be tested by loading the whole page in jsdom (tests/helpers/load-game.js).

Suggested fix

Extract in small PRs, pure code first. Keep the old global name as a one-line alias until its callers move, so every PR leaves the page working.

  1. Move playersFromPGN to notation.js.
  2. Move replayUndoStack to saved-game.js or rules.js, as rebuildUndoStack(start, moves, savedKey).
  3. Move statusForOutcome and the move sentence of describeMove into a small text module, or into review.js.
  4. Move the material count into rules.js as materialBalance(board).
  5. Only then consider extracting the clock section behind an object that game.js owns.

Acceptance criteria

  • Before starting: unit tests that call replayUndoStack and playersFromPGN directly, and characterization tests for the describeMove text of castling, en passant, promotion and check.
  • Each extraction is its own commit, and the full suite passes after each one.
  • game.js loses steps 1-4.

Getting started

  • Relevant files: js/game.js, js/notation.js, js/saved-game.js, js/rules.js, tests/helpers/load-game.js
  • How to run tests: npm test

Regression of #89.


Filed by repo-audit/full-audit at 01c6a35. Severity: medium. Effort: L. audit-key: tech-debt|js/game.js|module-structure

主要語言
JavaScript
星號
4
分支
2
平均合併
22 小時 16 分鐘
30 天內合併 PR
9

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

TMHSDigital/Static_Chess 的其他 Issue

查看 TMHSDigital/Static_Chess 的全部 Issue

相似的 Issue

更多 JavaScript Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。