Skip to content

Conversation

@jbampton
Copy link
Member

@jbampton jbampton commented Jan 8, 2026

This PR speeds up the prettier hook and avoids multiple passes through the targetted files.

Did you read the Contributor Guide?

Is this PR related to a ticket?

  • No:
    • this is a CI update. The PR name follows the format [CI] my subject

What changes were proposed in this PR?

How was this patch tested?

With pre-commit and manually edited some files.

From Google:

When to use pass_filenames: false

Directory-based linters/tools: Some tools, especially in languages like Go or Terraform, perform analysis based on the entire directory context. Passing individual files can lead to false positives (e.g., "unused symbol" errors).

Tools that manage their own file discovery: If your hook's entry command (e.g., a Makefile target or a specific CLI tool) already finds the required files to check, you should set pass_filenames: false to avoid passing extra command-line arguments that the tool might not handle correctly.

Performance: For large codebases, running a tool on the whole project (pass_filenames: false) might be slow. The default pass_filenames: true behavior is often recommended for faster local checks, as it only runs on the changed files.

Hooks that use always_run: true: When a hook is set to run regardless of which files have changed, you often also set pass_filenames: false so that the command runs once on the entire project as intended."


So the prettier hook uses an entry command that finds its own files:

entry: prettier --write '**/*.js' '**/*.yaml' '**/*.yml'

Did this PR include necessary documentation updates?

  • No, this PR does not affect any public API so no need to change the documentation.

This PR speeds up the prettier hook and avoids multiple passes through the targetted files.
@jbampton jbampton requested a review from jiayuasu as a code owner January 8, 2026 21:18
@github-actions github-actions bot added the root label Jan 8, 2026
@jiayuasu jiayuasu merged commit e34eea3 into apache:master Jan 9, 2026
10 checks passed
@jbampton jbampton deleted the prettier-pass-filenames-false branch January 9, 2026 05:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants