build(deps-dev): bump @typescript-eslint/eslint-plugin from 7.6.0 to 7.7.0 (#1023)

Co-authored-by: Fernandez Ludovic <ldez@users.noreply.github.com>

.gitattributes

@@ -0,0 +1 @@
+dist/** linguist-generated=true

.github/release.yml

@@ -0,0 +1,15 @@
+changelog:
+  categories:
+    - title: Changes
+      labels:
+        - '*'
+      exclude:
+        labels:
+          - documentation
+          - dependencies
+    - title: Documentation
+      labels:
+        - documentation
+    - title: Dependencies
+      labels:
+        - dependencies

.github/workflows/codeql.yaml

@@ -16,7 +16,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           # Must fetch at least the immediate parents so that if this is
           # a pull request then we can checkout the head of the pull request.
@@ -31,7 +31,7 @@ jobs:
 
       # Initializes the CodeQL tools for scanning.
       - name: Initialize CodeQL
-        uses: github/codeql-action/init@v2
+        uses: github/codeql-action/init@v3
         # Override language selection by uncommenting this and choosing your languages
         with:
           language: 'javascript'
@@ -41,4 +41,4 @@ jobs:
           npm run all
 
       - name: Perform CodeQL Analysis
-        uses: github/codeql-action/analyze@v2
+        uses: github/codeql-action/analyze@v3

.github/workflows/test.yml

@@ -11,9 +11,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - if: ${{ !(github.event_name == 'pull_request' && (github.event.pull_request.user.id == 49699333 || contains(github.event.pull_request.labels.*.name, 'dependencies'))) }}
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - if: github.event_name == 'pull_request' && (github.event.pull_request.user.id == 49699333 || contains(github.event.pull_request.labels.*.name, 'dependencies'))
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           ref: ${{ github.event.pull_request.head.ref }}
@@ -52,16 +52,17 @@ jobs:
         version:
           - ""
           - "latest"
-          - "v1.53"
-          - "v1.53.2"
+          - "v1.56"
+          - "v1.56.1"
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read
       pull-requests: read
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
+          go-version: oldstable
           cache: false # setup-go v4 caches by default
       - uses: ./
         with:
@@ -80,16 +81,17 @@ jobs:
         version:
           - ""
           - "latest"
-          - "v1.53.2"
-          - "b5093688c0d3008eaacd6066773a1a52e689252f"
+          - "v1.56.1"
+          - "bf5008a11acf2da5fe76716eb21d808499e079fa"
     runs-on: ${{ matrix.os }}
     permissions:
       contents: read
       pull-requests: read
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
+          go-version: oldstable
           cache: false # setup-go v4 caches by default
       - uses: ./
         with:
@@ -110,9 +112,10 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
+          go-version: oldstable
           cache: false # setup-go v4 caches by default
       - uses: ./
         with:

README.md

@@ -9,7 +9,7 @@ The action runs [golangci-lint](https://github.com/golangci/golangci-lint) and r
 
 ## Compatibility
 
-* `v3.0.0+` requires explicit setup-go installation step prior to using this action: `uses: actions/setup-go@v3`.
+* `v4.0.0+` requires an explicit setup-go installation step before using this action: `uses: actions/setup-go@v5`.
   The `skip-go-installation` option has been removed.
 * `v2.0.0+` works with `golangci-lint` version >= `v1.28.3`
 * `v1.2.2` is deprecated due to we forgot to change the minimum version of `golangci-lint` to `v1.28.3` ([issue](https://github.com/golangci/golangci-lint-action/issues/39))
@@ -38,40 +38,42 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
-          go-version: '1.20'
+          go-version: '1.21'
           cache: false
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
-          # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.53
+          # Require: The version of golangci-lint to use.
+          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
+          version: v1.54
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
 
           # Optional: golangci-lint command line arguments.
-          # 
-          # Note: by default the `.golangci.yml` file should be at the root of the repository.
+          #
+          # Note: By default, the `.golangci.yml` file should be at the root of the repository.
           # The location of the configuration file can be changed by using `--config=`
           # args: --timeout=30m --config=/my/path/.golangci.yml --issues-exit-code=0 
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true
 
-          # Optional: if set to true then the all caching functionality will be complete disabled,
+          # Optional: if set to true, then all caching functionality will be completely disabled,
           #           takes precedence over all other caching options.
           # skip-cache: true
 
-          # Optional: if set to true then the action don't cache or restore ~/go/pkg.
+          # Optional: if set to true, then the action won't cache or restore ~/go/pkg.
           # skip-pkg-cache: true
 
-          # Optional: if set to true then the action don't cache or restore ~/.cache/go-build.
+          # Optional: if set to true, then the action won't cache or restore ~/.cache/go-build.
           # skip-build-cache: true
-          
-          # Optional:The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
+
+          # Optional: The mode to install golangci-lint. It can be 'binary' or 'goinstall'.
           # install-mode: "goinstall"
 ```
 
@@ -80,7 +82,7 @@ because different jobs [run in parallel](https://help.github.com/en/actions/gett
 
 ### Multiple OS Support
 
-If you need to run linters for specific operating systems, you will need to use `v2` of the action.  Here is a sample configuration file:
+If you need to run linters for specific operating systems, you will need to use the action `>=v2`.  Here is a sample configuration file:
 
 ```yaml
 name: golangci-lint
@@ -100,21 +102,23 @@ jobs:
   golangci:
     strategy:
       matrix:
-        go: ['1.20']
+        go: ['1.21']
         os: [macos-latest, windows-latest]
     name: lint
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-go@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
           cache: false
       - name: golangci-lint
-        uses: golangci/golangci-lint-action@v3
+        uses: golangci/golangci-lint-action@v4
         with:
-          # Require: version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version
-          version: v1.53
+          # Require: The version of golangci-lint to use.
+          # When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+          # When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
+          version: v1.54
 
           # Optional: working directory, useful for monorepos
           # working-directory: somedir
@@ -132,7 +136,7 @@ jobs:
           # install-mode: "goinstall"
 ```
 
-You will also likely need to add the following `.gitattributes` file to ensure that line endings for windows builds are properly formatted:
+You will also likely need to add the following `.gitattributes` file to ensure that line endings for Windows builds are properly formatted:
 
 ```.gitattributes
 *.go text eol=lf
@@ -140,12 +144,24 @@ You will also likely need to add the following `.gitattributes` file to ensure t
 
 ## Comments and Annotations
 
-Currently, GitHub parses the action's output and creates [annotations](https://github.community/t5/GitHub-Actions/What-are-annotations/td-p/30770).
+Currently, GitHub parses the action's output and creates [annotations](https://github.blog/2018-12-14-introducing-check-runs-and-annotations/).
 
 The restrictions of annotations are the following:
 
 1. Currently, they don't support markdown formatting (see the [feature request](https://github.community/t5/GitHub-API-Development-and/Checks-Ability-to-include-Markdown-in-line-annotations/m-p/56704))
-2. They aren't shown in list of comments like it was with [golangci.com](https://golangci.com). If you would like to have comments - please, up-vote [the issue](https://github.com/golangci/golangci-lint-action/issues/5).
+2. They aren't shown in the list of comments like it was with [golangci.com](https://golangci.com). If you would like to have comments - please, up-vote [the issue](https://github.com/golangci/golangci-lint-action/issues/5).
+
+To enable annotations, you need to add the `checks' permission to your action.
+
+```yaml annotate
+permissions:
+  # Required: allow read access to the content for analysis.
+  contents: read
+  # Optional: allow read access to pull request. Use with `only-new-issues` option.
+  pull-requests: read
+  # Optional: Allow write access to checks to allow the action to annotate code in the PR.
+  checks: write
+```
 
 ## Performance
 
@@ -153,7 +169,7 @@ The action was implemented with performance in mind:
 
 1. We cache data by [@actions/cache](https://github.com/actions/toolkit/tree/master/packages/cache) between builds: Go build cache, Go modules cache, golangci-lint analysis cache.
 2. We don't use Docker because image pulling is slow.
-3. We do as much as we can in parallel, e.g. we download cache, go and golangci-lint binary in parallel.
+3. We do as much as we can in parallel, e.g. we download cache, go, and golangci-lint binary in parallel.
 
 For example, in a repository of [golangci-lint](https://github.com/golangci/golangci-lint) running this action without the cache takes 50s, but with cache takes 14s:
   * in parallel:
@@ -168,12 +184,12 @@ We use JavaScript-based action. We don't use Docker-based action because:
 1. docker pulling is slow currently
 2. it's easier to use caching from [@actions/cache](https://github.com/actions/toolkit/tree/master/packages/cache)
 
-We support different platforms, such as `ubuntu`, `macos` and `windows` with `x32` and `x64` archs.
+We support different platforms, such as `ubuntu`, `macos`, and `windows` with `x32` and `x64` archs.
 
-Inside our action we perform 3 steps:
+Inside our action, we perform 3 steps:
 
 1. Setup environment running in parallel:
-  * restore [cache](https://github.com/actions/cache) of previous analyzes
+  * restore [cache](https://github.com/actions/cache) of previous analyses
   * fetch [action config](https://github.com/golangci/golangci-lint/blob/master/assets/github-action-config.json) and find the latest `golangci-lint` patch version
     for needed version (users of this action can specify only minor version of `golangci-lint`). After that install [golangci-lint](https://github.com/golangci/golangci-lint) using [@actions/tool-cache](https://github.com/actions/toolkit/tree/master/packages/tool-cache)
 2. Run `golangci-lint` with specified by user `args`

action.yml

@@ -3,7 +3,10 @@ description: "Official golangci-lint action with line-attached annotations for f
 author: "golangci"
 inputs:
   version:
-    description: "version of golangci-lint to use in form of v1.2 or v1.2.3 or `latest` to use the latest version"
+    description: |
+      The version of golangci-lint to use.
+      When `install-mode` is `binary` (default) the value can be v1.2 or v1.2.3 or `latest` to use the latest version.
+      When `install-mode` is `goinstall` the value can be v1.2.3, `latest`, or the hash of a commit.
     required: false
   args:
     description: "golangci-lint command line arguments"
@@ -18,28 +21,28 @@ inputs:
     required: false
   only-new-issues:
     description: "if set to true and the action runs on a pull request - the action outputs only newly found issues"
-    default: false
+    default: 'false'
     required: false
   skip-cache:
     description: |
       if set to true then the all caching functionality will be complete disabled,
       takes precedence over all other caching options.
-    default: false
+    default: 'false'
     required: false
   skip-pkg-cache:
     description: "if set to true then the action doesn't cache or restore ~/go/pkg."
-    default: false
+    default: 'false'
     required: false
   skip-build-cache:
     description: "if set to true then the action doesn't cache or restore ~/.cache/go-build."
-    default: false
+    default: 'false'
     required: false
   install-mode:
     description: "The mode to install golangci-lint. It can be 'binary' or 'goinstall'."
     default: "binary"
     required: false
 runs:
-  using: "node16"
+  using: "node20"
   main: "dist/run/index.js"
   post: "dist/post_run/index.js"
 branding:

package.json

@@ -24,27 +24,27 @@
   "author": "golangci",
   "license": "MIT",
   "dependencies": {
-    "@actions/cache": "^3.2.1",
-    "@actions/core": "^1.10.0",
+    "@actions/cache": "^3.2.4",
+    "@actions/core": "^1.10.1",
     "@actions/exec": "^1.1.1",
-    "@actions/github": "^5.1.1",
-    "@actions/http-client": "^2.1.0",
+    "@actions/github": "^6.0.0",
+    "@actions/http-client": "^2.2.1",
     "@actions/tool-cache": "^2.0.1",
-    "@types/node": "^20.2.5",
-    "@types/semver": "^7.5.0",
-    "@types/tmp": "^0.2.3",
-    "tmp": "^0.2.1"
+    "@types/node": "^20.12.7",
+    "@types/semver": "^7.5.8",
+    "@types/tmp": "^0.2.6",
+    "tmp": "^0.2.3"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.59.8",
-    "@typescript-eslint/parser": "^5.59.8",
-    "@vercel/ncc": "^0.36.1",
-    "eslint": "^8.42.0",
-    "eslint-config-prettier": "^8.8.0",
-    "eslint-plugin-import": "^2.27.5",
-    "eslint-plugin-prettier": "^4.2.1",
-    "eslint-plugin-simple-import-sort": "^10.0.0",
-    "prettier": "^2.8.8",
-    "typescript": "^5.1.3"
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
+    "@vercel/ncc": "^0.38.1",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-simple-import-sort": "^12.1.0",
+    "prettier": "^3.2.5",
+    "typescript": "^5.4.5"
   }
 }

sample-go-mod/go.mod

@@ -167,7 +167,7 @@ require (
 	golang.org/x/sys v0.5.0 // indirect
 	golang.org/x/text v0.6.0 // indirect
 	golang.org/x/tools v0.6.0 // indirect
-	google.golang.org/protobuf v1.28.0 // indirect
+	google.golang.org/protobuf v1.33.0 // indirect
 	gopkg.in/ini.v1 v1.67.0 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect

sample-go-mod/go.sum

@@ -924,8 +924,8 @@ google.golang.org/protobuf v1.24.0/go.mod h1:r/3tXBNzIEhYS9I1OUVjXDlt8tc493IdKGj
 google.golang.org/protobuf v1.25.0/go.mod h1:9JNX74DMeImyA3h4bdi1ymwjUzf21/xIlbajtzgsN7c=
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
-google.golang.org/protobuf v1.28.0 h1:w43yiav+6bVFTBQFZX0r7ipe9JQ1QsbMgHwbBziscLw=
-google.golang.org/protobuf v1.28.0/go.mod h1:HV8QOd/L58Z+nl8r43ehVNZIU/HEI6OcFqwMG9pJV4I=
+google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
+google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/alecthomas/kingpin.v2 v2.2.6/go.mod h1:FMv+mEhP44yOT+4EoQTLFTRgOQ1FBLkstjWtayDeSgw=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/check.v1 v1.0.0-20180628173108-788fd7840127/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

src/run.ts

@@ -8,6 +8,7 @@ import { promisify } from "util"
 
 import { restoreCache, saveCache } from "./cache"
 import { installLint, InstallMode } from "./install"
+import { alterDiffPatch } from "./utils/diffUtils"
 import { findLintVersion } from "./version"
 
 const execShellCommand = promisify(exec)
@@ -68,7 +69,7 @@ async function fetchPatch(): Promise<string> {
     const tempDir = await createTempDir()
     const patchPath = path.join(tempDir, "pull.patch")
     core.info(`Writing patch to ${patchPath}`)
-    await writeFile(patchPath, patch)
+    await writeFile(patchPath, alterDiffPatch(patch))
     return patchPath
   } catch (err) {
     console.warn(`failed to save pull request patch:`, err)
@@ -157,10 +158,6 @@ async function runLint(lintPath: string, patchPath: string): Promise<void> {
   const workingDirectory = core.getInput(`working-directory`)
   const cmdArgs: ExecOptions = {}
   if (workingDirectory) {
-    if (patchPath) {
-      // TODO: make them compatible
-      throw new Error(`options working-directory and only-new-issues aren't compatible`)
-    }
     if (!fs.existsSync(workingDirectory) || !fs.lstatSync(workingDirectory).isDirectory()) {
       throw new Error(`working-directory (${workingDirectory}) was not a path`)
     }

src/utils/diffUtils.ts

@@ -0,0 +1,56 @@
+import * as core from "@actions/core"
+import * as path from "path"
+
+// If needed alter diff file to be compatible with working directory
+export function alterDiffPatch(patch: string): string {
+  const workingDirectory = core.getInput(`working-directory`)
+
+  if (workingDirectory) {
+    return alterPatchWithWorkingDirectory(patch, workingDirectory)
+  }
+
+  return patch
+}
+
+function alterPatchWithWorkingDirectory(patch: string, workingDirectory: string): string {
+  const workspace = process.env["GITHUB_WORKSPACE"] || ""
+
+  const wd = path.relative(workspace, workingDirectory)
+
+  // ignore diff sections not related to the working directory
+  let ignore = false
+
+  const lines = patch.split("\n")
+  const filteredLines = []
+
+  // starts with "--- a/xxx/" or "+++ a/xxx/" or "--- b/xxx/" or "+++ b/xxx/"
+  const cleanDiff = new RegExp(`^((?:\\+{3}|-{3}) [ab]\\/)${escapeRegExp(wd)}\\/(.*)`, "gm")
+
+  // contains " a/xxx/" or " b/xxx/"
+  const firstLine = new RegExp(`( [ab]\\/)${escapeRegExp(wd)}\\/(.*)`, "gm")
+
+  for (const line of lines) {
+    if (line.startsWith("diff --git")) {
+      ignore = !line.includes(` a/${wd}/`)
+      if (ignore) {
+        continue
+      }
+
+      filteredLines.push(line.replaceAll(firstLine, "$1$2"))
+    } else {
+      if (ignore) {
+        continue
+      }
+
+      filteredLines.push(line.replaceAll(cleanDiff, "$1$2"))
+    }
+  }
+
+  // Join the modified lines back into a diff string
+  return filteredLines.join("\n")
+}
+
+// https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
+function escapeRegExp(exp: string): string {
+  return exp.replace(/[.*+?^${}()|[\]\\]/g, "\\$&") // $& means the whole matched string
+}

tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "target": "es6",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "target": "ES2021",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
     "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
     "outDir": "./lib",                        /* Redirect output structure to the directory. */
     "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */