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

package/dist/globs.js

@@ -0,0 +1,37 @@
+/*!
+ * 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 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

@@ -0,0 +1,27 @@
+/**
+ * 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;

package/dist/plugins/nextcloud/rules/no-deprecations.js

@@ -0,0 +1,196 @@
+import { createVersionValidator } from "../utils/version-parser.js";
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+const global = {
+    $: '19.0.0',
+    Backbone: '18.0.0',
+    Clipboard: '18.0.0',
+    ClipboardJs: '18.0.0',
+    DOMPurify: '18.0.0',
+    formatDate: '16.0.0',
+    getURLParameter: '16.0.0',
+    Handlebars: '18.0.0',
+    humanFileSize: '16.0.0',
+    initCore: '17.0.0',
+    jQuery: '19.0.0',
+    jstimezonedetect: '18.0.0',
+    jstz: '18.0.0',
+    md5: '18.0.0',
+    moment: '18.0.0',
+    oc_appconfig: '17.0.0',
+    oc_appswebroots: '17.0.0',
+    oc_capabilities: '17.0.0',
+    oc_config: '17.0.0',
+    oc_current_user: '17.0.0',
+    oc_debug: '17.0.0',
+    oc_isadmin: '17.0.0',
+    oc_requesttoken: '17.0.0',
+    oc_webroot: '17.0.0',
+    OCDialogs: '17.0.0',
+    relative_modified_date: '16.0.0',
+};
+const oc = {
+    L10n: '26.0.0',
+    _capabilities: '17.0.0',
+    addTranslations: '17.0.0',
+    basename: '18.0.0',
+    coreApps: '17.0.0',
+    currentUser: '19.0.0',
+    dirname: '18.0.0',
+    encodePath: '18.0.0',
+    fileIsBlacklisted: '17.0.0',
+    filePath: '19.0.0',
+    generateUrl: '19.0.0',
+    get: '19.0.0',
+    getCanonicalLocale: '20.0.0',
+    getCurrentUser: '19.0.0',
+    getHost: '17.0.0',
+    getHostName: '17.0.0',
+    getPort: '17.0.0',
+    getProtocol: '17.0.0',
+    getRootPath: '19.0.0',
+    imagePath: '19.0.0',
+    isSamePath: '18.0.0',
+    joinPaths: '18.0.0',
+    linkTo: '19.0.0',
+    linkToOCS: '19.0.0',
+    linkToRemote: '19.0.0',
+    set: '19.0.0',
+    webroot: '19.0.0',
+};
+const oca = {
+    Search: '20.0.0',
+};
+const ocp = {
+    Toast: '19.0.0',
+};
+const ocNested = {
+    Util: {
+        formatDate: '20.0.0',
+        humanFileSize: '20.0.0',
+        relativeModifiedDate: '20.0.0',
+    },
+};
+const rule = {
+    meta: {
+        docs: {
+            description: 'Deprecated Nextcloud APIs',
+            category: 'Nextcloud',
+            recommended: true,
+        },
+        // fixable: null or "code" or "whitespace"
+        schema: [
+            {
+                // We accept one option which is an object
+                type: 'object',
+                properties: {
+                    // if we should try to find an appinfo and only handle APIs removed before the max-version
+                    parseAppInfo: {
+                        type: 'boolean',
+                    },
+                    // Set a Nextcloud target version, only APIs removed before that versions are checked
+                    targetVersion: {
+                        type: 'string',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            deprecatedGlobal: 'The global property or function {{name}} was deprecated in Nextcloud {{version}}',
+        },
+    },
+    create: function (context) {
+        const checkTargetVersion = createVersionValidator(context);
+        return {
+            MemberExpression: function (node) {
+                // OC.x
+                if ('name' in node.object
+                    && 'name' in node.property
+                    && node.object.name === 'OC'
+                    && Object.hasOwn(oc, node.property.name)
+                    && checkTargetVersion(oc[node.property.name])) {
+                    context.report({
+                        node,
+                        message: `The property or function OC.${node.property.name} was deprecated in Nextcloud ${oc[node.property.name]}`,
+                    });
+                }
+                // OCA.x
+                if ('name' in node.object
+                    && 'name' in node.property
+                    && node.object.name === 'OCA'
+                    && Object.hasOwn(oca, node.property.name)
+                    && checkTargetVersion(oca[node.property.name])) {
+                    context.report({
+                        node,
+                        message: `The property or function OCA.${node.property.name} was deprecated in Nextcloud ${oca[node.property.name]}`,
+                    });
+                }
+                // OCP.x
+                if ('name' in node.object
+                    && 'name' in node.property
+                    && node.object.name === 'OCP'
+                    && Object.hasOwn(ocp, node.property.name)
+                    && checkTargetVersion(ocp[node.property.name])) {
+                    context.report({
+                        node,
+                        message: `The property or function OCP.${node.property.name} was deprecated in Nextcloud ${ocp[node.property.name]}`,
+                    });
+                }
+                // OC.x.y
+                if (node.object.type === 'MemberExpression'
+                    && 'name' in node.object.object
+                    && node.object.object.name === 'OC'
+                    && 'name' in node.property
+                    && 'name' in node.object.property
+                    && Object.hasOwn(ocNested, node.object.property.name)
+                    && Object.hasOwn(ocNested[node.object.property.name], node.property.name)) {
+                    const version = ocNested[node.object.property.name][node.property.name];
+                    if (checkTargetVersion(version)) {
+                        const prop = [
+                            'OC',
+                            node.object.property.name,
+                            node.property.name,
+                        ].join('.');
+                        const deprecatedSince = ocNested[node.object.property.name][node.property.name];
+                        context.report({
+                            node,
+                            message: `The property or function ${prop} was deprecated in Nextcloud ${deprecatedSince}`,
+                        });
+                    }
+                }
+            },
+            Program(node) {
+                // Logic adapted from https://github.com/eslint/eslint/blob/master/lib/rules/no-restricted-globals.js
+                const scope = context.sourceCode.getScope(node);
+                const report = ({ identifier }) => {
+                    if (checkTargetVersion(global[identifier.name])) {
+                        context.report({
+                            node,
+                            messageId: 'deprecatedGlobal',
+                            data: {
+                                name: identifier.name,
+                                version: global[identifier.name],
+                            },
+                        });
+                    }
+                };
+                // Report variables declared elsewhere (ex: variables defined as "global" by eslint)
+                scope.variables.forEach((variable) => {
+                    if (!variable.defs.length
+                        && Object.hasOwn(global, variable.name)) {
+                        variable.references.forEach(report);
+                    }
+                });
+                // Report variables not declared at all
+                scope.through.forEach((reference) => {
+                    if (Object.hasOwn(global, reference.identifier.name)) {
+                        report(reference);
+                    }
+                });
+            },
+        };
+    },
+};
+export default rule;

package/dist/plugins/nextcloud/rules/no-removed-apis.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;

package/dist/plugins/nextcloud/rules/no-removed-apis.js

@@ -0,0 +1,152 @@
+import { createVersionValidator } from "../utils/version-parser.js";
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+const global = {
+    autosize: '29.0.0',
+    escapeHTML: '20.0.0',
+    fileDownloadPath: '15.0.0',
+    formatDate: '19.0.0',
+    getScrollBarWidth: '15.0.0',
+    getURLParameter: '19.0.0',
+    humanFileSize: '19.0.0',
+    marked: '19.0.0',
+    relative_modified_date: '19.0.0',
+};
+const oc = {
+    getScrollBarWidth: '15.0.0',
+    addTranslations: '26.0.0',
+    appSettings: '28.0.0',
+    loadScript: '28.0.0',
+    loadStyle: '28.0.0',
+};
+const ocNested = {
+    AppConfig: {
+        hasKey: '15.0.0',
+        deleteApp: '15.0.0',
+    },
+    Util: {
+        hasSVGSupport: '15.0.0',
+        replaceSVGIcon: '15.0.0',
+        replaceSVG: '15.0.0',
+        scaleFixForIE8: '15.0.0',
+        isIE8: '15.0.0',
+    },
+};
+const oca = {
+    // ref: https://github.com/nextcloud/server/commit/6eced42b7a40f5b0ea0489244583219d0ee2e7af
+    Search: '20.0.0',
+};
+// TODO: handle OC.x.y.z like OC.Share.ShareConfigModel.areAvatarsEnabled()
+//       ref https://github.com/nextcloud/server/issues/11045
+const rule = {
+    meta: {
+        docs: {
+            description: 'Removed Nextcloud APIs',
+            category: 'Nextcloud',
+            recommended: true,
+        },
+        // fixable: "code" or "whitespace"
+        schema: [
+            {
+                // We accept one option which is an object
+                type: 'object',
+                properties: {
+                    // if we should try to find an appinfo and only handle APIs removed before the max-version
+                    parseAppInfo: {
+                        type: 'boolean',
+                    },
+                    // Set a Nextcloud target version, only APIs removed before that versions are checked
+                    targetVersion: {
+                        type: 'string',
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+        messages: {
+            removedGlobal: 'The global property or function {{name}} was removed in Nextcloud {{version}}',
+        },
+    },
+    create(context) {
+        const checkTargetVersion = createVersionValidator(context);
+        return {
+            MemberExpression(node) {
+                // OCA.x
+                if ('name' in node.object
+                    && 'name' in node.property
+                    && node.object.name === 'OCA'
+                    && oca[node.property.name]
+                    && checkTargetVersion(oca[node.property.name])) {
+                    context.report({
+                        node,
+                        message: `The property or function OCA.${node.property.name} was removed in Nextcloud ${oca[node.property.name]}`,
+                    });
+                }
+                // OC.x
+                if ('name' in node.object
+                    && 'name' in node.property
+                    && node.object.name === 'OC'
+                    && Object.hasOwn(oc, node.property.name)
+                    && checkTargetVersion(oc[node.property.name])) {
+                    context.report({
+                        node,
+                        message: `The property or function OC.${node.property.name} was removed in Nextcloud ${oc[node.property.name]}`,
+                    });
+                }
+                // OC.x.y
+                if (node.object.type === 'MemberExpression'
+                    && 'name' in node.object.object
+                    && node.object.object.name === 'OC'
+                    && 'name' in node.object.property
+                    && ocNested[node.object.property.name]
+                    && 'name' in node.property
+                    && ocNested[node.object.property.name][node.property.name]) {
+                    const version = ocNested[node.object.property.name][node.property.name];
+                    if (checkTargetVersion(version)) {
+                        const prop = [
+                            'OC',
+                            node.object.property.name,
+                            node.property.name,
+                        ].join('.');
+                        context.report({
+                            node,
+                            message: `The property or function ${prop} was removed in Nextcloud ${version}`,
+                        });
+                    }
+                }
+            },
+            Program(node) {
+                // Logic adapted from https://github.com/eslint/eslint/blob/master/lib/rules/no-restricted-globals.js
+                const scope = context.sourceCode.getScope(node);
+                const report = (ref) => {
+                    const { identifier } = ref;
+                    if (global[identifier.name] && checkTargetVersion(global[identifier.name])) {
+                        context.report({
+                            node,
+                            messageId: 'removedGlobal',
+                            data: {
+                                name: identifier.name,
+                                version: global[identifier.name],
+                            },
+                        });
+                    }
+                };
+                // Report variables declared elsewhere (ex: variables defined as "global" by eslint)
+                scope.variables.forEach((variable) => {
+                    if (!variable.defs.length
+                        && Object.hasOwn(global, variable.name)) {
+                        variable.references.forEach(report);
+                    }
+                });
+                // Report variables not declared at all
+                scope.through.forEach((reference) => {
+                    if (Object.hasOwn(global, reference.identifier.name)) {
+                        report(reference);
+                    }
+                });
+            },
+        };
+    },
+};
+export default rule;