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

package/dist/configs/vue.js

@@ -0,0 +1,152 @@
+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 { codeStyle } from "./codeStyle.js";
+const stylisticRules = codeStyle({
+    isLibrary: false,
+    vueIsTypescript: false,
+}).reduce((rules, config) => ({
+    ...rules,
+    ...(config.rules ?? {}),
+}), {});
+const vueStylisticRules = Object.keys(vuePlugin.rules)
+    .filter((rule) => `@stylistic/${rule}` in stylisticRules)
+    .map((rule) => [
+    `vue/${rule}`,
+    stylisticRules[`@stylistic/${rule}`],
+]);
+/**
+ * General vue related rules for both versions
+ *
+ * @param options options defining the config preset flavor
+ */
+export function vue(options) {
+    return [
+        ...(options.vueIsTypescript
+            ? [
+                {
+                    languageOptions: {
+                        parserOptions: {
+                            parser: '@typescript-eslint/parser',
+                        },
+                    },
+                },
+            ]
+            : []),
+        {
+            files: GLOB_FILES_VUE,
+            rules: {
+                // PascalCase components names for vuejs
+                'vue/component-name-in-template-casing': [
+                    'error',
+                    'PascalCase',
+                ],
+                // space before self-closing elements
+                'vue/html-closing-bracket-spacing': 'error',
+                // no ending html tag on a new line
+                'vue/html-closing-bracket-newline': [
+                    'error',
+                    {
+                        multiline: 'never',
+                    },
+                ],
+                // Enforce documentation of properties
+                'vue/require-prop-comment': options.isLibrary
+                    ? [
+                        'error',
+                        {
+                            type: 'JSDoc',
+                        },
+                    ]
+                    : 'off',
+                // When a prop allows Boolean and some other type, then Boolean should come first to allow short-hand properties
+                'vue/prefer-prop-type-boolean-first': 'error',
+                // Prevent useless string interpolation where not needed
+                'vue/no-useless-mustaches': 'error',
+                // If there is a default then it is not required - this is either way a bug
+                'vue/no-required-prop-with-default': 'error',
+                // Omit empty blocks
+                'vue/no-empty-component-block': 'error',
+                // Boolean properties should behave like HTML properties
+                'vue/no-boolean-default': [
+                    'warn',
+                    'default-false',
+                ],
+                // Allow 3 attributes on the same line if singe line
+                'vue/max-attributes-per-line': [
+                    'error',
+                    {
+                        singleline: {
+                            max: 3,
+                        },
+                    },
+                ],
+                // 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'],
+                    },
+                ],
+                // Warn on unused refs
+                'vue/no-unused-refs': 'warn',
+                // Warn on unused props
+                'vue/no-unused-properties': 'warn',
+            },
+            name: 'nextcloud/vue/rules',
+        },
+        {
+            files: GLOB_FILES_VUE,
+            rules: {
+                // same as the stylistic rules but for the <template> in Vue files
+                ...Object.fromEntries(vueStylisticRules),
+                // Also enforce tabs for template
+                'vue/html-indent': [
+                    'error',
+                    'tab',
+                ],
+                // Consistent style of props
+                '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: [
+                ...GLOB_FILES_JAVASCRIPT,
+                ...GLOB_FILES_TYPESCRIPT,
+                ...GLOB_FILES_VUE,
+            ],
+            plugins: {
+                '@nextcloud/vue': nextcloudVuePlugin,
+            },
+            rules: {
+                '@nextcloud/vue/no-deprecated-exports': 'error',
+                '@nextcloud/vue/no-deprecated-props': 'error',
+            },
+            name: 'nextcloud/vue/migration-rules',
+        },
+    ];
+}

package/dist/configs/vue2.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * 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';
+/**
+ * Vue2 related ESLint rules for Nextcloud
+ *
+ * @param option options defining the config preset flavor
+ */
+export declare function vue2(option: ConfigOptions): Linter.Config[];

package/dist/configs/vue2.js

@@ -0,0 +1,30 @@
+import vuePlugin from 'eslint-plugin-vue';
+import { GLOB_FILES_VUE } from "../globs.js";
+import { restrictConfigFiles } from "../utils.js";
+import { vue } from "./vue.js";
+/**
+ * Vue2 related ESLint rules for Nextcloud
+ *
+ * @param option options defining the config preset flavor
+ */
+export function vue2(option) {
+    return [
+        ...restrictConfigFiles(vuePlugin.configs['flat/vue2-recommended'], GLOB_FILES_VUE),
+        ...vue(option),
+        {
+            rules: {
+                // custom event naming convention
+                'vue/custom-event-name-casing': [
+                    'error',
+                    'kebab-case',
+                    {
+                        // allows custom xxxx:xxx events formats
+                        ignores: ['/^[a-z]+(?:-[a-z]+)*:[a-z]+(?:-[a-z]+)*$/u'],
+                    },
+                ],
+            },
+            files: GLOB_FILES_VUE,
+            name: 'nextcloud/vue2/rules',
+        },
+    ];
+}

