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

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;

package/dist/plugins/nextcloud/utils/version-parser.d.ts

@@ -0,0 +1,41 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+/**
+ * Check if a given path exists and is a directory
+ *
+ * @param filePath The path
+ */
+export declare function isDirectory(filePath: string): boolean;
+/**
+ * Check if a given path exists and is a directory
+ *
+ * @param filePath The path
+ */
+export declare function isFile(filePath: string): boolean;
+/**
+ * Find the path of nearest `appinfo/info.xml` relative to given path
+ *
+ * @param currentPath Path to lookup
+ * @return Either the full path including the `info.xml` part or `undefined` if no found
+ */
+export declare function findAppinfo(currentPath: string): string | undefined;
+/**
+ * Make sure that versions like '25' can be handled by semver
+ *
+ * @param version The pure version string
+ * @return Sanitized version string
+ */
+export declare function sanitizeTargetVersion(version: string): string;
+/**
+ * Create a callback that takes a version number an checks if the version
+ * is valid compared to configured version / detected version.
+ *
+ * @param options Options
+ * @param options.cwd The current working directory
+ * @param options.physicalFilename The real filename where ESLint is linting currently
+ * @param options.options The plugin options
+ */
+export declare function createVersionValidator({ cwd, physicalFilename, options }: Rule.RuleContext): ((version: string) => boolean);

package/dist/plugins/nextcloud/utils/version-parser.js

@@ -0,0 +1,106 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import { XMLParser } from 'fast-xml-parser';
+import { lstatSync, readFileSync } from 'node:fs';
+import { dirname, isAbsolute, resolve, sep } from 'node:path';
+import { lte, valid } from 'semver';
+/**
+ * Check if a given path exists and is a directory
+ *
+ * @param filePath The path
+ */
+export function isDirectory(filePath) {
+    const stats = lstatSync(filePath, { throwIfNoEntry: false });
+    return stats !== undefined && stats.isDirectory();
+}
+/**
+ * Check if a given path exists and is a directory
+ *
+ * @param filePath The path
+ */
+export function isFile(filePath) {
+    const stats = lstatSync(filePath, { throwIfNoEntry: false });
+    return stats !== undefined && stats.isFile();
+}
+/**
+ * Find the path of nearest `appinfo/info.xml` relative to given path
+ *
+ * @param currentPath Path to lookup
+ * @return Either the full path including the `info.xml` part or `undefined` if no found
+ */
+export function findAppinfo(currentPath) {
+    while (currentPath && currentPath !== sep) {
+        const appinfoPath = `${currentPath}${sep}appinfo`;
+        if (isDirectory(appinfoPath)
+            && isFile(`${appinfoPath}${sep}info.xml`)) {
+            return `${appinfoPath}${sep}info.xml`;
+        }
+        currentPath = resolve(currentPath, '..');
+    }
+    return undefined;
+}
+/**
+ * Make sure that versions like '25' can be handled by semver
+ *
+ * @param version The pure version string
+ * @return Sanitized version string
+ */
+export function sanitizeTargetVersion(version) {
+    let sanitizedVersion = version;
+    const sections = sanitizedVersion.split('.').length;
+    if (sections < 3) {
+        sanitizedVersion = sanitizedVersion + '.0'.repeat(3 - sections);
+    }
+    // now version should look like '25.0.0'
+    if (!valid(sanitizedVersion)) {
+        throw Error(`[@nextcloud/eslint-plugin] Invalid target version ${version} found`);
+    }
+    return sanitizedVersion;
+}
+/**
+ * Create a callback that takes a version number an checks if the version
+ * is valid compared to configured version / detected version.
+ *
+ * @param options Options
+ * @param options.cwd The current working directory
+ * @param options.physicalFilename The real filename where ESLint is linting currently
+ * @param options.options The plugin options
+ */
+export function createVersionValidator({ cwd, physicalFilename, options }) {
+    const settings = options[0];
+    if (settings?.targetVersion) {
+        // check if the rule version is lower than the current target version
+        const maxVersion = sanitizeTargetVersion(settings.targetVersion);
+        return (version) => lte(version, maxVersion);
+    }
+    // Try to find appinfo and parse the supported version
+    if (settings?.parseAppInfo !== false) {
+        // Current working directory, either the filename (can be empty) or the cwd property
+        const currentDirectory = isAbsolute(physicalFilename)
+            ? resolve(dirname(physicalFilename))
+            : dirname(resolve(cwd, physicalFilename));
+        // The nearest appinfo
+        const appinfoPath = findAppinfo(currentDirectory);
+        if (appinfoPath) {
+            const parser = new XMLParser({
+                attributeNamePrefix: '@',
+                ignoreAttributes: false,
+            });
+            const xml = parser.parse(readFileSync(appinfoPath));
+            let maxVersion = xml?.info?.dependencies?.nextcloud?.['@max-version'];
+            if (typeof maxVersion !== 'string') {
+                throw new Error(`[@nextcloud/eslint-plugin] AppInfo does not contain a max-version (location: ${appinfoPath})`);
+            }
+            maxVersion = sanitizeTargetVersion(maxVersion);
+            return (version) => lte(version, maxVersion);
+        }
+        if (settings?.parseAppInfo === true) {
+            // User enforced app info parsing, so we throw an error - otherwise just fallback to default
+            throw new Error('[@nextcloud/eslint-plugin] AppInfo parsing was enabled, but no `appinfo/info.xml` was found.');
+        }
+    }
+    // If not configured or parsing is disabled, every rule should be handled
+    return () => true;
+}

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

