Merge pull request #1201 from nextcloud-libraries/dependabot/npm_and_yarn/eslint-9.39.0

dependabot[bot] · web-flow · commit c20665844ae5 · 2025-11-06T00:51:11.000Z
diff --git a/.github/workflows/dependabot-approve-merge.yml b/.github/workflows/dependabot-approve-merge.yml
@@ -3,10 +3,10 @@
 # https://github.com/nextcloud-libraries/.github
 # https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization
 #
-# SPDX-FileCopyrightText: 2021-2024 Nextcloud GmbH and Nextcloud contributors
+# SPDX-FileCopyrightText: Nextcloud GmbH and Nextcloud contributors
 # SPDX-License-Identifier: MIT
 
-name: Dependabot
+name: Auto approve Dependabot PRs
 
 on:
   pull_request_target: # zizmor: ignore[dangerous-triggers]
@@ -29,6 +29,8 @@ jobs:
     permissions:
       # for hmarr/auto-approve-action to approve PRs
       pull-requests: write
+      # for alexwilson/enable-github-automerge-action to approve PRs
+      contents: write
 
     steps:
       - name: Disabled on forks
@@ -37,13 +39,20 @@ jobs:
           echo 'Can not approve PRs from forks'
           exit 1
 
+      - uses: mdecoleman/pr-branch-name@55795d86b4566d300d237883103f052125cc7508 # v3.0.0
+        id: branchname
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+
       # GitHub actions bot approve
-      - uses: hmarr/auto-approve-action@b40d6c9ed2fa10c9a2749eca7eb004418a705501 # v2
+      - uses: hmarr/auto-approve-action@f0939ea97e9205ef24d872e76833fa908a770363 # v4.0.0
+        if: startsWith(steps.branchname.outputs.branch, 'dependabot/')
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
 
-      # Nextcloud bot approve and merge request
-      - uses: ahmadnassri/action-dependabot-auto-merge@45fc124d949b19b6b8bf6645b6c9d55f4f9ac61a # v2
+      # Enable GitHub auto merge
+      - name: Auto merge
+        uses: alexwilson/enable-github-automerge-action@56e3117d1ae1540309dc8f7a9f2825bc3c5f06ff # v2.0.0
+        if: startsWith(steps.branchname.outputs.branch, 'dependabot/')
         with:
-          target: minor
-          github-token: ${{ secrets.DEPENDABOT_AUTOMERGE_TOKEN }}
+          github-token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/lint-eslint.yml b/.github/workflows/lint-eslint.yml
@@ -29,10 +29,17 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Read package.json
+        uses: nextcloud-libraries/parse-package-engines-action@122ae05d4257008180a514e1ddeb0c1b9d094bdd # v0.1.0
+        id: versions
+
       - name: Set up node
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
-          node-version-file: 'package.json'
+          node-version: ${{ steps.versions.outputs.node-version }}
+
+      - name: Set up npm
+        run: npm i -g 'npm@${{ steps.versions.outputs.package-manager-version }}'
 
       - name: Install dependencies
         env:
diff --git a/.github/workflows/node-test.yml b/.github/workflows/node-test.yml
@@ -34,10 +34,17 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Read package.json
+        uses: nextcloud-libraries/parse-package-engines-action@122ae05d4257008180a514e1ddeb0c1b9d094bdd # v0.1.0
+        id: versions
+
       - name: Set up node
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
-          node-version-file: 'package.json'
+          node-version: ${{ steps.versions.outputs.node-version }}
+
+      - name: Set up npm
+        run: npm i -g 'npm@${{ steps.versions.outputs.package-manager-version }}'
 
       - name: Install dependencies & build
         env:
@@ -56,3 +63,5 @@ jobs:
         uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1
         with:
           files: ./coverage/lcov.info
+        env:
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/node.yml b/.github/workflows/node.yml
@@ -28,10 +28,23 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Read package.json
+        uses: nextcloud-libraries/parse-package-engines-action@122ae05d4257008180a514e1ddeb0c1b9d094bdd # v0.1.0
+        id: versions
+
       - name: Set up node
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
-          node-version-file: 'package.json'
+          node-version: ${{ steps.versions.outputs.node-version }}
+
+      - name: Set up npm
+        run: npm i -g 'npm@${{ steps.versions.outputs.package-manager-version }}'
+
+      - name: Validate package-lock.json # See https://github.com/npm/cli/issues/4460
+        run: |
+          npm i -g npm-package-lock-add-resolved@1.1.4
+          npm-package-lock-add-resolved
+          git --no-pager diff --exit-code
 
       - name: Install dependencies & build
         env:
diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml
@@ -27,10 +27,17 @@ jobs:
         with:
           persist-credentials: false
 
+      - name: Read package.json
+        uses: nextcloud-libraries/parse-package-engines-action@122ae05d4257008180a514e1ddeb0c1b9d094bdd # v0.1.0
+        id: versions
+
       - name: Set up node
-        uses: actions/setup-node@a0853c24544627f65ddf259abe73b1d18a591444 # v5.0.0
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
-          node-version-file: 'package.json'
+          node-version: ${{ steps.versions.outputs.node-version }}
+
+      - name: Set up npm
+        run: npm i -g 'npm@${{ steps.versions.outputs.package-manager-version }}'
 
       - name: Check tag matches package.json
         run: |
