@nextcloud/eslint-config 8.4.1 → 9.0.0-rc.0

package/AUTHORS.md

@@ -0,0 +1,26 @@
+<!--
+  - SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
+  - SPDX-License-Identifier: AGPL-3.0-or-later
+-->	
+# Authors
+
+- Andy Scherzinger <info@andy-scherzinger.de>
+- Christoph Wurst <christoph@winzerhof-wurst.at>
+- Christopher Ng <chrng8@gmail.com>
+- Daniel Calviño Sánchez <danxuliu@gmail.com>
+- Daniel Kesselberg <mail@danielkesselberg.de>
+- dartcafe <github@dartcafe.de>
+- Ferdinand Thiessen <opensource@fthiessen.de>
+- Grigorii K. Shartsev <me@shgk.me>
+- Joas Schilling <213943+nickvergessen@users.noreply.github.com>
+- John Molakvoæ <skjnldsv@protonmail.com>
+- Julius Härtl <jus@bitgrid.net>
+- korelstar <korelstar@users.noreply.github.com>
+- Louis Chemineau <louis@chmn.me>
+- Marco Ambrosini <marcoambrosini@pm.me>
+- Pytal <24800714+Pytal@users.noreply.github.com>
+- Raimund Schlüßler <raimund.schluessler@mailbox.org>
+- René Gieling <github@dartcafe.de>
+- Richard Steinmetz <richard@steinmetz.cloud>
+- Vincent Petry <vincent@nextcloud.com>
+- Vinicius Reis <vinicius.reis@nextcloud.com>

package/CHANGELOG.md

@@ -1,5 +1,44 @@
+<!--
+  - SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+  - SPDX-License-Identifier: AGPL-3.0-or-later
+-->	
 # Changelog
 
