okonet/lint-staged
Lint Staged
lint-staged is a git pre-commit task runner that executes linters and formatters specifically on files staged in git. It functions as a staged file filter and a monorepo task orchestrator, identifying the correct configuration and working directory for files across multiple packages in a repository.
The system automatically adds formatting changes back to the git stage after a successful task run. It uses a mechanism to match files in the git index against glob patterns to determine which tasks to execute and can automatically update git indices after formatting.
The project covers sequential command execution and concurrency control to prevent race conditions. It includes capabilities for git revision analysis, JavaScript-based configuration, and working state protection to prevent data loss during automated tasks.
Features
- Staged File Processors - Executes commands like linters or formatters exclusively against files currently staged in Git.
- Commit-Integrated Formatters - Automatically adds formatting changes back to the Git stage after a successful task run.
- Code Formatting Tools - Automatically applies formatting changes to files during the commit process to maintain consistent style.
- Staged Modification Integrators - Automatically re-stages files modified by formatters to ensure formatting changes are included in the current commit.
- Automated Index Modifiers - Automatically adds modifications from formatting tools back to the current commit if tools finish without errors.
- Staged File Indexers - Identifies modified files by querying the Git index to limit task execution to staged changes only.
- Monorepo Orchestration Tools - Identifies the correct configuration and working directory for files across multiple packages in a monorepo.
- Pre-Commit Quality Hooks - Runs linters and formatters only on staged files to ensure code quality before committing to a Git repository.
- Staged-File Task Runners - Executes linters and formatters specifically on files staged in Git before they are committed.
- Glob Pattern Selectors - Matches staged files against glob patterns to determine which specific files are passed as arguments to tasks.
- JavaScript-Configurable Automation Frameworks - Allows defining complex task logic and custom file matching through JavaScript functions instead of static glob patterns.
- Monorepo Hook Execution - Locates the nearest configuration file for a staged file and executes tasks within that specific package directory.
- Task Concurrency Control - Executes tasks in parallel or serially to prevent race conditions when multiple tools edit the same files.
- Sequential Task Execution - Executes a chain of commands in a specific order and halts the pipeline if any single task fails.
- Working Tree Management - Backs up the repository state and hides unstaged changes to ensure tools only modify intended files.
- Working Tree Protections - Backs up the repository and hides unstaged changes before running tasks to prevent data loss or accidental commits.
- Dynamic Configuration Evaluators - Resolves task definitions by executing JavaScript functions that calculate configuration objects at runtime based on staged files.
- Hierarchical Configuration Lookups - Searches upward from staged files to the nearest configuration file to support independent settings in monorepos.
- Quality Gates - Prevents buggy or unformatted code from entering the version control system by automating checks before the final commit.
- Build And Automation - Run linters on staged git files to ensure code quality.
- Code Quality Tools - Runs linters on staged Git files.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
