gchq/CyberChef

Feature request: Add Prettier

Open

Aperta il 19 feb 2024

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)JavaScript (34.843 star) (3944 fork)batch import
featurehelp wantedimprovement

Descrizione

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

Guida contributor

Tech stack
javascripthtmlcssnodejs
Dominio
frontenddeveloper experiencetooling
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
JavaScriptnpmbasic understanding of code formatting
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80
Direzione di ricerca
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.