gchq/CyberChef

Feature request: Add Prettier

Open

#1726 opened on Feb 19, 2024

View on GitHub
 (3 comments) (0 reactions) (0 assignees)JavaScript (34,843 stars) (3,944 forks)batch import
featurehelp wantedimprovement

Description

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

Contributor guide

Tech stack
javascripthtmlcssnodejs
Domain
frontenddeveloper experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaScriptnpmbasic understanding of code formatting
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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.