feat: remove golangci-lint (aspect-build#207)

In preparation for 1.0, we want all linters to work correctly.
In the discussion for aspect-build#129 we decided that is a fatal bug, and no one is able to fix it in the short term.

We're happy to add Go linting back to rules_lint when someone has a correct implementation that handles transitive srcs.
The code will still be here in the git history when it's time to revive it.

Closes aspect-build#129

Author: alexeagle

MODULE.bazel

@@ -24,9 +24,6 @@ bazel_dep(name = "rules_proto", version = "6.0.0-rc2")
 bazel_dep(name = "rules_buf", version = "0.1.1")
 bazel_dep(name = "toolchains_protoc", version = "0.2.1")
 
-# Needed to get the 'go_context' symbol, to invoke golangci-lint
-bazel_dep(name = "rules_go", version = "0.39.1", repo_name = "io_bazel_rules_go")
-
 multitool = use_extension("@rules_multitool//multitool:extension.bzl", "multitool")
 multitool.hub(lockfile = "//format:multitool.lock.json")
 multitool.hub(lockfile = "//lint:multitool.lock.json")

README.md

@@ -24,7 +24,7 @@ New tools are being added frequently, so check this page again!
 | ---------------------- | --------------------- | ---------------- |
 | C / C++                | [clang-format]        | ([#112])         |
 | CSS                    | [Prettier]            |                  |
-| Go                     | [gofmt] or [gofumpt]  | [golangci-lint]  |
+| Go                     | [gofmt] or [gofumpt]  |                  |
 | HCL (Hashicorp Config) | [terraform] fmt       |                  |
 | HTML                   | [Prettier]            |                  |
 | JSON                   | [Prettier]            |                  |
@@ -63,7 +63,6 @@ New tools are being added frequently, so check this page again!
 [ruff]: https://docs.astral.sh/ruff/
 [shellcheck]: https://www.shellcheck.net/
 [shfmt]: https://github.com/mvdan/sh
-[golangci-lint]: https://github.com/golangci/golangci-lint
 [clang-format]: https://clang.llvm.org/docs/ClangFormat.html
 [#112]: https://github.com/aspect-build/rules_lint/issues/112
 [vale]: https://vale.sh/

docs/BUILD.bazel

@@ -37,11 +37,6 @@ stardoc_with_diff_test(
     bzl_library_target = "//lint:ruff",
 )
 
-stardoc_with_diff_test(
-    name = "golangci-lint",
-    bzl_library_target = "//lint:golangci-lint",
-)
-
 stardoc_with_diff_test(
     name = "shellcheck",
     bzl_library_target = "//lint:shellcheck",

docs/golangci-lint.md

@@ -92,6 +92,17 @@ By default, we filter out generated files from linting.
 
 To bypass this filter, add `tags=["lint-genfiles"]` to a target to force all the `srcs` to be linted.
 
+## Ignoring files explicitly
+
+Commonly, the underlying linters that rules_lint invokes provide their own methods of excluding files from linting (.prettierignore for example). At times when that is not the case, rules_lint provides its
+own escape hatch to exclude files from linting using attributes specified via [`.gitattributes` files](https://git-scm.com/docs/gitattributes).
+
+If any of following attributes are set on a file it will be excluded from linting:
+
+- `rules_lint_ignored`
+- `gitlab-generated`
+- `linguist-generated`
+
 ## Debugging
 
 Some linters honor the debug flag in this repo. To enable it, add a Bazel flag:

docs/linting.md

@@ -3,7 +3,6 @@ lint:
     - //tools/lint:linters.bzl%eslint
     - //tools/lint:linters.bzl%buf
     - //tools/lint:linters.bzl%flake8
-    - //tools/lint:linters.bzl%golangci_lint
     - //tools/lint:linters.bzl%pmd
     - //tools/lint:linters.bzl%ruff
     - //tools/lint:linters.bzl%vale

example/.aspect/cli/config.yaml

@@ -0,0 +1,7 @@
+# Do not try and format generated code
+pnpm-lock.yaml linguist-generated
+
+# Any of the below attributes can be set to ignore a file
+src/subdir/rules_lint_ignored.js rules_lint_ignored
+src/subdir/gitlab-generated.js gitlab-generated
+src/subdir/linguist-generated.js linguist-generated

example/.gitattributes

@@ -19,7 +19,6 @@ exports_files(
         ".ruff.toml",
         ".shellcheckrc",
         ".scalafmt.conf",
-        ".golangci.yaml",
         ".vale.ini",
     ],
     visibility = ["//visibility:public"],

example/.golangci.yaml

@@ -24,7 +24,7 @@ filter='.namedSetOfFiles | values | .files[] | ((.pathPrefix | join("/")) + "/"
 
 # NB: perhaps --remote_download_toplevel is needed as well with remote execution?
 args=(
-	"--aspects=$(echo //tools/lint:linters.bzl%{buf,eslint,flake8,pmd,ruff,shellcheck,golangci_lint,vale} | tr ' ' ',')"
+	"--aspects=$(echo //tools/lint:linters.bzl%{buf,eslint,flake8,pmd,ruff,shellcheck,vale} | tr ' ' ',')"
 	"--build_event_json_file=$buildevents"
 )
 report_args=(

example/BUILD.bazel

@@ -1,4 +1,4 @@
 /* eslint-env node */
 const base = require("../../.eslintrc.cjs");
-base["rules"] = { "no-debugger": 0 };
+base["rules"] = {   "no-debugger": 0, "no-console": 1 };
 module.exports = base;

example/lint.sh

@@ -16,5 +16,5 @@ js_library(
 
 js_library(
     name = "eslint-override",
-    srcs = ["index.js"],
+    srcs = glob(["*.js"]),
 )

example/src/subdir/.eslintrc.cjs

@@ -0,0 +1,2 @@
+// Ignored by https://github.com/aspect-build/rules_lint/blob/example/.gitattributes
+console.log("This is an intentional lint error");

example/src/subdir/BUILD.bazel

@@ -0,0 +1,2 @@
+// Ignored by https://github.com/aspect-build/rules_lint/blob/example/.gitattributes
+console.log("This is an intentional lint error");

example/src/subdir/gitlab-generated.js

@@ -28,9 +28,6 @@ EOF
 	# Buf
 	assert_output --partial 'src/file.proto:1:1:Import "src/unused.proto" is unused.'
 
-	# Golangci-lint
-	assert_output --partial 'src/hello.go:13:2: SA1006: printf-style function with dynamic format string and no further arguments should use print-style function instead (staticcheck)'
-
 	# Vale
 	assert_output --partial "src/README.md:3:47:Google.We:Try to avoid using first-person plural like 'We'."
 }

example/src/subdir/linguist-generated.js

@@ -3,7 +3,6 @@
 load("@aspect_rules_lint//lint:buf.bzl", "lint_buf_aspect")
 load("@aspect_rules_lint//lint:eslint.bzl", "lint_eslint_aspect")
 load("@aspect_rules_lint//lint:flake8.bzl", "lint_flake8_aspect")
-load("@aspect_rules_lint//lint:golangci-lint.bzl", "lint_golangci_aspect")
 load("@aspect_rules_lint//lint:lint_test.bzl", "lint_test")
 load("@aspect_rules_lint//lint:pmd.bzl", "lint_pmd_aspect")
 load("@aspect_rules_lint//lint:ruff.bzl", "lint_ruff_aspect")
@@ -57,13 +56,6 @@ shellcheck = lint_shellcheck_aspect(
 
 shellcheck_test = lint_test(aspect = shellcheck)
 
-golangci_lint = lint_golangci_aspect(
-    binary = "@multitool//tools/golangci-lint",
-    config = "@@//:.golangci.yaml",
-)
-
-golangci_lint_test = lint_test(aspect = golangci_lint)
-
 vale = lint_vale_aspect(
     binary = "@@//tools/lint:vale",
     config = "@@//:.vale.ini",

example/src/subdir/rules_lint_ignored.js

@@ -94,9 +94,22 @@ function ls-files {
 
         # TODO: determine which staged changes we should format; avoid formatting unstaged changes
         # TODO: try to format only modified regions of the file (where supported)
-        git ls-files --cached --modified --other --exclude-standard "${patterns[@]}" "${patterns[@]/#/*/}" | {
-          grep -vE "^$(git ls-files --deleted)$" || true;
-        }
+        files=$(git ls-files --cached --modified --other --exclude-standard "${patterns[@]}" "${patterns[@]/#/*/}" | {
+          grep -vE \
+            "^$(git ls-files --deleted)$" \
+          || true;
+        })
+        git_attributes=$(git check-attr -a -- $files)
+        non_ignored_files=()
+        for file in $files; do
+            # Check if any of the attributes we ignore are set for this file.
+            if ! grep -qE "(^| )$file: (rules_lint_ignored|linguist-generated|gitlab-generated): set($| )" <<< $git_attributes; then
+                non_ignored_files+=("$file")
+            fi
+        done
+        if [ ${#non_ignored_files[@]} -gt 0 ]; then
+            echo "${non_ignored_files[@]}"
+        fi
     else
         # When given arguments, they are glob patterns of the superset of files to format.
         # We just need to filter those so we only select files for this language

example/test/lint_test.bats

@@ -118,16 +118,6 @@ bzl_library(
     ],
 )
 
-bzl_library(
-    name = "golangci-lint",
-    srcs = ["golangci-lint.bzl"],
-    visibility = ["//visibility:public"],
-    deps = [
-        "//lint/private:lint_aspect",
-        "@io_bazel_rules_go//go:def",
-    ],
-)
-
 bzl_library(
     name = "shellcheck",
     srcs = ["shellcheck.bzl"],