Kanaries/graphic-walker

Feature Request: Pre-commit hook for automatic Prettier formatting

Open

#245 opened on Nov 21, 2023

View on GitHub
 (2 comments) (1 reaction) (0 assignees)TypeScript (186 forks)auto 404
good first issue

Repository metrics

Stars
 (3,179 stars)
PR merge metrics
 (PR metrics pending)

Description

Problem

Currently, the codebase doesn't seem to have an automated way to format code with Prettier before commits, which can result in formatting inconsistencies and extra manual work.

Suggested Solution

It might be beneficial for the project to use a pre-commit hook mechanism like Husky and lint-staged to automatically format staged files with Prettier upon commit. This would ensure code formatting stays consistent and reduces the manual effort required for code formatting.

Benefits

  • Consistent code formatting across all contributions
  • Less manual intervention and potential human error
  • Streamlined code review process focusing on the code quality rather than formatting

Implementation

If this feature request is accepted, I would be happy to work on it or assist in any way possible. I can contribute a PR including the Husky setup and the necessary lint-staged configuration.

Thank you for considering this suggestion, and I look forward to hearing your thoughts.

Contributor guide

Research direction
Review the project's package.json and existing configuration files to understand the current setup, then implement Husky and lint staged hooks for Prettier formatting.
Tech stack
typescriptnodejs
Domain
developer 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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.js
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80