diff --git a/lib/configs/codeStyle.ts b/lib/configs/codeStyle.ts
@@ -20,7 +20,7 @@ import l10nPlugin from '../plugins/l10n/index.ts'
  *
  * @param options options defining the config preset flavor
  */
-export function codeStyle(options: ConfigOptions): (Linter.Config | Linter.BaseConfig)[] {
+export function codeStyle(options: ConfigOptions): Linter.Config[] {
 	return [
 		// Nextcloud code style
 		{
diff --git a/lib/index.ts b/lib/index.ts
@@ -2,6 +2,8 @@
  * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
+
+import type { Linter } from 'eslint'
 import type { ConfigOptions } from './types.d.ts'
 
 import { codeStyle } from './configs/codeStyle.ts'
@@ -18,7 +20,7 @@ import { vue3 } from './configs/vue3.ts'
 /**
  * Nextcloud shared configuration for projects using Vue 2 with Javascript <script> blocks
  */
-export const recommendedVue2Javascript = createConfig({
+export const recommendedVue2Javascript: Linter.Config[] = createConfig({
 	isLibrary: false,
 	vue2: true,
 	vueIsTypescript: false,
@@ -27,7 +29,7 @@ export const recommendedVue2Javascript = createConfig({
 /**
  * Nextcloud shared configuration for projects using Vue 2 with Typescript <script> blocks
  */
-export const recommendedVue2 = createConfig({
+export const recommendedVue2: Linter.Config[] = createConfig({
 	isLibrary: false,
 	vue2: true,
 	vueIsTypescript: true,
@@ -36,31 +38,31 @@ export const recommendedVue2 = createConfig({
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Javascript <script> blocks
  */
-export const recommendedJavascript = createConfig({
+export const recommendedJavascript: Linter.Config[] = createConfig({
 	isLibrary: false,
 	vueIsTypescript: false,
 })
 
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
  */
-export const recommended = createConfig({
+export const recommended: Linter.Config[] = createConfig({
 	isLibrary: false,
 	vueIsTypescript: true,
 })
 
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
  */
-export const recommendedLibrary = createConfig({
+export const recommendedLibrary: Linter.Config[] = createConfig({
 	isLibrary: true,
 	vueIsTypescript: true,
 })
 
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
  */
-export const recommendedVue2Library = createConfig({
+export const recommendedVue2Library: Linter.Config[] = createConfig({
 	isLibrary: true,
 	vue2: true,
 	vueIsTypescript: true,
@@ -75,7 +77,7 @@ export { default as l10nPlugin } from './plugins/l10n/index.ts'
  *
  * @param options - Configuration options
  */
-function createConfig(options: ConfigOptions & { vue2?: boolean }) {
+function createConfig(options: ConfigOptions & { vue2?: boolean }): Linter.Config[] {
 	return [
 		...filesystem,
 		...javascript(options),
diff --git a/lib/plugins/packageJson.ts b/lib/plugins/packageJson.ts
@@ -3,13 +3,14 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
+import type { JSONRuleDefinition, JSONRuleVisitor } from '@eslint/json/types'
 import type { ESLint, Rule } from 'eslint'
 
 import path from 'node:path'
 import sortPackageJson from 'sort-package-json'
 import { packageVersion } from '../version.ts'
 
-const SortPackageJsonRule: Rule.RuleModule = {
+const SortPackageJsonRule: JSONRuleDefinition = {
 	meta: {
 		fixable: 'code',
 		docs: {
@@ -33,7 +34,7 @@ const SortPackageJsonRule: Rule.RuleModule = {
 		],
 	},
 
-	create(context: Rule.RuleContext): Rule.RuleListener {
+	create(context) {
 		if (path.basename(context.filename) !== 'package.json') {
 			return {}
 		}
@@ -51,12 +52,13 @@ const SortPackageJsonRule: Rule.RuleModule = {
 						node: body,
 						message: 'package.json is not sorted correctly',
 						fix(fixer: Rule.RuleFixer): Rule.Fix {
+							// @ts-expect-error its always an object node
 							return fixer.replaceText(body, sortedPackageJsonText)
 						},
 					})
 				}
 			},
-		} satisfies Rule.NodeListener
+		} as JSONRuleVisitor
 	},
 }
 
@@ -69,6 +71,7 @@ const Plugin: ESLint.Plugin = {
 		version: packageVersion,
 	},
 	rules: {
+		// @ts-expect-error ESLint is missing some API for language-specific rules
 		'sort-package-json': SortPackageJsonRule,
 	},
 }
diff --git a/lib/utils.ts b/lib/utils.ts
@@ -11,7 +11,7 @@ import type { Linter } from 'eslint'
  * @param configs The configs to restrict
  * @param files The glob pattern to assign
  */
-export function restrictConfigFiles(configs: Linter.Config[], files: string[]) {
+export function restrictConfigFiles(configs: Linter.Config[], files: string[]): Linter.Config[] {
 	return configs.map((config) => ({
 		...config,
 		files: [
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ import l10nPlugin from '../plugins/l10n/index.ts'`
`20`	`20`	`*`
`21`	`21`	`* @param options options defining the config preset flavor`
`22`	`22`	`*/`
`23`		`-export function codeStyle(options: ConfigOptions): (Linter.Config \| Linter.BaseConfig)[] {`
	`23`	`+export function codeStyle(options: ConfigOptions): Linter.Config[] {`
`24`	`24`	`return [`
`25`	`25`	`// Nextcloud code style`
`26`	`26`	`{`