pre-commit-review

Run lint, format, and type-check commands on staged and unstaged code changes.

10|38|Updated May 6, 2024
One-click install
npx skills add https://github.com/Women-Coding-Community/wcc-frontend --skill pre-commit-review-women-coding-community
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pre-commit-review
Source: https://github.com/Women-Coding-Community/wcc-frontend/tree/main/.claude/skills/pre-commit-review
Command: npx skills add https://github.com/Women-Coding-Community/wcc-frontend --skill pre-commit-review-women-coding-community

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires prettier, eslint, typescript, and includes scripts (resource) components.

What problem does it solve?

This Skill automates the review of local staged and unstaged changes before committing to the codebase, ensuring code quality and consistency.

Core Features & Use Cases

  • Quality Checks: Executes lint, format, and type-check commands to enforce code quality.
  • Local Change Review: Identifies changes in both staged and unstaged code, allowing developers to review them before committing.
  • Error Reporting: Provides line-level findings with severity levels, guiding the necessary code improvements.

Quick Start

Run the pre-commit-review skill to automate code quality checks.

Frequently Asked Questions about pre-commit-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate code quality checks before committing changes?

Automating code quality checks before committing involves running linting, formatting, and type-checking commands on staged and unstaged code. This process enforces code health and consistency by identifying necessary improvements before code enters the repository.

What is a pre-commit review and when do I need it?

A pre-commit review is an automated code quality validation process that executes lint, format, and type checks on local changes. You need it to catch errors and enforce consistency before committing code to the repository.

Does the pre-commit review work with TypeScript, ESLint, and Prettier?

Yes, the pre-commit review runs quality checks using TypeScript, ESLint, and Prettier. These dependencies enable the Skill to execute comprehensive linting, formatting, and type-checking on your local code changes.

How do I get line-level error reporting for local code changes?

To get line-level error reporting for local code changes, run a pre-commit review that identifies issues in both staged and unstaged code. It provides findings with severity levels to guide necessary code improvements before committing.

What is the best way to enforce code consistency in continuous integration?

The best way to enforce code consistency in continuous integration is automating pre-commit reviews that execute lint, format, and type-check commands. This ensures all code changes meet quality standards before entering the repository.

Why does pre-commit linting review both staged and unstaged code?

Pre-commit linting reviews both staged and unstaged code to give developers a complete view of local changes. Identifying issues across all local modifications ensures comprehensive code health before committing to the repository.