feat!: Migrate to support ESLint v9

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
+## 3.0.0 - unreleased
+### Breaking
+* Added ESLint v9 and flat config compatibility - ESLint v8 is no longer supported.
+
 ## 2.2.1 - 2024-04-21
 ### Fixed
 * fix: Relax recommended config to work also with libraries \([\#180](https://github.com/nextcloud-libraries/eslint-plugin/pull/185)\)

README.md

@@ -92,12 +92,6 @@ It is also possible to detect that your supported Nextcloud version from your `a
 
 * `nextcloud/recommended`: Recommended configuration that loads the Nextcloud ESlint plugin, adds the Nextcloud environment and configures all recommended Nextcloud rules.
 
-
-## Supported Environments
-
-* `nextcloud/nextcloud`: Manifests global variables defined by Nextcloud server
-
-
 ## Supported Rules
 
 * `nextcloud/no-deprecations`: Detects properties and functions that were deprecated in Nextcloud server

lib/configs/index.ts

@@ -0,0 +1,4 @@
+import { recommended } from './recommended'
+import { recommendedWithGlobals } from './recommended-globals'
+
+export default [recommended, recommendedWithGlobals]

lib/configs/recommended-globals.ts

@@ -0,0 +1,28 @@
+import type { ESLint } from 'eslint'
+
+/**
+ * Similar to `@nextcloud/recommended` config, but additionally with global variables.
+ */
+export function recommendedWithGlobals(plugin: ESLint.Plugin) {
+	plugin.configs = plugin.configs ?? {}
+
+	plugin.configs['@nextcloud/recommended-legacy'] = {
+		name: '@nextcloud/recommended-globals',
+		languageOptions: {
+			globals: {
+				t: 'readonly',
+				n: 'readonly',
+				OC: 'readonly',
+				OCA: 'readonly',
+				OCP: 'readonly',
+			},
+		},
+		plugins: {
+			'@nextcloud': plugin,
+		},
+		rules: {
+			'@nextcloud/no-deprecations': ['warn'],
+			'@nextcloud/no-removed-apis': ['error'],
+		},
+	}
+}

lib/configs/recommended.ts

@@ -0,0 +1,20 @@
+import type { ESLint } from 'eslint'
+
+/**
+ * The recommended plugin configuration for Nextcloud
+ */
+export function recommended(plugin: ESLint.Plugin) {
+	plugin.configs = plugin.configs ?? {}
+
+	// registering the configuration
+	plugin.configs['@nextcloud/recommended'] = {
+		name: '@nextcloud/recommended',
+		plugins: {
+			'@nextcloud': plugin,
+		},
+		rules: {
+			'@nextcloud/no-deprecations': ['warn'],
+			'@nextcloud/no-removed-apis': ['error'],
+		},
+	}
+}

lib/globals.d.ts

@@ -0,0 +1,6 @@
+declare global {
+	// Injected by vite
+	const __PACKAGE_VERSION__: string
+}
+
+export {}

lib/index.ts

@@ -0,0 +1,34 @@
+/**
+ * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: MIT
+ */
+
+import type { ESLint } from 'eslint'
+import { rules } from './rules/index.ts'
+import configs from './configs/index.ts'
+import { Linter } from 'eslint/universal'
+
+const plugin: ESLint.Plugin = {
+	// with ESLint flat configs this information needs to be provided manually by us
+	meta: {
+		name: '@nextcloud/eslint-plugin',
+		version: __PACKAGE_VERSION__,
+	},
+
+	configs: {
+		// empty as we need to prevent cyclic dependency between configs and the plugin
+	},
+
+	rules,
+}
+
+// Register the configs
+// This is needed because they have cyclic dependencies on the plugin otherwise
+configs.forEach((config) => config(plugin))
+
+export default plugin as ESLint.Plugin & {
+    configs: {
+        recommended: Linter.Config,
+        'recommended-globals': Linter.Config,
+    },
+}

lib/rules/index.ts

@@ -0,0 +1,8 @@
+import type { Rule } from 'eslint'
+import noDeprecations from './no-deprecations.ts'
+import noRemovedApis from './no-removed-apis.ts'
+
+export const rules: Record<string, Rule.RuleModule> = {
+	'@nextcloud/no-deprecations': noDeprecations,
+	'@nextcloud/no-removed-apis': noRemovedApis,
+}