config.js flags, storage keys and defaults are ignored by the code

Đang mở
  • Có gì không ổn?
#29 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tái cấu trúc
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
backend, developer-experience, testing

Hướng nghiên cứu

Start with js/config.js, then trace the listed reads in js/game.js, js/main.js, js/utils.js, and js/board.js; review docs/ARCHITECTURE.md and .github/CONTRIBUTING.md for project conventions. Run npm test and npm run lint to establish the current behavior. Done when every config entry is used or removed, existing saved games still load through centralized storage keys, and no debug output appears with CONFIG.DEBUG false.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

severity: medium tech-debt

Summary

js/config.js is documented as the central configuration, but most of it is never read. Changing a flag or a storage key there changes nothing.

Where

  • js/config.js:8-53
  • js/game.js:45-48, js/game.js:91, js/game.js:671, js/game.js:682
  • js/main.js:19-22, js/main.js:68-70, js/main.js:89-90
  • js/utils.js:90-120, js/board.js:80

Details

  • FEATURES.UNDO_MOVE is false, yet undo is always wired and advertised.
  • STORAGE_KEYS defines staticChess.gameState and staticChess.settings; the code uses the literals chessGameState, showCoords, showPossibleMoves, showLastMove and enableSounds.
  • DEFAULT_SETTINGS, BOARD_SIZE, ANIMATIONS, GAME_TIMER and ADVANCED_DRAW_DETECTION are never read. The 300 ms animation is hard-coded at js/board.js:80.
  • FEATURES.SOUND_EFFECTS is overwritten at startup from the toggle.
  • initializeFeatureModules forces CONFIG.DEBUG = true during init, so debug lines print in production.
  • game.js logs with raw console.log on every move while drag.js uses debugLog.
  • saveToLocalStorage and loadFromLocalStorage have no callers.

Impact

Contributors following the docs flip flags that have no effect. Anyone who later adopts CONFIG.STORAGE_KEYS.GAME_STATE will orphan every saved game.

Suggested fix

  1. Add a save/load round-trip test for game state.
  2. Point CONFIG.STORAGE_KEYS at the keys in use today so no saved data is lost, then route game.js and main.js through the storage helpers.
  3. Read toggle defaults from DEFAULT_SETTINGS; use CONFIG.ANIMATIONS.PIECE_MOVE in board.js.
  4. Make UNDO_MOVE gate the button or delete it; delete flags with no code behind them.
  5. Remove the forced CONFIG.DEBUG = true and route logging through debugLog.

Each step leaves the app working and can be reviewed alone.

Acceptance criteria

  • Every entry in CONFIG is read somewhere, or removed
  • Storage keys come from one place and existing saved games still load
  • No debug output when CONFIG.DEBUG is false

Getting started

  • Relevant files: js/config.js, js/game.js, js/main.js, js/utils.js, js/board.js
  • How to run tests: npm install, then npm test and npm run lint
  • Related docs: docs/ARCHITECTURE.md, .github/CONTRIBUTING.md

Filed by repo-audit/full-audit at 8a2c86c. Severity: medium. Effort: M. audit-key: tech-debt|js/config.js|CONFIG

Ngôn ngữ chính
JavaScript
Star
4
Fork
2
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/Static_Chess

Tất cả issue của TMHSDigital/Static_Chess

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.