A platform for community discussion. Free, open, simple.
DEV: Make `bin/lint <file>` lint the working tree, not the staged blob (#40724)
Sérgio Saquetim94c7755c3efd
diff --git a/bin/lint b/bin/lintindex ea764d08165..fab35810ae9 100755--- a/bin/lint+++ b/bin/lint@@ -109,6 +109,19 @@ class LefthookLinterEVERYTHING = ["ALL FILES"]+ # In --staged mode we want to lint exactly what is in the index, so we use the+ # pre-commit/fix-staged hooks (which read the staged blobs). Every other mode+ # operates on what is currently on disk, so it routes to the lint-files/fix-files+ # hooks: those are not named pre-commit/pre-push, so lefthook does not hide+ # unstaged changes and the linters see the working-tree content.+ def check_hook+ @staged ? "pre-commit" : "lint-files"+ end++ def fix_hook+ @staged ? "fix-staged" : "fix-files"+ end+def runfiles = determine_files@@ -243,7 +256,7 @@ class LefthookLinterendcore, external = partition_files(files)- run_lefthook_command("fix-staged", core) if core.any?+ run_lefthook_command(fix_hook, core) if core.any?external.each do |root, fs|linter = ExternalLinter.new(root, fs, fix: true, verbose: @verbose)linter.run@@ -264,7 +277,7 @@ class LefthookLinterendcore, external = partition_files(files)- run_lefthook_command("pre-commit", core) if core.any?+ run_lefthook_command(check_hook, core) if core.any?external.each do |root, fs|linter = ExternalLinter.new(root, fs, fix: false, verbose: @verbose)linter.rundiff --git a/lefthook.yml b/lefthook.ymlindex 560e7c2d434..77e43dac453 100644--- a/lefthook.yml+++ b/lefthook.yml@@ -16,46 +16,41 @@ pre-commit:- rebasecommands:rubocop:- exclude:+ exclude: &ruby_exclude- "bin/notify_file_change"- "bin/docker/**/*"- glob:+ glob: &ruby_glob- "**/*.{rb,rake,thor}"- "bin/**/*"- "Gemfile"run: bundle exec rubocop --force-exclusion {staged_files}syntax_tree:- exclude:- - "bin/notify_file_change"- - "bin/docker/**/*"- glob:- - "**/*.{rb,rake,thor}"- - "bin/**/*"- - "Gemfile"+ exclude: *ruby_exclude+ glob: *ruby_globrun: bundle exec stree check Gemfile {staged_files}prettier:- glob:+ glob: &prettier_glob- "app/assets/stylesheets/**/*.{css,scss}"- "frontend/**/*.{js,gjs,scss,css,cjs,mjs}"- "plugins/**/*.{js,gjs,scss,css,cjs,mjs}"- "themes/**/*.{js,gjs,scss,css,cjs,mjs}"run: pnpm pprettier --list-different {staged_files}eslint:- glob:+ glob: &eslint_glob- "frontend/**/*.{js,gjs}"- "plugins/**/*.{js,gjs}"- "themes/**/*.{js,gjs}"run: pnpm eslint --max-warnings 0 {staged_files}yaml-syntax:- glob: "**/*.{yaml,yml}"+ glob: &yaml_glob "**/*.{yaml,yml}"# database.yml is an erb file not a yaml file- exclude: "config/database.yml"+ exclude: &yaml_exclude "config/database.yml"run: bundle exec yaml-lint {staged_files}i18n-lint:- glob: "**/{client,server}.en.yml"+ glob: &i18n_glob "**/{client,server}.en.yml"run: bundle exec ruby script/i18n_lint.rb {staged_files}stylelint:- glob:+ glob: &stylelint_glob- "app/assets/stylesheets/**/*.scss"- "plugins/**/assets/stylesheets/**/*.scss"- "themes/**/*.scss"@@ -65,43 +60,91 @@ fix-staged:parallel: falsecommands:prettier:- glob:- - "app/assets/stylesheets/**/*.{css,scss}"- - "frontend/**/*.{js,gjs,scss,css,cjs,mjs}"- - "plugins/**/*.{js,gjs,scss,css,cjs,mjs}"- - "themes/**/*.{js,gjs,scss,css,cjs,mjs}"+ glob: *prettier_globrun: pnpm pprettier --write {staged_files}eslint:- glob:- - "frontend/**/*.{js,gjs}"- - "plugins/**/*.{js,gjs}"- - "themes/**/*.{js,gjs}"+ glob: *eslint_globrun: pnpm eslint --fix {staged_files}stylelint:- glob:- - "app/assets/stylesheets/**/*.scss"- - "plugins/**/assets/stylesheets/**/*.scss"- - "themes/**/*.scss"+ glob: *stylelint_globrun: pnpm stylelint --fix {staged_files}rubocop:- exclude:- - "bin/notify_file_change"- - "bin/docker/**/*"- glob:- - "**/*.{rb,rake,thor}"- - "bin/**/*"- - "Gemfile"+ exclude: *ruby_exclude+ glob: *ruby_globrun: bundle exec rubocop --force-exclusion -A {staged_files}syntax_tree:- exclude:- - "bin/notify_file_change"- - "bin/docker/**/*"- glob:- - "**/*.{rb,rake,thor}"- - "bin/**/*"- - "Gemfile"+ exclude: *ruby_exclude+ glob: *ruby_globrun: bundle exec stree write Gemfile {staged_files}+# Working-tree counterparts of pre-commit/fix-staged. Deliberately NOT named+# pre-commit/pre-push so lefthook does not hide unstaged changes: the linters+# read the files exactly as they are on disk, not their staged blobs. bin/lint+# routes explicit-path, --recent, --unstaged and --wip runs here. The {files}+# template is overridden by the --file flag bin/lint passes; the files command+# is only the fallback when no --file is given and lists tracked plus untracked+# (but not ignored) paths.+lint-files:+ parallel: true+ commands:+ rubocop:+ files: &working_tree_files git ls-files --cached --others --exclude-standard+ exclude: *ruby_exclude+ glob: *ruby_glob+ run: bundle exec rubocop --force-exclusion {files}+ syntax_tree:+ files: *working_tree_files+ exclude: *ruby_exclude+ glob: *ruby_glob+ run: bundle exec stree check Gemfile {files}+ prettier:+ files: *working_tree_files+ glob: *prettier_glob+ run: pnpm pprettier --list-different {files}+ eslint:+ files: *working_tree_files+ glob: *eslint_glob+ run: pnpm eslint --max-warnings 0 {files}+ yaml-syntax:+ files: *working_tree_files+ glob: *yaml_glob+ exclude: *yaml_exclude+ run: bundle exec yaml-lint {files}+ i18n-lint:+ files: *working_tree_files+ glob: *i18n_glob+ run: bundle exec ruby script/i18n_lint.rb {files}+ stylelint:+ files: *working_tree_files+ glob: *stylelint_glob+ run: pnpm stylelint {files}++fix-files:+ parallel: false+ commands:+ prettier:+ files: *working_tree_files+ glob: *prettier_glob+ run: pnpm pprettier --write {files}+ eslint:+ files: *working_tree_files+ glob: *eslint_glob+ run: pnpm eslint --fix {files}+ stylelint:+ files: *working_tree_files+ glob: *stylelint_glob+ run: pnpm stylelint --fix {files}+ rubocop:+ files: *working_tree_files+ exclude: *ruby_exclude+ glob: *ruby_glob+ run: bundle exec rubocop --force-exclusion -A {files}+ syntax_tree:+ files: *working_tree_files+ exclude: *ruby_exclude+ glob: *ruby_glob+ run: bundle exec stree write Gemfile {files}+fix-all:parallel: falsecommands:@@ -114,32 +157,19 @@ fix-all:rubocop:run: bundle exec rubocop --force-exclusion -Asyntax_tree:- exclude:- - "bin/notify_file_change"- - "bin/docker/**/*"- glob:- - "**/*.{rb,rake,thor}"- - "bin/**/*"- - "Gemfile"+ exclude: *ruby_exclude+ glob: *ruby_globrun: bundle exec stree write Gemfile {all_files}lints:parallel: truecommands:rubocop:- glob:- - "**/*.{rb,rake,thor}"- - "bin/**/*"- - "Gemfile"+ glob: *ruby_globrun: bundle exec rubocopsyntax_tree:- exclude:- - "bin/notify_file_change"- - "bin/docker/**/*"- glob:- - "**/*.{rb,rake,thor}"- - "bin/**/*"- - "Gemfile"+ exclude: *ruby_exclude+ glob: *ruby_globrun: bundle exec stree check Gemfile {all_files}prettier:run: pnpm lint:prettier@@ -148,12 +178,12 @@ lints:stylelint:run: pnpm lint:cssyaml-syntax:- glob: "**/*.{yaml,yml}"+ glob: *yaml_glob# database.yml is an erb file not a yaml file- exclude: "config/database.yml"+ exclude: *yaml_excluderun: bundle exec yaml-lint {all_files}i18n-lint:- glob: "**/{client,server}.en.yml"+ glob: *i18n_globrun: bundle exec ruby script/i18n_lint.rb {all_files}glint:run: pnpm lint:types