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

docs/linting.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:

example/.gitattributes

@@ -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/src/subdir/.eslintrc.cjs

@@ -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/src/subdir/BUILD.bazel

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

example/src/subdir/gitlab-generated.js

@@ -0,0 +1,2 @@
+// Ignored by https://github.com/aspect-build/rules_lint/blob/example/.gitattributes
+console.log("console is not allowed, but this file is ignored");

example/src/subdir/linguist-generated.js

@@ -0,0 +1,2 @@
+// Ignored by https://github.com/aspect-build/rules_lint/blob/example/.gitattributes
+console.log("console is not allowed, but this file is ignored");

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