package/dist/configs/vue3.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * 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';
+/**
+ * Vue3 related ESLint rules for Nextcloud
+ *
+ * @param options options defining the config preset flavor
+ */
+export declare function vue3(options: ConfigOptions): Linter.Config[];

package/dist/configs/vue3.js

@@ -0,0 +1,26 @@
+import vuePlugin from 'eslint-plugin-vue';
+import { GLOB_FILES_VUE } from "../globs.js";
+import { restrictConfigFiles } from "../utils.js";
+import { vue } from "./vue.js";
+/**
+ * Vue3 related ESLint rules for Nextcloud
+ *
+ * @param options options defining the config preset flavor
+ */
+export function vue3(options) {
+    return [
+        ...restrictConfigFiles(vuePlugin.configs['flat/recommended'], GLOB_FILES_VUE),
+        ...vue(options),
+        // Vue3 specific overrides
+        {
+            files: GLOB_FILES_VUE,
+            rules: {
+                // 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

@@ -0,0 +1,20 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+/** Glob pattern for test files (specs) */
+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 */
+export declare const GLOB_FILES_JSON: string[];
+/** Glob pattern for JSONC files */
+export declare const GLOB_FILES_JSONC: string[];
+/** Glob pattern for Microsoft JSON files which use a slightly different JSONC implementation */
+export declare const GLOB_FILES_MS_JSON: string[];
+/** Glob pattern for Vue.JS files */
+export declare const GLOB_FILES_VUE: string[];

package/dist/globs.js

@@ -0,0 +1,39 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+/** Glob pattern for test files (specs) */
+export const GLOB_FILES_TESTING = [
+    '**/*.test.*',
+    '**/*.spec.*',
+    '**/*.cy.*',
+    '**/test',
+    '**/tests',
+];
+/** Glob pattern for Typescript files */
+export const GLOB_FILES_TYPESCRIPT = [
+    '**/*.ts',
+    '**/*.mts',
+    '**/*.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',
+    '**/*.cjs',
+    '**/*.mjs',
+    '**/*.jsx',
+];
+/** Glob pattern for JSON files */
+export const GLOB_FILES_JSON = ['**/*.json'];
+/** Glob pattern for JSONC files */
+export const GLOB_FILES_JSONC = ['**/*.jsonc'];
+/** Glob pattern for Microsoft JSON files which use a slightly different JSONC implementation */
+export const GLOB_FILES_MS_JSON = [
+    '**/tsconfig.json',
+    '.vscode/*.json',
+];
+/** Glob pattern for Vue.JS files */
+export const GLOB_FILES_VUE = ['**/*.vue'];

package/dist/index.d.ts

@@ -1,31 +1,27 @@
-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 { }
+/**
+ * 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>)[];
+/**
+ * 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>)[];
+/**
+ * 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>)[];
+/**
+ * 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>)[];
+/**
+ * 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>)[];
+/**
+ * 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 { 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

@@ -0,0 +1,78 @@
+import { codeStyle } from "./configs/codeStyle.js";
+import { documentation } from "./configs/documentation.js";
+import { filesystem } from "./configs/filesystem.js";
+import { imports } from "./configs/imports.js";
+import { javascript } from "./configs/javascript.js";
+import { json } from "./configs/json.js";
+import { node } from "./configs/node.js";
+import { typescript } from "./configs/typescript.js";
+import { vue2 } from "./configs/vue2.js";
+import { vue3 } from "./configs/vue3.js";
+/**
+ * Nextcloud shared configuration for projects using Vue 2 with Javascript <script> blocks
+ */
+export const recommendedVue2Javascript = createConfig({
+    isLibrary: false,
+    vue2: true,
+    vueIsTypescript: false,
+});
+/**
+ * Nextcloud shared configuration for projects using Vue 2 with Typescript <script> blocks
+ */
+export const recommendedVue2 = createConfig({
+    isLibrary: false,
+    vue2: true,
+    vueIsTypescript: true,
+});
+/**
+ * Nextcloud shared configuration for projects using Vue 3 with Javascript <script> blocks
+ */
+export const recommendedJavascript = createConfig({
+    isLibrary: false,
+    vueIsTypescript: false,
+});
+/**
+ * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
+ */
+export const recommended = createConfig({
+    isLibrary: false,
+    vueIsTypescript: true,
+});
+/**
+ * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
+ */
+export const recommendedLibrary = createConfig({
+    isLibrary: true,
+    vueIsTypescript: true,
+});
+/**
+ * Nextcloud shared configuration for projects using Vue 3 with Typescript <script> blocks
+ */
+export const recommendedVue2Library = createConfig({
+    isLibrary: true,
+    vue2: true,
+    vueIsTypescript: true,
+});
+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
+ *
+ * @param options - Configuration options
+ */
+function createConfig(options) {
+    return [
+        ...filesystem,
+        ...javascript(options),
+        ...json,
+        ...node,
+        ...typescript(options),
+        ...(options.vue2
+            ? vue2(options)
+            : vue3(options)),
+        ...documentation(options),
+        ...imports(options),
+        ...codeStyle(options),
+    ];
+}

package/dist/plugins/l10n/index.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { ESLint } from 'eslint';
+/**
+ * ESLint plugin to enforce consistent translations
+ */
+declare const Plugin: ESLint.Plugin;
+export default Plugin;

package/dist/plugins/l10n/index.js

@@ -0,0 +1,17 @@
+import { packageVersion } from "../../version.js";
+import RuleEllipsis from "./rules/enforce-ellipsis.js";
+import RuleNonBreakingSpace from "./rules/non-breaking-space.js";
+/**
+ * ESLint plugin to enforce consistent translations
+ */
+const Plugin = {
+    meta: {
+        name: '@nextcloud/l10n-plugin',
+        version: packageVersion,
+    },
+    rules: {
+        'non-breaking-space': RuleNonBreakingSpace,
+        'enforce-ellipsis': RuleEllipsis,
+    },
+};
+export default Plugin;

package/dist/plugins/l10n/rules/enforce-ellipsis.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+declare const _default: Rule.RuleModule;
+export default _default;

package/dist/plugins/l10n/rules/enforce-ellipsis.js

@@ -0,0 +1,32 @@
+const defineRule = (r) => r;
+export default defineRule({
+    meta: {
+        fixable: 'code',
+        type: 'suggestion',
+        schema: [],
+        docs: {
+            description: 'Enforce consistent usageof ellipsis instead of tripple dots',
+        },
+    },
+    create(context) {
+        return {
+            Literal(node) {
+                if (typeof node.value !== 'string'
+                    || node.parent.type !== 'CallExpression'
+                    || node.parent.callee.type !== 'Identifier'
+                    || node.parent.callee.name !== 't') {
+                    return;
+                }
+                if (node.raw?.match(/(?<=[^.])\.\.\.(?!\.)/)) {
+                    context.report({
+                        node,
+                        message: 'Strings should ellipsis instead of triple dots',
+                        fix(fixer) {
+                            return fixer.replaceText(node, node.raw.replaceAll(/(?<=[^.])\.\.\.(?!\.)/g, '…'));
+                        },
+                    });
+                }
+            },
+        };
+    },
+});

package/dist/plugins/l10n/rules/non-breaking-space.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+declare const _default: Rule.RuleModule;
+export default _default;

package/dist/plugins/l10n/rules/non-breaking-space.js

@@ -0,0 +1,30 @@
+const defineRule = (r) => r;
+export default defineRule({
+    meta: {
+        fixable: 'code',
+        type: 'suggestion',
+        schema: [],
+        docs: {
+            description: 'Enforce non-breaking spaces before ellipsis',
+        },
+    },
+    create(context) {
+        return {
+            Literal(node) {
+                if (typeof node.value !== 'string') {
+                    return;
+                }
+                const matches = node.value.match(/(\s+)…/);
+                if (matches && matches[1] !== ' ') {
+                    context.report({
+                        node,
+                        message: 'Ellipsis must be preceded by non-breaking spaces',
+                        fix(fixer) {
+                            return fixer.replaceText(node, node.raw.replaceAll(/\s+…/g, ' …'));
+                        },
+                    });
+                }
+            },
+        };
+    },
+});

package/dist/plugins/nextcloud/index.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { ESLint } from 'eslint';
+declare const _default: ESLint.Plugin;
+export default _default;

package/dist/plugins/nextcloud/index.js

@@ -0,0 +1,9 @@
+import { packageVersion } from "../../version.js";
+import { rules } from "./rules/index.js";
+export default {
+    rules,
+    meta: {
+        name: '@nextcloud/eslint-plugin',
+        version: packageVersion,
+    },
+};

package/dist/plugins/nextcloud/rules/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+export declare const rules: Record<string, Rule.RuleModule>;

package/dist/plugins/nextcloud/rules/index.js

@@ -0,0 +1,6 @@
+import noDeprecations from "./no-deprecations.js";
+import noRemovedApis from "./no-removed-apis.js";
+export const rules = {
+    'no-deprecations': noDeprecations,
+    'no-removed-apis': noRemovedApis,
+};

package/dist/plugins/nextcloud/rules/no-deprecations.d.ts

@@ -0,0 +1,7 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+declare const rule: Rule.RuleModule;
+export default rule;