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

package/dist/configs/documentation.js

@@ -1,5 +1,23 @@
-import jsdocPlugin from 'eslint-plugin-jsdoc';
+import { jsdoc } from 'eslint-plugin-jsdoc';
 import { GLOB_FILES_JAVASCRIPT, GLOB_FILES_TESTING, GLOB_FILES_TYPESCRIPT, GLOB_FILES_VUE, } from "../globs.js";
+const TS_FUNCTION_CONTEXTS = [
+    'FunctionDeclaration:has(TSTypeAnnotation)',
+    'FunctionExpression:has(TSTypeAnnotation)',
+    'ArrowFunctionExpression:has(TSTypeAnnotation)',
+    'MethodDefinition:has(TSTypeAnnotation)',
+];
+const JS_FUNCTION_CONTEXTS = [
+    'FunctionDeclaration:not(:has(TSTypeAnnotation))',
+    'FunctionExpression:not(:has(TSTypeAnnotation))',
+    'ArrowFunctionExpression:not(:has(TSTypeAnnotation))',
+    'MethodDefinition:not(:has(TSTypeAnnotation))',
+];
+const SHARED_JSDOC_SETTINGS = {
+    // We use the alias for legacy reasons to prevent unnecessary noise
+    tagNamePreference: {
+        returns: 'return',
+    },
+};
 /**
  * Config factory for code documentation related rules (JSDoc)
  *
@@ -8,30 +26,26 @@ import { GLOB_FILES_JAVASCRIPT, GLOB_FILES_TESTING, GLOB_FILES_TYPESCRIPT, GLOB_
 export function documentation(options) {
     return [
         {
-            files: [
-                ...GLOB_FILES_JAVASCRIPT,
-                ...GLOB_FILES_TYPESCRIPT,
-                ...GLOB_FILES_VUE,
-            ],
-            plugins: {
-                jsdoc: jsdocPlugin,
-            },
-        },
-        {
-            ...jsdocPlugin.configs['flat/recommended-typescript-flavor'],
+            ...jsdoc({
+                config: 'flat/recommended-typescript-flavor',
+                settings: {
+                    ...SHARED_JSDOC_SETTINGS,
+                    mode: 'permissive',
+                },
+            }),
+            name: 'nextcloud/documentation/javascript',
             files: [
                 ...GLOB_FILES_JAVASCRIPT,
                 ...(options.vueIsTypescript ? [] : GLOB_FILES_VUE),
             ],
-            settings: {
-                jsdoc: {
-                    mode: 'permissive',
-                },
-            },
             ignores: GLOB_FILES_TESTING,
         },
         {
-            ...jsdocPlugin.configs['flat/recommended-typescript'],
+            ...jsdoc({
+                config: 'flat/recommended-typescript',
+                settings: SHARED_JSDOC_SETTINGS,
+            }),
+            name: 'nextcloud/documentation/typescript',
             files: [
                 ...GLOB_FILES_TYPESCRIPT,
                 ...(options.vueIsTypescript ? GLOB_FILES_VUE : []),
@@ -39,6 +53,13 @@ export function documentation(options) {
             ignores: GLOB_FILES_TESTING,
         },
         {
+            name: 'nextcloud/documentation/rules',
+            files: [
+                ...GLOB_FILES_JAVASCRIPT,
+                ...GLOB_FILES_TYPESCRIPT,
+                ...GLOB_FILES_VUE,
+            ],
+            ignores: GLOB_FILES_TESTING,
             rules: {
                 // Force proper documentation
                 'jsdoc/check-tag-names': 'error',
@@ -52,33 +73,45 @@ export function documentation(options) {
                     { startLines: 1 },
                 ],
             },
-            files: [
-                ...GLOB_FILES_JAVASCRIPT,
-                ...GLOB_FILES_TYPESCRIPT,
-                ...GLOB_FILES_VUE,
-            ],
-            settings: {
-                jsdoc: {
-                    // We use the alias for legacy reasons to prevent unnecessary noise
-                    tagNamePreference: {
-                        returns: 'return',
-                    },
-                },
-            },
-            name: 'nextcloud/documentation/rules',
         },
         {
+            name: 'nextcloud/documentation/rules-typescript',
+            files: [...GLOB_FILES_TYPESCRIPT],
+            ignores: GLOB_FILES_TESTING,
             rules: {
                 // Overwrites for documentation as types are already provided by Typescript
+                'jsdoc/no-types': 'error',
                 'jsdoc/require-param-type': 'off',
-                'jsdoc/require-property-type': 'off',
                 'jsdoc/require-returns-type': 'off',
             },
-            files: [
-                ...GLOB_FILES_TYPESCRIPT,
-                ...(options.vueIsTypescript ? GLOB_FILES_VUE : []),
-            ],
-            name: 'nextcloud/documentation/rules-typescript',
         },
+        ...(options.vueIsTypescript
+            ? [
+                {
+                    name: 'nextcloud/documentation/rules-vue',
+                    files: [...(options.vueIsTypescript ? GLOB_FILES_VUE : [])],
+                    ignores: GLOB_FILES_TESTING,
+                    rules: {
+                        // Vue files can be both Javascript and Typescript
+                        // Try to apply TS files only for functions with TS definitions
+                        'jsdoc/no-types': [
+                            'error',
+                            { contexts: TS_FUNCTION_CONTEXTS },
+                        ],
+                        'jsdoc/require-param-type': [
+                            'error',
+                            { contexts: JS_FUNCTION_CONTEXTS },
+                        ],
+                        // Unlike params, return values are often inferred and not explicitly typed
+                        'jsdoc/require-returns-type': 'off',
+                        // Unfortunately, we cannot check when it is used in TS context and when not
+                        'jsdoc/check-tag-names': [
+                            'error',
+                            { typed: false },
+                        ],
+                    },
+                },
+            ]
+            : []),
     ];
 }

package/dist/configs/filesystem.js

@@ -2,16 +2,23 @@
  * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
+import gitignore from 'eslint-config-flat-gitignore';
 /**
  * General config to exclude known non-source directories from linting
  */
 export const filesystem = [
+    {
+        ...gitignore(),
+        name: 'nextcloud/filesystem/gitignore',
+    },
     {
         name: 'nextcloud/filesystem/ignores',
         ignores: [
-            '**/dist',
-            '**/vendor',
-            '**/vendor-bin',
+            'dist/',
+            'js/',
+            'l10n/',
+            'vendor/',
+            'vendor-bin/',
             '**/package-lock.json',
         ],
     },

package/dist/configs/imports.d.ts

@@ -1,8 +1,8 @@
-import type { Linter } from 'eslint';
 /*!
  * 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';
 /**
  * Generate imports and exports related ESLint rules.

package/dist/configs/imports.js

@@ -1,5 +1,10 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
 import perfectionist from 'eslint-plugin-perfectionist';
 import { GLOB_FILES_JAVASCRIPT, GLOB_FILES_TYPESCRIPT, GLOB_FILES_VUE, } from "../globs.js";
+import importExtensions from "../plugins/import-extensions/index.js";
 /**
  * Generate imports and exports related ESLint rules.
  *
@@ -12,6 +17,7 @@ export function imports(options) {
             name: 'nextcloud/imports/setup',
             plugins: {
                 perfectionist,
+                'import-extensions': importExtensions,
             },
         },
         {
@@ -23,41 +29,32 @@ export function imports(options) {
             ],
             rules: {
                 // Require file extensions
-                'no-restricted-imports': [
-                    'error',
-                    {
-                        patterns: [
-                            {
-                                regex: '^(\\.*)/(.+/)*[^/.]+$',
-                                message: 'Import is missing the file extension.',
-                            },
-                        ],
-                    },
-                ],
+                'import-extensions/extensions': 'error',
+                // enforce explicit type imports (no inline types)
+                'import-extensions/ban-inline-type-imports': 'error',
                 // Sorting of imports
                 'sort-imports': 'off',
                 'perfectionist/sort-imports': [
                     'error',
                     {
                         type: 'natural',
-                        newlinesBetween: 'never',
+                        newlinesBetween: 0,
                         groups: [
                             // type first
-                            'external-type',
-                            'type',
-                            { newlinesBetween: 'always' },
+                            ['type-external', 'type-builtin'],
+                            'type-import',
+                            { newlinesBetween: 1 },
                             // external things
                             [
                                 'builtin',
                                 'external',
-                                'object',
                             ],
                             // Vue components
                             'vue', // external modules (e.g. nextcloud-vue)
                             'internalVue', // internal local vue components
                             // everything else which is everything internal
                             'unknown',
-                            { newlinesBetween: 'always' },
+                            { newlinesBetween: 1 },
                             // side effect only: import 'sideeffect.js'
                             'side-effect',
                             // import style from 'my.module.css'
@@ -101,7 +98,7 @@ export function imports(options) {
 function createSortingConfig(type) {
     return {
         type: 'natural',
-        newlinesBetween: 'always',
+        newlinesBetween: 0,
         partitionByNewLine: false,
         groups: [
             `type-${type}`,

package/dist/configs/javascript.js

@@ -62,8 +62,8 @@ export function javascript(options) {
                     '@nextcloud': nextcloudPlugin,
                 },
                 rules: {
-                    '@nextcloud/no-deprecations': ['warn'],
-                    '@nextcloud/no-removed-apis': ['error'],
+                    '@nextcloud/no-deprecated-globals': ['warn'],
+                    '@nextcloud/no-removed-globals': ['error'],
                 },
                 files: [
                     ...GLOB_FILES_JAVASCRIPT,

package/dist/configs/typescript.js

@@ -1,5 +1,5 @@
 import typescriptPlugin from 'typescript-eslint';
-import { GLOB_FILES_TESTING, GLOB_FILES_TYPESCRIPT, GLOB_FILES_VUE, } from "../globs.js";
+import { GLOB_FILES_TESTING, GLOB_FILES_TYPESCRIPT, GLOB_FILES_TYPESCRIPT_DECLARATIONS, GLOB_FILES_VUE, } from "../globs.js";
 import { restrictConfigFiles } from "../utils.js";
 /**
  * Typescript related ESLint rules for Nextcloud
@@ -41,6 +41,13 @@ export function typescript(options) {
                 ],
             },
         },
+        {
+            name: 'nextcloud/typescript/declaration-rules',
+            files: [...GLOB_FILES_TYPESCRIPT_DECLARATIONS],
+            rules: {
+                '@typescript-eslint/consistent-type-imports': ['error', { disallowTypeAnnotations: false }],
+            },
+        },
         {
             files: GLOB_FILES_TESTING,
             rules: {

package/dist/configs/vue.js

@@ -1,6 +1,6 @@
 import vuePlugin from 'eslint-plugin-vue';
 import { GLOB_FILES_JAVASCRIPT, GLOB_FILES_TYPESCRIPT, GLOB_FILES_VUE, } from "../globs.js";
-import nextcloudVuePlugin from "../plugins/nextcloud-vue/index.js";
+import { nextcloudPlugin } from "../index.js";
 import { codeStyle } from "./codeStyle.js";
 const stylisticRules = codeStyle({
     isLibrary: false,
@@ -35,12 +35,12 @@ export function vue(options) {
             : []),
         {
             files: GLOB_FILES_VUE,
+            name: 'nextcloud/vue/rules',
             rules: {
-                // PascalCase components names for vuejs
-                'vue/component-name-in-template-casing': [
-                    'error',
-                    'PascalCase',
-                ],
+                // PascalCase components names in template tag names
+                'vue/component-name-in-template-casing': ['error', 'PascalCase'],
+                // Also in registration
+                'vue/component-options-name-casing': ['error', 'PascalCase'],
                 // space before self-closing elements
                 'vue/html-closing-bracket-spacing': 'error',
                 // no ending html tag on a new line
@@ -84,26 +84,34 @@ export function vue(options) {
                 // Component names should match their export names - readability and maintainability ("where does this component come from?")
                 'vue/match-component-import-name': 'error',
                 'vue/match-component-file-name': 'error',
+                // Prevent useless v-bind like `<foo :bar="'bar'"/>`
+                'vue/no-useless-v-bind': 'error',
                 // Warn on undefined components - we need this on warning level as long as people use mixins (then we can move to error)
                 'vue/no-undef-components': [
                     'warn',
                     {
-                        // Ignore the router view as this is most often globally registered
-                        ignorePatterns: ['router-?view'],
+                        // Ignore the router link and view as this is (most often) globally registered
+                        ignorePatterns: ['RouterLink', 'RouterView'],
                     },
                 ],
                 // Warn on unused refs
                 'vue/no-unused-refs': 'warn',
                 // Warn on unused props
                 'vue/no-unused-properties': 'warn',
+                // This rule does not work in vue files, we must use the vue one
+                'no-irregular-whitespace': 'off',
+                'vue/no-irregular-whitespace': 'error',
             },
-            name: 'nextcloud/vue/rules',
         },
         {
             files: GLOB_FILES_VUE,
+            name: 'nextcloud/vue/stylistic-rules',
             rules: {
                 // same as the stylistic rules but for the <template> in Vue files
                 ...Object.fromEntries(vueStylisticRules),
+                // same as in the codeStyle config but for the <template> in Vue files
+                '@nextcloud/l10n-non-breaking-space': 'error',
+                '@nextcloud/l10n-enforce-ellipsis': 'error',
                 // Also enforce tabs for template
                 'vue/html-indent': [
                     'error',
@@ -113,8 +121,23 @@ export function vue(options) {
                 'vue/new-line-between-multi-line-property': 'error',
                 // Add consistent padding between blocks
                 'vue/padding-line-between-blocks': 'error',
+                // Prefer separated static and dynamic class attributes
+                'vue/prefer-separate-static-class': 'error',
+                // For consistent layout of components
+                'vue/define-macros-order': [
+                    'error',
+                    {
+                        order: [
+                            'defineOptions',
+                            'defineModel',
+                            'defineProps',
+                            'defineEmits',
+                            'defineSlots',
+                            'defineExpose',
+                        ],
+                    },
+                ],
             },
-            name: 'nextcloud/vue/stylistic-rules',
         },
         {
             files: [
@@ -123,10 +146,11 @@ export function vue(options) {
                 ...GLOB_FILES_VUE,
             ],
             plugins: {
-                '@nextcloud/vue': nextcloudVuePlugin,
+                '@nextcloud': nextcloudPlugin,
             },
             rules: {
-                '@nextcloud/vue/no-deprecated-exports': 'error',
+                '@nextcloud/no-deprecated-library-exports': 'error',
+                '@nextcloud/no-deprecated-library-props': 'error',
             },
             name: 'nextcloud/vue/migration-rules',
         },

package/dist/configs/vue2.js

@@ -13,12 +13,12 @@ export function vue2(option) {
         ...vue(option),
         {
             rules: {
-                // custom event naming convention
+                // Force kebab-case for custom event name definitions (recommended by Vue 2 documentation)
                 'vue/custom-event-name-casing': [
                     'error',
                     'kebab-case',
                     {
-                        // allows custom xxxx:xxx events formats
+                        // Allow namespace formats namespace:event
                         ignores: ['/^[a-z]+(?:-[a-z]+)*:[a-z]+(?:-[a-z]+)*$/u'],
                     },
                 ],

package/dist/configs/vue3.js

@@ -1,3 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
 import vuePlugin from 'eslint-plugin-vue';
 import { GLOB_FILES_VUE } from "../globs.js";
 import { restrictConfigFiles } from "../utils.js";
@@ -15,8 +19,28 @@ export function vue3(options) {
         {
             files: GLOB_FILES_VUE,
             rules: {
+                // Force camelCase in props/attrs for consistency with <script> and prevent tooling issues
+                'vue/attribute-hyphenation': ['error', 'never'],
+                // Force camelCase for custom event name definitions (recommended by Vue 3 documentation and consistent with JS)
+                'vue/custom-event-name-casing': [
+                    'error',
+                    'camelCase',
+                    {
+                        // Allow namespace formats namespace:event
+                        ignores: ['/^[a-z]+:[a-z]+$/iu'],
+                    },
+                ],
+                // Force camelCase for events in template for consistency with <script>
+                'vue/v-on-event-hyphenation': ['error', 'never', { autofix: true }],
+                // Force camelCase for slot names.
+                // Changing case is breaking for component users.
+                // For libraries it may result in a breaking change. Warn to prevent unintended breaking change.
+                // TODO: allow namespace:slotName format like in events
+                'vue/slot-name-casing': [options.isLibrary ? 'warn' : 'error', 'camelCase'],
                 // Deprecated thus we should not use it
                 'vue/no-deprecated-delete-set': 'error',
+                // When using script-setup the modern approach should be used
+                'vue/prefer-define-options': 'error',
             },
             name: 'nextcloud/vue3/rules',
         },

package/dist/globs.d.ts

@@ -6,6 +6,8 @@
 export declare const GLOB_FILES_TESTING: string[];
 /** Glob pattern for Typescript files */
 export declare const GLOB_FILES_TYPESCRIPT: string[];
+/** Glob pattern for Typescript declaration files */
+export declare const GLOB_FILES_TYPESCRIPT_DECLARATIONS: string[];
 /** Glob pattern for Javascript files */
 export declare const GLOB_FILES_JAVASCRIPT: string[];
 /** Glob pattern for JSON files */

package/dist/globs.js

@@ -7,8 +7,10 @@ export const GLOB_FILES_TESTING = [
     '**/*.test.*',
     '**/*.spec.*',
     '**/*.cy.*',
-    '**/test',
-    '**/tests',
+    '**/test/**',
+    '**/tests/**',
+    '**/__tests__/**',
+    '**/__mocks__/**',
 ];
 /** Glob pattern for Typescript files */
 export const GLOB_FILES_TYPESCRIPT = [
@@ -17,6 +19,8 @@ export const GLOB_FILES_TYPESCRIPT = [
     '**/*.cts',
     '**/*.tsx',
 ];
+/** Glob pattern for Typescript declaration files */
+export const GLOB_FILES_TYPESCRIPT_DECLARATIONS = ['**/*.d.ts'];
 /** Glob pattern for Javascript files */
 export const GLOB_FILES_JAVASCRIPT = [
     '**/*.js',

package/dist/index.d.ts

@@ -1,27 +1,31 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Linter } from 'eslint';
 /**
  * Nextcloud shared configuration for projects using Vue 2 with Javascript <script> blocks
  */
-export declare const recommendedVue2Javascript: (import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | import("eslint").Linter.BaseConfig<import("eslint").Linter.RulesRecord, import("eslint").Linter.RulesRecord>)[];
+export declare const recommendedVue2Javascript: Linter.Config[];
 /**
  * Nextcloud shared configuration for projects using Vue 2 with Typescript <script> blocks
  */
-export declare const recommendedVue2: (import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | import("eslint").Linter.BaseConfig<import("eslint").Linter.RulesRecord, import("eslint").Linter.RulesRecord>)[];
+export declare const recommendedVue2: Linter.Config[];
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Javascript <script> blocks
  */
-export declare const recommendedJavascript: (import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | import("eslint").Linter.BaseConfig<import("eslint").Linter.RulesRecord, import("eslint").Linter.RulesRecord>)[];
+export declare const recommendedJavascript: Linter.Config[];
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
  */
-export declare const recommended: (import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | import("eslint").Linter.BaseConfig<import("eslint").Linter.RulesRecord, import("eslint").Linter.RulesRecord>)[];
+export declare const recommended: Linter.Config[];
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
  */
-export declare const recommendedLibrary: (import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | import("eslint").Linter.BaseConfig<import("eslint").Linter.RulesRecord, import("eslint").Linter.RulesRecord>)[];
+export declare const recommendedLibrary: Linter.Config[];
 /**
  * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
  */
-export declare const recommendedVue2Library: (import("eslint").Linter.Config<import("eslint").Linter.RulesRecord> | import("eslint").Linter.BaseConfig<import("eslint").Linter.RulesRecord, import("eslint").Linter.RulesRecord>)[];
+export declare const recommendedVue2Library: Linter.Config[];
 export { default as packageJsonPlugin } from './plugins/packageJson.ts';
 export { default as nextcloudPlugin } from './plugins/nextcloud/index.ts';
-export { default as l10nPlugin } from './plugins/l10n/index.ts';

package/dist/index.js

@@ -1,3 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
 import { codeStyle } from "./configs/codeStyle.js";
 import { documentation } from "./configs/documentation.js";
 import { filesystem } from "./configs/filesystem.js";
@@ -55,7 +59,6 @@ export const recommendedVue2Library = createConfig({
 });
 export { default as packageJsonPlugin } from "./plugins/packageJson.js";
 export { default as nextcloudPlugin } from "./plugins/nextcloud/index.js";
-export { default as l10nPlugin } from "./plugins/l10n/index.js";
 /**
  * Generate a configuration based on given options
  *

package/dist/plugins/import-extensions/index.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+declare const _default: {
+    rules: {
+        'ban-inline-type-imports': import("eslint").Rule.RuleModule;
+        extensions: import("eslint").Rule.RuleModule;
+    };
+    meta: {
+        name: string;
+        version: string;
+    };
+};
+export default _default;

package/dist/plugins/{nextcloud-vue → import-extensions}/index.js

@@ -1,3 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
 import { packageVersion } from "../../version.js";
 import { rules } from "./rules/index.js";
 export default {

package/dist/plugins/import-extensions/rules/ban-inline-type-imports.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2015 Ben Mosher
+ * SPDX-License-Identifier: MIT
+ */
+import type { Rule } from 'eslint';
+export declare const rule: Rule.RuleModule;