gchq/CyberChef

Feature request: Add Prettier

Open

#1,726 建立於 2024年2月19日

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)JavaScript (34,843 star) (3,944 fork)batch import
featurehelp wantedimprovement

描述

Problem The code base, despite existing linting rules, lacks consistent formatting, leading to:

  • Reduced Readability: Inconsistent indentation, spacing, and wrapping make code harder to understand for all developers.
  • Manual Formatting Waste: Developers spend time manually formatting instead of focusing on logic and functionality.

Solution Introduce Prettier as a code formatter base on the coding conventions to enforce consistent formatting, improving readability and freeing developer time for higher-level tasks

貢獻者指南

技術棧
javascripthtmlcssnodejs
領域
frontenddeveloper experiencetooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaScriptnpmbasic understanding of code formatting
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
80
研究方向
The issue requests adding Prettier as a code formatter to enforce consistent formatting. The contributor should review the existing coding conventions linked in the issue, create a Prettier configuration file (e.g., .prettierrc) that aligns with those conventions, install Prettier as a dev dependency, add a format script to package.json, and optionally run Prettier across the codebase. The work is well defined and localized, making it suitable for newcomers.