dart_lint_staged 1.0.0

Run linters on git staged files for your Flutter and Dart projects. Improved fork of lint_staged with JS lint-staged-style batched commands.

dart_lint_staged

Run linters on git staged files for your Flutter and Dart projects.

This package is a fork of hyiso/lint_staged, updated to match the JavaScript lint-staged model: each command receives the matched staged files in one invocation, and concurrency defaults to the number of CPU cores so large commits do not hang the machine.

Improvements over the original

• Batched commands: one process runs dart format a.dart b.dart …
• Bounded concurrency: --processes defaults to CPU count (no unbounded fan-out)
• Safer process pool: no post-run PID kill; iterative workers

Config lives under the dart_lint_staged: key in pubspec.yaml. The legacy lint_staged: key is still read as a fallback.

Why

Full-project lint slows commits and surfaces noise from untouched files. Run hooks only on staged files so the check matches what you are about to commit.

Installation and setup

1. Install dart_lint_staged:
   • dart pub add --dev dart_lint_staged
2. Set up the pre-commit git hook to run dart_lint_staged
   • Husky is a recommended choice for configuring git hooks
   • Git hooks docs: git-scm.com
3. Configure tasks in pubspec.yaml:

   dart_lint_staged:
     'lib/**.dart': dart format && dart fix --apply
   

   • See Configuration for more info

Don't forget to commit changes to pubspec.yaml and .husky to share this setup with your team!

Changelog

See CHANGELOG.md.

Command line flags

❯ dart run dart_lint_staged --help
Usage: dart_lint_staged [options]

Options:
  --allow-empty                      allow empty commits when tasks revert all staged changes (default: false)
  --diff [string]                    override the default "--staged" flag of "git diff" to get list of files. Implies
                                     "--no-stash".
  --diff-filter [string]             override the default "--diff-filter=ACMR" flag of "git diff" to get list of files
  --no-stash                         disable the backup stash, and do not revert in case of errors
  --processes, -p [int]              maximum concurrent processes (default: number of CPU cores)

• --allow-empty: By default, when linter tasks undo all staged changes, dart_lint_staged will exit with an error and abort the commit. Use this flag to allow creating empty git commits.
• --diff: Override --staged with arbitrary revisions (e.g. --diff="branch1...branch2"). Implies --no-stash.
• --diff-filter: Override the default ACMR filter. See git diff --diff-filter.
• --no-stash: Disable the backup stash (and revert on error).
• --processes: Cap concurrent processes (must be >= 1). Defaults to Platform.numberOfProcessors.

Configuration

Configure in your pubspec.yaml:

dart_lint_staged:
  'lib/**.dart': your-cmd

This runs your-cmd with all matching staged files passed as arguments (chunked if the argv would exceed platform limits).

Filtering files

Linter commands work on a subset of all staged files, defined by a glob pattern. dart_lint_staged uses glob for matching.

Exclude pattern: !

dart_lint_staged:
  'lib/**.dart': your-cmd
  '!lib/**.g.dart': your-cmd

This includes all .dart files but excludes .g.dart files.

What commands are supported?

Any executables on your $PATH (for example dart, flutter). Commands are not run through a shell: no quoting, pipes or globbing; only && chaining is supported.

dart_lint_staged uses Process.run to run commands. Pass arguments separated by spaces; there is no shell, so quotes are passed literally.

Running multiple commands in a sequence

Join commands with &&. They run sequentially (a failure stops the chain); each receives the batched file list. If several globs match the same file, their commands also run one after another in config order:

dart_lint_staged:
  'lib/**.dart': dart format && dart fix --apply

Examples

In .husky/pre-commit:

#!/usr/bin/env sh
. "$(dirname "$0")/_/husky.sh"

dart run dart_lint_staged

For faster hooks, skip dart run startup by running dart pub global activate dart_lint_staged and calling dart_lint_staged directly in the hook.

Note: do not pass file paths yourself; dart_lint_staged appends staged files for you.

Format staged Dart files

dart_lint_staged:
  'lib/**.dart': dart format

Apply fixes to staged Dart files

dart_lint_staged:
  'lib/**.dart': dart fix --apply

Programmatic API

import 'package:dart_lint_staged/dart_lint_staged.dart';

final success = await lintStaged(
  allowEmpty: false,
  stash: true,
);

Attribution

Based on lint_staged by hyiso (Apache-2.0), itself inspired by JS lint-staged.

License

Apache License 2.0. See LICENSE and NOTICE.