+## [v9.0.0](https://github.com/nextcloud-libraries/eslint-config/tree/v9.0.0) (2025)
+
+### Breaking
+This package now is using ESLint v9 and requires ESLint flat configurations.
+Please refer to the README on how to adjust your configuration for flat config.
+
+### Added
+* feat: New modular config for (and with) ESLint v9 support [#887](https://github.com/nextcloud-libraries/eslint-config/pull/887)
+* Merge plugin repository [#899](https://github.com/nextcloud-libraries/eslint-config/pull/899)
+
+### Fixed
+* fix(codestyle): Enforce no space before function parenthesis [#901](https://github.com/nextcloud-libraries/eslint-config/pull/901)
+* fix(codeStyle): Adjust `stylistic` rules config [#914](https://github.com/nextcloud-libraries/eslint-config/pull/914)
+
+### Changed
+* Add SPDX header [#802](https://github.com/nextcloud-libraries/eslint-config/pull/802)
+* Updated development dependencies
+* refactor(json): drop now unneeded `@ts-expect-error` [#915](https://github.com/nextcloud-libraries/eslint-config/pull/915)
+* Updated `@eslint/json` to 0.11.0
+* Updated `@stylistic/eslint-plugin` 4.2.0
+* Updated `eslint-plugin-jsdoc` to 50.6.9
+* Updated `eslint-plugin-vue` to 10.0.0
+* Updated `fast-xml-parser` to 5.0.9
+* Updated `sort-package-json` to 3.0.0
+* Updated `typescript-eslint` to 8.28.0
+
+## [v8.4.2](https://github.com/nextcloud-libraries/eslint-config/tree/v8.4.2) (2025-02-16)
+### Fixed
+* fix(typescript): do not require returns type in jsdoc by @ShGKme in https://github.com/nextcloud-libraries/eslint-config/pull/857
+
+### Changed
+* Updated development dependencies
+* Add SPDX header  by @AndyScherzinger in https://github.com/nextcloud-libraries/eslint-config/pull/802
+* enh(git): ignore formatting commits in git blame by @max-nextcloud in https://github.com/nextcloud-libraries/eslint-config/pull/854
+
 ## [v8.4.1](https://github.com/nextcloud-libraries/eslint-config/tree/v8.4.1) (2024-05-16)
 
 [Full Changelog](https://github.com/nextcloud-libraries/eslint-config/compare/v8.4.0...v8.4.1)

package/README.md

@@ -1,15 +1,19 @@
+<!--
+  - SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
+  - SPDX-License-Identifier: AGPL-3.0-or-later
+-->	
 ## @nextcloud/eslint-config
 
+[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud-libraries/eslint-config)](https://api.reuse.software/info/github.com/nextcloud-libraries/eslint-config)
 [![npm last version](https://img.shields.io/npm/v/@nextcloud/eslint-config.svg?style=flat-square)](https://www.npmjs.com/package/@nextcloud/eslint-config)
 [![Lint status](https://img.shields.io/github/actions/workflow/status/nextcloud-libraries/eslint-config/lint-eslint.yml?label=lint&style=flat-square)](https://github.com/nextcloud-libraries/eslint-config/actions/workflows/lint.yml)
 [![Dependabot status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&style=flat-square&logo=dependabot)](https://dependabot.com)
 
 
-This is a package containing the unified global eslint config used by all nextcloud apps.
+This is a package containing the unified global eslint config used by all nextcloud apps and libraries.
 It contains the necessary dependencies and peerDependencies so that other apps cannot update if this config does not support it.
 Please always use dependabot to update your apps, OR pay attention to the peer dependencies error messages!
 
-
 ## Installation
 
 ```bash
@@ -18,45 +22,120 @@ npm install @nextcloud/eslint-config --save-dev
 
 ## Usage
 
-Add a file `.eslintrc.js` in the root directory of your app repository with the following content:
+> [!NOTE]  
+> Since version 9 this package depends on ESLint 9, which uses the new flat config system.
+
+This package provides some predefined configurations you can choose from.
+For the recommended setup add a file `eslint.config.js` in the root directory of your app repository with the following content:
 
 ```js
-module.exports = {
-	extends: [
-		'@nextcloud',
-	],
-}
+import { recommended } from '@nextcloud/eslint-config'
+
+export default [
+	...recommended,
+]
 ```
 
-### Usage with Typescript projects
+### Available configurations
 
-If your projects uses Typescript for vue files, like `<script lang="ts">` then use the Typescript config instead:
+Instead of the `recommended` configuration this package also provides some alternatives, depending on your app setup you can also choose:
 
-Add a file `.eslintrc.js` in the root directory of your app repository with the following content:
+* `recommended`
+  * General rules including code style
+  * Support for Typescript
+  * Support for Vue **3**
+  * Support Vue files with Typescript syntax (the script within `.vue` files will be handled as Typescript).
+* `recommendedJavascript`
+  * Same as `recommended` but Vue files (the script part) will be handled as Javascript.
+* `recommendedVue2`
+  * Same as `recommended` but Vue files are considered in Vue 2 syntax.
+* `recommendedVue2Javascript`
+  * Same as `recommended` but Vue files are considered in Vue 2 syntax and the script part will be handled as Javascript instead of Typescript.
 
-```js
-module.exports = {
-	extends: [
-		'@nextcloud/eslint-config/typescript',
-	],
-}
-```
+### Bundled plugins
 
-### Usage with Vue 3 projects
+This configuration also provides some bundled plugins with new rules, those options are already included in the recommended configurations.
 
-If your projects uses Vue 3 you have to use the `vue3` sub-configuration.
-This configuration also includes Typescript support by default.
-
-Add a file `.eslintrc.js` in the root directory of your app repository with the following content:
+It is possible to override the recommended configurations:
+```js
+// eslint.config.js
+import { recommended } from '@nextcloud/eslint-config'
+export default [
+  ...recommended,
+  {
+    files: ['**/*.js'],
+    rules: {
+      // Make deprecations error instead of warning level
+      '@nextcloud/no-deprecations': ['error'],
+    }
+  }
+]
+```
 
+You can even use the plugins without using the Nextcloud ESLint config:
 ```js
-module.exports = {
-	extends: [
-		'@nextcloud/eslint-config/vue3',
-	],
-}
+// eslint.config.js
+import { nextcloudPlugin } from '@nextcloud/eslint-config'
+export default [
+  {
+    files: ['**/*.js'],
+    plugins: {
+			'@nextcloud': nextcloudPlugin,
+		},
+		rules: {
+			'@nextcloud/no-removed-apis': ['error', { targetVersion: '29.0.0' }],
+	  },
+  }
+]
 ```
 
+#### `package-json` plugin
+Rules:
+- `sort-package-json`
+  - Ensures the `package.json` is sorted in consistent order
+  - Included as `error` level in recommended configurations
+
+#### `@nextcloud` plugin
+Rules:
+- `no-deprecations`
+  - Report usage of deprecated Nextcloud API
+  - Included as `warn` level in recommended configuration
+  - Available options
+    ```ts
+    {
+      /**
+       * Limit deprecated API to specified Nextcloud version
+       * @example '29.0.0'
+       * @default ''
+       */
+      targetVersion?: string
+      /**
+       * Try to find appinfo.xml to detect targetVersion
+       * @default true
+       */
+      parseAppInfo?: boolean
+    }
+    ```
+- `no-removed-apis`
+  - Report usage of removed Nextcloud API
+  - Included as `error` level in recommended configuration
+  - Available options
+    ```ts
+    {
+      /**
+       * Limit removed API to specified Nextcloud version
+       * @example '29.0.0'
+       * @default ''
+       */
+      targetVersion?: string
+      /**
+       * Try to find appinfo.xml to detect targetVersion
+       * @default true
+       */
+      parseAppInfo?: boolean
+    }
+    ```
+
 ## Release new version
 
  1. Update CHANGELOG.md file with the latest changes

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { ESLint } from 'eslint';
+import { Linter } from 'eslint';
+
+export declare const nextcloudPlugin: ESLint.Plugin;
+
+/**
+ * ESLint plugin to sort package.json files in a consistent way.
+ */
+export declare const packageJsonPlugin: ESLint.Plugin;
+
+/**
+ * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
+ */
+export declare const recommended: (Linter.Config<Linter.RulesRecord> | Linter.BaseConfig<Linter.RulesRecord, Linter.RulesRecord>)[];
+
+/**
+ * Nextcloud shared configuration for projects using Vue 3 with Javascript <script> blocks
+ */
+export declare const recommendedJavascript: (Linter.Config<Linter.RulesRecord> | Linter.BaseConfig<Linter.RulesRecord, Linter.RulesRecord>)[];
+
+/**
+ * Nextcloud shared configuration for projects using Vue 2 with Typescript <script> blocks
+ */
+export declare const recommendedVue2: (Linter.Config<Linter.RulesRecord> | Linter.BaseConfig<Linter.RulesRecord, Linter.RulesRecord>)[];
+
+/**
+ * Nextcloud shared configuration for projects using Vue 2 with Javascript <script> blocks
+ */
+export declare const recommendedVue2Javascript: (Linter.Config<Linter.RulesRecord> | Linter.BaseConfig<Linter.RulesRecord, Linter.RulesRecord>)[];
+
+export { }