lint-staged/lint-staged
Lint Staged
Lint-staged is a command-line utility designed to automate code quality checks and formatting tasks within a Git repository. It functions as a pre-commit hook runner that executes defined operations exclusively on files currently staged for commit, ensuring that only code meeting project standards is permanently saved.
The tool distinguishes itself by providing granular control over the development workflow through file filtering and task orchestration. It uses glob-pattern matching to isolate specific file types and executes sequences of shell commands in a strict order. To maintain repository integrity, it manages task concurrency and preserves the working directory state, automatically rolling back changes if any step in the execution sequence fails.
This utility supports a range of repository automation tasks, including automated code formatting and validation, by integrating directly into the commit process. It is configured through standard project files and is intended for use as part of a local development environment.
Features
- Git Hook Managers - Executes code quality checks and formatting commands exclusively on files staged for commit in a Git repository.
- Git Workflow Automation - Manages task execution sequences and file filtering to ensure consistent code standards before every commit.
- Commit Checkers - Ensures that only code meeting project standards is committed by automatically running linters and formatters on staged files.
- Code Formatting Tools - Maintains consistent code style across a repository by automatically applying formatting rules to files before they are permanently saved.
- Pre-commit Hooks - Streamlines the development process by executing essential validation tasks automatically during the commit phase to prevent broken code.
- Task Automation Tools - Runs complex sequences of shell commands on specific subsets of files to maintain project integrity and enforce development policies.
- Version Control Stashing - Creates a temporary backup of the working directory using version control primitives to ensure a clean environment during task execution.
- Staged File Indexers - Identifies the subset of files currently staged for commit by querying the version control system index before executing any tasks.
- File Pattern Matching - Filters the list of staged files against user-defined path patterns to isolate specific file types for targeted processing.
- Sequential Execution Engines - Executes a defined pipeline of commands in a strict order where each step must complete successfully before the next begins.
