@nextcloud/eslint-config 9.0.0-rc.1 → 9.0.0-rc.10

package/CHANGELOG.md

@@ -4,19 +4,47 @@
 -->	
 # Changelog
 
-## [v9.0.0](https://github.com/nextcloud-libraries/eslint-config/tree/v9.0.0) (2025)
+## [v9.0.0](https://github.com/nextcloud-libraries/eslint-config/tree/v9.0.0) (unreleased)
 
 ### Breaking
-This package now is using ESLint v9 and requires ESLint flat configurations.
+This package now is using ESLint v10 and requires ESLint flat configurations.
 Please refer to the README on how to adjust your configuration for flat config.
 
+#### Potential pitfalls
+Some of the used eslint plugins still keep a ESLint v8 compatibility,
+this can cause some issues if not all packages are updated to the ESLint v10 compatible version.
+
+If you see a linter error like the one below make sure to update all nested dependencies,
+either using the sledge hammer method (remove the lock file and run `npm i`) or by running `npm update`.
+
+> TypeError: scopeManager.addGlobals is not a function
+
 ### Added
+* feat: migrate to ESLint v10 [\#1323](https://github.com/nextcloud-libraries/eslint-config/pull/1323) \([susnux](https://github.com/susnux)\)
 * feat: new modular config for (and with) ESLint v9 support [#887](https://github.com/nextcloud-libraries/eslint-config/pull/887)
 * feat: merge plugin repository [#899](https://github.com/nextcloud-libraries/eslint-config/pull/899)
 * feat: enforce non-breaking spaces before ellipsis for translations [\#948](https://github.com/nextcloud-libraries/eslint-config/pull/948)
 * feat: add special config for libraries [\#949](https://github.com/nextcloud-libraries/eslint-config/pull/949)
 * feat: add import and export rules [\#981](https://github.com/nextcloud-libraries/eslint-config/pull/981)
 * feat: introduce @nextcloud/vue eslint plugin [\#939](https://github.com/nextcloud-libraries/eslint-config/pull/939)
+* feat(codeStyle): enforce top-level-function [#1033](https://github.com/nextcloud-libraries/eslint-config/pull/1033) ([ShGKme](https://github.com/ShGKme))
+* feat(nextcloud-vue): add rule for deprecated NcButton props [#1045](https://github.com/nextcloud-libraries/eslint-config/pull/1045) ([susnux](https://github.com/susnux))
+* feat(vue): add `vue/no-useless-v-bind` rule [#1063](https://github.com/nextcloud-libraries/eslint-config/pull/1063) ([susnux](https://github.com/susnux))
+* feat(vue): add `vue/prefer-separate-static-class` rule [#1065](https://github.com/nextcloud-libraries/eslint-config/pull/1065) ([susnux](https://github.com/susnux))
+* feat(vue3): add script-setup releated rules [#1064](https://github.com/nextcloud-libraries/eslint-config/pull/1064) ([susnux](https://github.com/susnux))
+* feat(no-deprecated-props): extend existing rules to support other components [\#1069](https://github.com/nextcloud-libraries/eslint-config/pull/1069) \([Antreesy](https://github.com/Antreesy)\)
+* feat(imports): add custom plugin to suggest file extensions [\#1110](https://github.com/nextcloud-libraries/eslint-config/pull/1110) \([susnux](https://github.com/susnux)\)
+* feat(filesystem): ignore all files within the `.gitignore` [\#1108](https://github.com/nextcloud-libraries/eslint-config/pull/1108) \([susnux](https://github.com/susnux)\)
+* feat(l10n-plugin): also handle vue templates [\#1113](https://github.com/nextcloud-libraries/eslint-config/pull/1113) \([susnux](https://github.com/susnux)\)
+* feat(nextcloud-vue-plugin): deprecate additional props [\#1163](https://github.com/nextcloud-libraries/eslint-config/pull/1163) \([Antreesy](https://github.com/Antreesy)\)
+* feat(nextcloud-vue-plugin): deprecate additional exports [\#1162](https://github.com/nextcloud-libraries/eslint-config/pull/1162) \([Antreesy](https://github.com/Antreesy)\)
+* feat(nextcloud-vue-plugin): deprecate NcPopover props [\#1165](https://github.com/nextcloud-libraries/eslint-config/pull/1165) \([Antreesy](https://github.com/Antreesy)\)
+* feat(vue): add vue/component-options-name-casing with PascalCase [\#1261](https://github.com/nextcloud-libraries/eslint-config/pull/1261) \([ShGKme](https://github.com/ShGKme)\)
+* feat(vue3): force camelCase for events in `<script>` [\#1262](https://github.com/nextcloud-libraries/eslint-config/pull/1262) \([ShGKme](https://github.com/ShGKme)\)
+* feat(vue3): force camelCase for events in `<template>` [\#1263](https://github.com/nextcloud-libraries/eslint-config/pull/1263) \([ShGKme](https://github.com/ShGKme)\)
+* feat(vue3): force camelCase for slot names [\#1264](https://github.com/nextcloud-libraries/eslint-config/pull/1264) \([ShGKme](https://github.com/ShGKme)\)
+* feat(vue3): force camelCase for props in template [\#1266](https://github.com/nextcloud-libraries/eslint-config/pull/1266) \([ShGKme](https://github.com/ShGKme)\)
+* feat(import): enforce consistent types imports and ban usage of inline type specifiers [\#1382](https://github.com/nextcloud-libraries/eslint-config/pull/1382) \([susnux](https://github.com/susnux)\)
 
 ### Fixed
 * fix(codestyle): do not require splitting chains [\#951](https://github.com/nextcloud-libraries/eslint-config/pull/951)
@@ -32,40 +60,84 @@ Please refer to the README on how to adjust your configuration for flat config.
 * fix(typescript): allow to use function before definition [\#950](https://github.com/nextcloud-libraries/eslint-config/pull/950)
 * fix(typescript): remove `@typescript-eslint/no-shadow` [\#993](https://github.com/nextcloud-libraries/eslint-config/pull/993)
 * fix(typescript): enforce `import type` for type only imports [\#977](https://github.com/nextcloud-libraries/eslint-config/pull/977)
+* fix(vue): allow JS Vue files [#998](https://github.com/nextcloud-libraries/eslint-config/pull/998) ([ShGKme](https://github.com/ShGKme))
+* fix(documentation): do not remove JSDoc types in Vue JS files [#995](https://github.com/nextcloud-libraries/eslint-config/pull/995) ([ShGKme](https://github.com/ShGKme))
+* fix(typescript): allow import in type annotation [#1034](https://github.com/nextcloud-libraries/eslint-config/pull/1034) ([ShGKme](https://github.com/ShGKme))
+* fix(documentation): do not lint tests for documentation issues [#1062](https://github.com/nextcloud-libraries/eslint-config/pull/1062) ([susnux](https://github.com/susnux))
+* fix: ignore `l10n` and `js` directory for apps [#1061](https://github.com/nextcloud-libraries/eslint-config/pull/1061) ([susnux](https://github.com/susnux))
+* fix(imports): do not mix externals and internals [#1000](https://github.com/nextcloud-libraries/eslint-config/pull/1000) ([ShGKme](https://github.com/ShGKme))
+* fix(codeStyle): allow single line arrays [#997](https://github.com/nextcloud-libraries/eslint-config/pull/997) ([ShGKme](https://github.com/ShGKme))
+* fix(typescript): remove `@typescript-eslint/no-shadow` [#993](https://github.com/nextcloud-libraries/eslint-config/pull/993) ([ShGKme](https://github.com/ShGKme))
+* fix(codeStyle): allow devs write small objects in one line [#996](https://github.com/nextcloud-libraries/eslint-config/pull/996) ([ShGKme](https://github.com/ShGKme))
+* fix: ignore test report directories from linting [\#1096](https://github.com/nextcloud-libraries/eslint-config/pull/1096) \([Antreesy](https://github.com/Antreesy)\)
+* fix(vue): also ignore the global router link component [\#1097](https://github.com/nextcloud-libraries/eslint-config/pull/1097) \([susnux](https://github.com/susnux)\)
+* fix(no-deprecated-props): respect nextcloud/vue library version for the rule [\#1084](https://github.com/nextcloud-libraries/eslint-config/pull/1084) \([Antreesy](https://github.com/Antreesy)\)
+* fix(codestyle): replace deprecated config in `@stylistic/quotes` rule [\#1109](https://github.com/nextcloud-libraries/eslint-config/pull/1109) \([susnux](https://github.com/susnux)\)
+* fix(l10n-plugin): also check translation strings in `n` method [\#1112](https://github.com/nextcloud-libraries/eslint-config/pull/1112) \([susnux](https://github.com/susnux)\)
+* fix(filesystem): relax ignored files [\#1114](https://github.com/nextcloud-libraries/eslint-config/pull/1114) \([susnux](https://github.com/susnux)\)
+* fix(globs): adjust globs for test related files [\#1128](https://github.com/nextcloud-libraries/eslint-config/pull/1128) \([susnux](https://github.com/susnux)\)
+* fix(vue): use vue variant of `no-irregular-whitespace` [\#1129](https://github.com/nextcloud-libraries/eslint-config/pull/1129) \([susnux](https://github.com/susnux)\)
+* fix(nextcloud): add missing deprecations and removals [\#1206](https://github.com/nextcloud-libraries/eslint-config/pull/1206) \([susnux](https://github.com/susnux)\)
+* fix(plugin:nextcloud-vue): use resolved dependency for detecting nextcloud-vue version [\#1220](https://github.com/nextcloud-libraries/eslint-config/pull/1220) \([susnux](https://github.com/susnux)\)
+* fix: switch to `@stylistic/exp-list-style` to resolve array edge-cases [\#1203](https://github.com/nextcloud-libraries/eslint-config/pull/1203) \([susnux](https://github.com/susnux)\)
+* fix(nextcloud-plugin): add more removed API in Nextcloud 33 [\#1269](https://github.com/nextcloud-libraries/eslint-config/pull/1269) \([susnux](https://github.com/susnux)\)
+* fix: use vue-eslint-parser directly [\#1277](https://github.com/nextcloud-libraries/eslint-config/pull/1277) \([susnux](https://github.com/susnux)\)
+* fix(imports): no newline inside import statements [\#1379](https://github.com/nextcloud-libraries/eslint-config/pull/1379) \([max-nextcloud](https://github.com/max-nextcloud)\)
 
 ### 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)
+* refactor: use camelCase for internal variables [#971](https://github.com/nextcloud-libraries/eslint-config/pull/971) ([susnux](https://github.com/susnux))
 * chore: do not bundle config but just use Typescript [#967](https://github.com/nextcloud-libraries/eslint-config/pull/967)
 * chore: require node ^20.19 [\#982](https://github.com/nextcloud-libraries/eslint-config/pull/982)
-* Updated `@eslint/json` to 0.12.0
-* Updated `@stylistic/eslint-plugin` 4.2.0
-* Updated `eslint-plugin-jsdoc` to 50.6.11
-* Updated `eslint-plugin-vue` to 10.0.0
-* Updated `fast-xml-parser` to 5.2.1
-* Updated `sort-package-json` to 3.0.0
-* Updated `typescript-eslint` to 8.31.0
+* chore: remove EOL Node version and add new future LTS [\#1381](https://github.com/nextcloud-libraries/eslint-config/pull/1381) \([susnux](https://github.com/susnux)\)
+* chore: allow to run `npm lint` without compile step [#975](https://github.com/nextcloud-libraries/eslint-config/pull/975) ([susnux](https://github.com/susnux))
+* chore: prepare v9.0.0-rc.1 [#1010](https://github.com/nextcloud-libraries/eslint-config/pull/1010) ([susnux](https://github.com/susnux))
+* docs: consistent badge style with the reuse one [#1060](https://github.com/nextcloud-libraries/eslint-config/pull/1060) ([susnux](https://github.com/susnux))
+* docs: add documentation about update policy and development [#1009](https://github.com/nextcloud-libraries/eslint-config/pull/1009) ([susnux](https://github.com/susnux))
+* test: fix tests and add workflow to run them on CI [#1046](https://github.com/nextcloud-libraries/eslint-config/pull/1046) ([susnux](https://github.com/susnux))
+* ci: update workflows from organization [#1047](https://github.com/nextcloud-libraries/eslint-config/pull/1047) ([susnux](https://github.com/susnux))
+* chore: add active node version (24) to supported engines [#1066](https://github.com/nextcloud-libraries/eslint-config/pull/1066) ([susnux](https://github.com/susnux))
+* build: add common changelog formatting and documentation for it [#1067](https://github.com/nextcloud-libraries/eslint-config/pull/1067) ([susnux](https://github.com/susnux))
+* chore: lint this project as a library [\#1130](https://github.com/nextcloud-libraries/eslint-config/pull/1130) \([susnux](https://github.com/susnux)\)
+* chore: update devEngines to align with apps [\#1204](https://github.com/nextcloud-libraries/eslint-config/pull/1204) \([susnux](https://github.com/susnux)\)
+* build: disable libcheck for Typescript [\#1205](https://github.com/nextcloud-libraries/eslint-config/pull/1205) \([susnux](https://github.com/susnux)\)
+* chore(gitignore): ignore IDE configs [\#1265](https://github.com/nextcloud-libraries/eslint-config/pull/1265) \([ShGKme](https://github.com/ShGKme)\)
+* test(vue3): add some formatting tests [\#1267](https://github.com/nextcloud-libraries/eslint-config/pull/1267) \([ShGKme](https://github.com/ShGKme)\)
+* refactor: merge Nextcloud specific rules into the `@nextcloud` plugin [\#1278](https://github.com/nextcloud-libraries/eslint-config/pull/1278) \([susnux](https://github.com/susnux)\)
+* Updated `@eslint/json` to 2.0.0
+* Updated `@stylistic/eslint-plugin` to 5.7.0
+* Updated `eslint-config-flat-gitignore` to 2.1.0
+* Updated `eslint-plugin-antfu` to 3.2.3
+* Updated `eslint-plugin-jsdoc` to 63.0.4
+* Updated `eslint-plugin-perfectionist` to 5.9.1
+* Updated `eslint-plugin-vue` to 10.9.2
+* Updated `fast-xml-parser` to 5.9.0
+* Updated `globals` to 17.6.0
+* Updated `semver` to 7.8.4
+* Updated `sort-package-json` to 4.0.0
+* Updated `typescript-eslint` to 8.61.1
 
 ## [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
+* fix(typescript): do not require returns type in jsdoc [#857](https://github.com/nextcloud-libraries/eslint-config/pull/857) ([ShGKme](https://github.com/ShGKme))
 
 ### 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
+* Add SPDX header  [#802](https://github.com/nextcloud-libraries/eslint-config/pull/802) ([AndyScherzinger](https://github.com/AndyScherzinger))
+* enh(git): ignore formatting commits in git blame [#854](https://github.com/nextcloud-libraries/eslint-config/pull/854) ([max-nextcloud](https://github.com/max-nextcloud))
 
 ## [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)
 
 ### Fixes
-* fix(vue3): align rules with Vue 2 rules by @ShGKme in https://github.com/nextcloud-libraries/eslint-config/pull/771
-* fix(vue3): config crashes ESLint by @ShGKme in https://github.com/nextcloud-libraries/eslint-config/pull/770
+* fix(vue3): align rules with Vue 2 rules [#771](https://github.com/nextcloud-libraries/eslint-config/pull/771) ([ShGKme](https://github.com/ShGKme))
+* fix(vue3): config crashes ESLint [#770](https://github.com/nextcloud-libraries/eslint-config/pull/770) ([ShGKme](https://github.com/ShGKme))
 
 ### Changed
-* build(deps-dev): Bump eslint-plugin-jsdoc from 48.2.4 to 48.2.5 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/769
+* build(deps-dev): Bump eslint-plugin-jsdoc from 48.2.4 to 48.2.5 [#769](https://github.com/nextcloud-libraries/eslint-config/pull/769) ([dependabot](https://github.com/dependabot))
 
 ## [v8.4.0](https://github.com/nextcloud-libraries/eslint-config/tree/v8.4.0) (2024-05-15)
 ### Features
@@ -76,36 +148,36 @@ Please refer to the README on how to adjust your configuration for flat config.
 
 ### Features
 * Typescript 5 support
-* Allow linting of typescript with module resolution set to `node16` or `nodenext` by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/527
-* Support Composition API & Typescript + Vue projects by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/562
-* Allow linting of TSX files by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/456
+* Allow linting of typescript with module resolution set to `node16` or `nodenext` [#527](https://github.com/nextcloud-libraries/eslint-config/pull/527) ([susnux](https://github.com/susnux))
+* Support Composition API & Typescript + Vue projects [#562](https://github.com/nextcloud-libraries/eslint-config/pull/562) ([susnux](https://github.com/susnux))
+* Allow linting of TSX files [#456](https://github.com/nextcloud-libraries/eslint-config/pull/456) ([susnux](https://github.com/susnux))
 
 ### Fixes
-* Ignore camelcase rule for __webpack variables by @kesselb in https://github.com/nextcloud-libraries/eslint-config/pull/530
-* Add Typescript overrides for all valid Typescript file extensions by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/567
-* Allow empty functions by @skjnldsv in https://github.com/nextcloud-libraries/eslint-config/pull/570
-* fix(typescript): Also set the typescript settings to the vue overrides for typescript import resolving by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/639
-* fix(typescript): Allow generic type parameters on function calls by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/571
-* Make sure vue files written in Typescript are linted correctly by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/579
-* fix: Allow to import packages from `devDependencies` within config files by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/580
-* fix: Allow `@jest-environment` docblock for jest tests by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/592
+* Ignore camelcase rule for __webpack variables [#530](https://github.com/nextcloud-libraries/eslint-config/pull/530) ([kesselb](https://github.com/kesselb))
+* Add Typescript overrides for all valid Typescript file extensions [#567](https://github.com/nextcloud-libraries/eslint-config/pull/567) ([susnux](https://github.com/susnux))
+* Allow empty functions [#570](https://github.com/nextcloud-libraries/eslint-config/pull/570) ([skjnldsv](https://github.com/skjnldsv))
+* fix(typescript): Also set the typescript settings to the vue overrides for typescript import resolving [#639](https://github.com/nextcloud-libraries/eslint-config/pull/639) ([susnux](https://github.com/susnux))
+* fix(typescript): Allow generic type parameters on function calls [#571](https://github.com/nextcloud-libraries/eslint-config/pull/571) ([susnux](https://github.com/susnux))
+* Make sure vue files written in Typescript are linted correctly [#579](https://github.com/nextcloud-libraries/eslint-config/pull/579) ([susnux](https://github.com/susnux))
+* fix: Allow to import packages from `devDependencies` within config files [#580](https://github.com/nextcloud-libraries/eslint-config/pull/580) ([susnux](https://github.com/susnux))
+* fix: Allow `@jest-environment` docblock for jest tests [#592](https://github.com/nextcloud-libraries/eslint-config/pull/592) ([susnux](https://github.com/susnux))
 
 ### Changed
 * Various dependencies upgrades
-* chore: Update `@nextcloud/eslint-plugin` to version 2.1.0 by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/605
-* Drop webpack dependency by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/528
+* chore: Update `@nextcloud/eslint-plugin` to version 2.1.0 [#605](https://github.com/nextcloud-libraries/eslint-config/pull/605) ([susnux](https://github.com/susnux))
+* Drop webpack dependency [#528](https://github.com/nextcloud-libraries/eslint-config/pull/528) ([susnux](https://github.com/susnux))
 538
-* Update node engines to next LTS (node 20 and NPM 9) by @nextcloud-command in https://github.com/nextcloud-libraries/eslint-config/pull/563
+* Update node engines to next LTS (node 20 and NPM 9) [#563](https://github.com/nextcloud-libraries/eslint-config/pull/563) ([nextcloud-command](https://github.com/nextcloud-command))
 565
-* Make eslint to take this config for linting the config by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/572
-* chore: Fix URLs after package got transfered by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/602
+* Make eslint to take this config for linting the config [#572](https://github.com/nextcloud-libraries/eslint-config/pull/572) ([susnux](https://github.com/susnux))
+* chore: Fix URLs after package got transfered [#602](https://github.com/nextcloud-libraries/eslint-config/pull/602) ([susnux](https://github.com/susnux))
 
 ## [v8.2.1](https://github.com/nextcloud-libraries/eslint-config/tree/v8.2.1) (2023-01-30)
 
 [Full Changelog](https://github.com/nextcloud-libraries/eslint-config/compare/v8.2.0...v8.2.1)
 
 **Fixed:**
-- Fix resolving packages that use the package `exports` feature by @susnux in https://github.com/nextcloud-libraries/eslint-config/pull/452
+- Fix resolving packages that use the package `exports` feature [#452](https://github.com/nextcloud-libraries/eslint-config/pull/452) ([susnux](https://github.com/susnux))
 
 **Merged pull requests:**
 - Various dependencies upgrades
@@ -127,8 +199,8 @@ Please refer to the README on how to adjust your configuration for flat config.
 [Full Changelog](https://github.com/nextcloud-libraries/eslint-config/compare/v8.1.4...v8.1.5)
 
 **Dependency updates:**
-- Bump json5 from 1.0.1 to 1.0.2 by @PVince81 in https://github.com/nextcloud-libraries/eslint-config/pull/430
-- Bump json5 from 2.2.1 to 2.2.3 by @PVince81 in https://github.com/nextcloud-libraries/eslint-config/pull/430
+- Bump json5 from 1.0.1 to 1.0.2 [#430](https://github.com/nextcloud-libraries/eslint-config/pull/430) ([PVince81](https://github.com/PVince81))
+- Bump json5 from 2.2.1 to 2.2.3 [#430](https://github.com/nextcloud-libraries/eslint-config/pull/430) ([PVince81](https://github.com/PVince81))
 
 ## [v8.1.4](https://github.com/nextcloud-libraries/eslint-config/tree/v8.1.4) (2022-11-17)
 
@@ -142,16 +214,16 @@ Please refer to the README on how to adjust your configuration for flat config.
 [Full Changelog](https://github.com/nextcloud-libraries/eslint-config/compare/v8.1.2...v8.1.3)
 
 **Fixed:**
-- Allow TypeScript syntax in JSDoc comments by @Pytal in https://github.com/nextcloud-libraries/eslint-config/pull/413
+- Allow TypeScript syntax in JSDoc comments [#413](https://github.com/nextcloud-libraries/eslint-config/pull/413) ([Pytal](https://github.com/Pytal))
 
 **Dependency updates:**
-- Bump @babel/core from 7.18.10 to 7.19.6 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/404
-- Bump @babel/eslint-parser from 7.18.9 to 7.19.1 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/392
-- Bump eslint from 8.21.0 to 8.26.0 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/406
-- Bump eslint-plugin-jsdoc from 39.3.13 to 39.6.2 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/414
-- Bump eslint-plugin-n from 15.2.4 to 15.4.0 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/409
-- Bump eslint-plugin-promise from 6.0.0 to 6.1.1 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/405
-- Bump eslint-plugin-vue from 9.3.0 to 9.7.0 by @dependabot in https://github.com/nextcloud-libraries/eslint-config/pull/410
+- Bump @babel/core from 7.18.10 to 7.19.6 [#404](https://github.com/nextcloud-libraries/eslint-config/pull/404) ([dependabot](https://github.com/dependabot))
+- Bump @babel/eslint-parser from 7.18.9 to 7.19.1 [#392](https://github.com/nextcloud-libraries/eslint-config/pull/392) ([dependabot](https://github.com/dependabot))
+- Bump eslint from 8.21.0 to 8.26.0 [#406](https://github.com/nextcloud-libraries/eslint-config/pull/406) ([dependabot](https://github.com/dependabot))
+- Bump eslint-plugin-jsdoc from 39.3.13 to 39.6.2 [#414](https://github.com/nextcloud-libraries/eslint-config/pull/414) ([dependabot](https://github.com/dependabot))
+- Bump eslint-plugin-n from 15.2.4 to 15.4.0 [#409](https://github.com/nextcloud-libraries/eslint-config/pull/409) ([dependabot](https://github.com/dependabot))
+- Bump eslint-plugin-promise from 6.0.0 to 6.1.1 [#405](https://github.com/nextcloud-libraries/eslint-config/pull/405) ([dependabot](https://github.com/dependabot))
+- Bump eslint-plugin-vue from 9.3.0 to 9.7.0 [#410](https://github.com/nextcloud-libraries/eslint-config/pull/410) ([dependabot](https://github.com/dependabot))
 
 ## [v8.1.2](https://github.com/nextcloud-libraries/eslint-config/tree/v8.1.2) (2022-08-09)
 

package/README.md

@@ -5,25 +5,30 @@
 ## @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)
+[![npm last version](https://img.shields.io/npm/v/@nextcloud/eslint-config.svg)](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)](https://github.com/nextcloud-libraries/eslint-config/actions/workflows/lint.yml)
+[![Dependabot status](https://img.shields.io/badge/Dependabot-enabled-brightgreen.svg?longCache=true&logo=dependabot)](https://dependabot.com)
 
 
 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
+The rules within this configuration are based on, and enforce, the Nextcloud [coding style](https://docs.nextcloud.com/server/latest/developer_manual/getting_started/coding_standards/javascript.html#code-style). Additionally, we follow the common code styles and best practices used in the Vue ecosystem as we strongly focussed on Vue based UI code.
+
+> [!TIP]
+> For backend code there is also a similar configuration for PHP code available enforcing our PHP codestyle, see [Nextcloud cs-fixer](https://github.com/nextcloud/coding-standard/).
+
+### Installation
 
 ```bash
-npm install @nextcloud/eslint-config --save-dev
+npm install --save-dev @nextcloud/eslint-config
 ```
 
-## Usage
+### Usage
 
 > [!NOTE]
-> Since version 9 this package depends on ESLint 9, which uses the new flat config system.
+> Since version 9 this package depends on ESLint 10, 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:
@@ -36,7 +41,7 @@ export default [
 ]
 ```
 
-### Available configurations
+#### Available configurations
 
 Instead of the `recommended` configuration this package also provides some alternatives, depending on your app setup you can also choose:
 
@@ -52,7 +57,7 @@ Instead of the `recommended` configuration this package also provides some alter
 * `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.
 
-#### Configurations for Nextcloud libraries
+##### Configurations for Nextcloud libraries
 
 For libraries some of the presets make no sense, like checking Nextcloud deprecated API.
 But on the otherhand some rules should be enforced, like documenting all properties.
@@ -61,7 +66,7 @@ So for libraries use following configurations:
 * `recommendedLibrary`
 * `recommendedVue2Library`
 
-### Bundled plugins
+#### Bundled plugins
 
 This configuration also provides some bundled plugins with new rules, those options are already included in the recommended configurations.
 
@@ -75,7 +80,7 @@ export default [
 		files: ['**/*.js'],
 		rules: {
 			// Make deprecations error instead of warning level
-			'@nextcloud/no-deprecations': ['error'],
+			'@nextcloud/no-deprecated-globals': ['error'],
 		}
 	}
 ]
@@ -92,21 +97,21 @@ export default [
 			'@nextcloud': nextcloudPlugin,
 		},
 		rules: {
-			'@nextcloud/no-removed-apis': ['error', { targetVersion: '29.0.0' }],
+			'@nextcloud/no-removed-globals': ['error', { targetVersion: '29.0.0' }],
 		},
 	}
 ]
 ```
 
-#### `package-json` plugin
+##### `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
+##### `@nextcloud` plugin
 Rules:
-- `no-deprecations`
+- `no-deprecated-globals`
   - Report usage of deprecated Nextcloud API
   - Included as `warn` level in recommended configuration
   - Available options
@@ -125,7 +130,7 @@ Rules:
       parseAppInfo?: boolean
     }
     ```
-- `no-removed-apis`
+- `no-removed-globals`
   - Report usage of removed Nextcloud API
   - Included as `error` level in recommended configuration
   - Available options
@@ -144,21 +149,14 @@ Rules:
       parseAppInfo?: boolean
     }
     ```
-
-#### `@nextcloud-l10n`
-```ts
-import { l10nPlugin  } from '@nextcloud/eslint-config'
-```
-
-Rules:
-- `enforce-ellipsis`
+- `l10n-enforce-ellipsis`
   - Enforce consistent usageof ellipsis instead of tripple dots
   - Included as `error` level in recommended configuration
-- `non-breaking-space`
+- `l10n-non-breaking-space`
   - Enforce non-breaking spaces before ellipsis
   - Included as `error` level in recommended configuration
 
-### Adding custom overrides
+#### Adding custom overrides
 
 Sometimes additional rules need to be added for individual projects,
 and while we do not recommend to override Nextcloud rules for code style (it should be consistent across all Nextcloud projects!),
@@ -188,9 +186,65 @@ export default [
 ]
 ```
 
-## Release new version
+### Update policy
+
+We follow semantic versioning.
+
+#### 💥 Breaking changes
+
+For breaking changes, we consider those changes that break linting in a technical term, so linting itself is broken with the update.
+This means, for example, require a new config format (ESLint legacy vs flat configuration). But it does not mean new errors or warnings while linting.
+
+#### ✨ Minor changes
+
+For minor changes we consider adding new rules or adding or removing plugins.
+This means after updating a minor version, there can be new warnings or errors when linting the same code base.
+
+#### 🐛 Patch changes
+
+For this configuration we consider following changes fixes:
+- Adjusting rules to follow our official code style.
+- Adjusting rules if the current behavior is considered a bug.
+- Removing rules
+
+### Development
+
+#### New rules
+
+Adding new rules that enforce our code style can always be added.
+Rules that are not directly covered by our code style should be discussed before.
+
+If those rules are code style related, the matching section of the [Nextcloud developer documentation](https://github.com/nextcloud/documentation/) has to be updated to keep both in sync.
+
+#### Rule severity
+
+Either you care about a rule or you do not.
+As such we only enforce rules that we consider either important for code quality or to have consistent code style.
+For this reason all rules should be set to **error** severity, as all rules are considered must-follow.
+
+Of course, in some edge cases rules do not apply, in such cases the users can still opt-in to disable that rule for a line or file.
+
+To not break projects during updates new rules with non critical impact (code style related rules)
+should be introduced with **warn** severity and moved to severity **error** only with a new major release or after a sane timeframe for migration.
+
+#### Release new version
 
- 1. Update CHANGELOG.md file with the latest changes
- 2. Bump the package version with `npm version`
- 3. Push version bump commit
- 4. Create a new release with proper changelog https://github.com/nextcloud-libraries/eslint-config/releases/new
+- Pull the latest changes from `main` or `stableX`
+- Checkout a new branch with the tag name (e.g `v9.0.1`): `git checkout -b v<version>`
+- Run `npm version patch --no-git-tag-version` (`npm version minor --no-git-tag-version` if minor).
+  This will return a new version name, make sure it matches what you expect
+- Generate the changelog content from the [release](https://github.com/nextcloud-libraries/eslint-config/releases) page.
+  Create a draft release, select the previous tag, click `generate` then paste the content to the `CHANGELOG.md` file
+  1. adjust the links to the merged pull requests and authors so that the changelog also works outside of GitHub
+     by running `npm run prerelease:format-changelog`.
+     This will apply this regex: `by @([^ ]+) in ((https://github.com/)nextcloud-libraries/eslint-config/pull/(\d+))`
+     Which this as the replacement: `[\#$4]($2) \([$1]($3$1)\)`
+  2. use the the version as tag AND title (e.g `v4.0.1`)
+  3. add the changelog content as description (https://github.com/nextcloud-libraries/eslint-config/releases)
+- Commit, push and create PR
+- Get your PR reviewed and merged
+- Create a milestone with the follow-up version at https://github.com/nextcloud-libraries/eslint-config/milestones
+- Move all open tickets and PRs to the follow-up
+- Close the milestone of the version you release
+- Publish the previously drafted release on GitHub
+  ![image](https://user-images.githubusercontent.com/14975046/124442568-2a952500-dd7d-11eb-82a2-402f9170231a.png)

package/dist/configs/codeStyle.d.ts

@@ -10,4 +10,4 @@ import type { ConfigOptions } from '../types.d.ts';
  *
  * @param options options defining the config preset flavor
  */
-export declare function codeStyle(options: ConfigOptions): (Linter.Config | Linter.BaseConfig)[];
+export declare function codeStyle(options: ConfigOptions): Linter.Config[];

package/dist/configs/codeStyle.js

@@ -1,6 +1,6 @@
 import stylistic from '@stylistic/eslint-plugin';
+import eslintAntfuPlugin from 'eslint-plugin-antfu';
 import { GLOB_FILES_JAVASCRIPT, GLOB_FILES_TYPESCRIPT, GLOB_FILES_VUE, } from "../globs.js";
-import l10nPlugin from "../plugins/l10n/index.js";
 /**
  * Config factory for general code style related rules
  * See also: https://docs.nextcloud.com/server/latest/developer_manual/getting_started/coding_standards/javascript.html#code-style
@@ -34,6 +34,9 @@ export function codeStyle(options) {
                 ...GLOB_FILES_TYPESCRIPT,
                 ...GLOB_FILES_VUE,
             ],
+            plugins: {
+                antfu: eslintAntfuPlugin,
+            },
             rules: {
                 // Overrides for the stylistic recommended rules
                 // Tabs should only be used for indention
@@ -51,7 +54,7 @@ export function codeStyle(options) {
                     'error',
                     'single',
                     {
-                        allowTemplateLiterals: false,
+                        allowTemplateLiterals: 'never',
                         avoidEscape: true,
                     },
                 ],
@@ -71,28 +74,24 @@ export function codeStyle(options) {
                     'properties',
                     { avoidQuotes: true },
                 ],
-                // Enforce new lines after [ and before ] if there are multiline entries or more than 1 item in the array (better git diff)
-                '@stylistic/array-bracket-newline': [
-                    'error',
-                    {
-                        multiline: true,
-                        minItems: null, // disable
-                    },
-                ],
-                // Enforce new lines between array elements (better git diff) but allow to have single line arrays
-                '@stylistic/array-element-newline': ['error', 'consistent'],
-                // Same for objects as for arrays
-                '@stylistic/object-curly-newline': [
-                    'error',
-                    {
-                        consistent: true,
-                        multiline: true,
-                    },
-                ],
-                '@stylistic/object-property-newline': [
-                    'error',
-                    { allowAllPropertiesOnSameLine: true },
-                ],
+                // Enforce consistent new lines after brackets
+                '@stylistic/array-bracket-newline': 'off',
+                '@stylistic/array-bracket-spacing': 'off',
+                '@stylistic/array-element-newline': 'off',
+                '@stylistic/jsx-function-call-newline': 'off',
+                '@stylistic/object-curly-newline': 'off',
+                '@stylistic/object-curly-spacing': 'off',
+                '@stylistic/object-property-newline': 'off',
+                '@stylistic/exp-list-style': ['error', {
+                        singleLine: {
+                            spacing: 'never',
+                        },
+                        overrides: {
+                            '{}': {
+                                singleLine: { spacing: 'always' },
+                            },
+                        },
+                    }],
                 // No space between function name and parenthesis. Enforce fn() instead of fn ()
                 '@stylistic/function-call-spacing': [
                     'error',
@@ -142,6 +141,8 @@ export function codeStyle(options) {
                 'no-useless-concat': 'error',
                 // Prefer { ...foo } over Object.assign({}, foo)
                 'prefer-object-spread': 'warn',
+                // Enforce function declarations for top level functions
+                'antfu/top-level-function': 'error',
             },
         },
         {
@@ -165,13 +166,10 @@ export function codeStyle(options) {
                 ...GLOB_FILES_TYPESCRIPT,
                 ...GLOB_FILES_VUE,
             ],
-            plugins: {
-                '@nextcloud-l10n': l10nPlugin,
-            },
             // Enforce that translations use ellipsis instead of tripple dots
             rules: {
-                '@nextcloud-l10n/non-breaking-space': 'error',
-                '@nextcloud-l10n/enforce-ellipsis': 'error',
+                '@nextcloud/l10n-non-breaking-space': 'error',
+                '@nextcloud/l10n-enforce-ellipsis': 'error',
             },
         },
     ];