@@ -0,0 +1,28 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+declare const _default: {
+    rules: {
+        'no-deprecated-exports': import("eslint").Rule.RuleModule;
+        'no-deprecated-props': {
+            meta: {
+                docs: {
+                    description: string;
+                };
+                type: "problem";
+                fixable: "code";
+                messages: {
+                    useTypeInstead: string;
+                    useVariantInstead: string;
+                };
+            };
+            create(context: import("eslint").Rule.RuleContext): any;
+        };
+    };
+    meta: {
+        name: string;
+        version: string;
+    };
+};
+export default _default;

package/dist/plugins/nextcloud-vue/index.js

@@ -0,0 +1,13 @@
+/*!
+ * 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 {
+    rules,
+    meta: {
+        name: '@nextcloud/eslint-plugin',
+        version: packageVersion,
+    },
+};

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

@@ -0,0 +1,17 @@
+export declare const rules: {
+    'no-deprecated-exports': import("eslint").Rule.RuleModule;
+    'no-deprecated-props': {
+        meta: {
+            docs: {
+                description: string;
+            };
+            type: "problem";
+            fixable: "code";
+            messages: {
+                useTypeInstead: string;
+                useVariantInstead: string;
+            };
+        };
+        create(context: import("eslint").Rule.RuleContext): any;
+    };
+};

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

@@ -0,0 +1,10 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import noDeprecatedExports from "./no-deprecated-exports.js";
+import noDeprecatedProps from "./no-deprecated-props.js";
+export const rules = {
+    'no-deprecated-exports': noDeprecatedExports,
+    'no-deprecated-props': noDeprecatedProps,
+};

package/dist/plugins/nextcloud-vue/rules/no-deprecated-exports.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-vue/rules/no-deprecated-exports.js

@@ -0,0 +1,44 @@
+import { createLibVersionValidator } from "../utils/lib-version-parser.js";
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+/*
+ Introduced in @nextcloud/vue v8.23.0
+ https://github.com/nextcloud-libraries/nextcloud-vue/pull/6385
+ */
+const rule = {
+    meta: {
+        docs: {
+            description: 'Deprecated @nextcloud/vue import syntax',
+            recommended: true,
+        },
+        fixable: 'code',
+        schema: [],
+    },
+    create(context) {
+        const versionSatisfies = createLibVersionValidator(context);
+        const isVersionValid = versionSatisfies('8.23.0');
+        const oldPattern = '@nextcloud/vue/dist/([^/]+)/([^/.]+)';
+        return {
+            ImportDeclaration: function (node) {
+                if (!isVersionValid) {
+                    // Can't fix, ignore the rule
+                    return;
+                }
+                const importPath = node.source.value;
+                const match = importPath.match(new RegExp(oldPattern));
+                if (match) {
+                    const newImportPath = `'@nextcloud/vue/${match[1].toLowerCase()}/${match[2]}'`;
+                    context.report({
+                        node,
+                        message: 'Import from "@nextcloud/vue/dist" is deprecated',
+                        fix(fixer) {
+                            return fixer.replaceText(node.source, newImportPath);
+                        },
+                    });
+                }
+            },
+        };
+    },
+};
+export default rule;

package/dist/plugins/nextcloud-vue/rules/no-deprecated-props.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+declare const _default: {
+    meta: {
+        docs: {
+            description: string;
+        };
+        type: "problem";
+        fixable: "code";
+        messages: {
+            useTypeInstead: string;
+            useVariantInstead: string;
+        };
+    };
+    create(context: Rule.RuleContext): any;
+};
+export default _default;