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

package/dist/plugins/nextcloud/utils/app-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/utils/lib-version-parser.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Create a callback that takes a version number and 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 importResolve Optional custom import resolver function (for testing purposes)
+ * @return Function validator, return a boolean whether current version satisfies minimal required for the rule
+ */
+export declare function createLibVersionValidator({ cwd, physicalFilename }: {
+    cwd: any;
+    physicalFilename: any;
+}, importResolve?: (specifier: string, parent?: string | import("node:url").URL) => string): ((version: string) => boolean);
+/**
+ * Clear the module cache
+ */
+export declare function clearCache(): void;

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

@@ -0,0 +1,49 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import { readFileSync } from 'node:fs';
+import { isAbsolute, join, resolve } from 'node:path';
+import { fileURLToPath, pathToFileURL } from 'node:url';
+import { gte } from 'semver';
+/**
+ * Cached map of paths: Reco <path_to_package.json, validator>
+ */
+const cachedMap = new Map();
+/**
+ * Create a callback that takes a version number and 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 importResolve Optional custom import resolver function (for testing purposes)
+ * @return Function validator, return a boolean whether current version satisfies minimal required for the rule
+ */
+export function createLibVersionValidator({ cwd, physicalFilename }, importResolve = import.meta.resolve) {
+    // Try to find package.json of the nextcloud-vue package
+    const sourceFile = isAbsolute(physicalFilename)
+        ? resolve(physicalFilename)
+        : resolve(cwd, physicalFilename);
+    let packageJsonDir;
+    try {
+        const modulePath = fileURLToPath(importResolve('@nextcloud/vue', pathToFileURL(sourceFile)));
+        const idx = modulePath.lastIndexOf('/dist/');
+        packageJsonDir = modulePath.substring(0, idx);
+    }
+    catch {
+        return () => false;
+    }
+    if (!cachedMap[packageJsonDir]) {
+        const json = JSON.parse(readFileSync(join(packageJsonDir, 'package.json'), 'utf-8'));
+        const libVersion = json.version;
+        cachedMap[packageJsonDir] = (version) => gte(libVersion, version);
+    }
+    return cachedMap[packageJsonDir];
+}
+/**
+ * Clear the module cache
+ */
+export function clearCache() {
+    cachedMap.clear();
+}

package/dist/plugins/nextcloud/utils/vue-template-visitor.d.ts

@@ -0,0 +1,26 @@
+/*!
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import type { Rule } from 'eslint';
+type TemplateVisitor = {
+    [key: string]: (...args: unknown[]) => void;
+};
+type TemplateVisitorOptions = {
+    templateBodyTriggerSelector: 'Program' | 'Program:exit';
+};
+/**
+ * Register the given visitor to parser services.
+ * If the parser service of `vue-eslint-parser` was not found,
+ * this generates a warning.
+ *
+ * @param context - The rule context to use parser services.
+ * @param templateBodyVisitor - The visitor to traverse the template body.
+ * @param scriptVisitor - The visitor to traverse the script.
+ * @param options - The options.
+ *
+ * @return The merged visitor.
+ * @see https://github.com/vuejs/eslint-plugin-vue/blob/745fd4e1f3719c3a2f93bd3531da5e886c16f008/lib/utils/index.js#L2281-L2315
+ */
+export declare function defineTemplateBodyVisitor(context: Rule.RuleContext, templateBodyVisitor: TemplateVisitor, scriptVisitor?: Rule.RuleListener, options?: TemplateVisitorOptions): Rule.RuleListener;
+export {};

package/dist/plugins/nextcloud/utils/vue-template-visitor.js

@@ -0,0 +1,38 @@
+/*!
+ * SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import { extname } from 'node:path';
+/**
+ * Register the given visitor to parser services.
+ * If the parser service of `vue-eslint-parser` was not found,
+ * this generates a warning.
+ *
+ * @param context - The rule context to use parser services.
+ * @param templateBodyVisitor - The visitor to traverse the template body.
+ * @param scriptVisitor - The visitor to traverse the script.
+ * @param options - The options.
+ *
+ * @return The merged visitor.
+ * @see https://github.com/vuejs/eslint-plugin-vue/blob/745fd4e1f3719c3a2f93bd3531da5e886c16f008/lib/utils/index.js#L2281-L2315
+ */
+export function defineTemplateBodyVisitor(context, templateBodyVisitor, scriptVisitor, options) {
+    const sourceCode = context.sourceCode;
+    if (!sourceCode.parserServices?.defineTemplateBodyVisitor) {
+        const filename = context.filename;
+        if (extname(filename) === '.vue') {
+            context.report({
+                loc: {
+                    line: 1,
+                    column: 0,
+                },
+                message: 'Use the latest vue-eslint-parser. See also https://eslint.vuejs.org/user-guide/#what-is-the-use-the-latest-vue-eslint-parser-error.',
+            });
+        }
+        else {
+            return scriptVisitor ?? {};
+        }
+    }
+    return sourceCode.parserServices
+        .defineTemplateBodyVisitor(templateBodyVisitor, scriptVisitor, options);
+}

package/dist/plugins/packageJson.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 sort package.json files in a consistent way.
+ */
+declare const Plugin: ESLint.Plugin;
+export default Plugin;

package/dist/plugins/packageJson.js

@@ -0,0 +1,66 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import path from 'node:path';
+import sortPackageJson from 'sort-package-json';
+import { packageVersion } from "../version.js";
+const SortPackageJsonRule = {
+    meta: {
+        fixable: 'code',
+        docs: {
+            recommended: true,
+            description: 'Sort package json in consistent order',
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    sortOrder: {
+                        type: 'array',
+                        minItems: 0,
+                        items: {
+                            type: 'string',
+                        },
+                    },
+                },
+                additionalProperties: false,
+            },
+        ],
+    },
+    create(context) {
+        if (path.basename(context.filename) !== 'package.json') {
+            return {};
+        }
+        const options = context.options ? context.options[0] : undefined;
+        return {
+            Document({ body }) {
+                const sourceCode = context.sourceCode.text;
+                const packageJsonText = sourceCode.slice(...body.range);
+                const sortedPackageJsonText = sortPackageJson(packageJsonText, options);
+                if (packageJsonText !== sortedPackageJsonText) {
+                    context.report({
+                        node: body,
+                        message: 'package.json is not sorted correctly',
+                        fix(fixer) {
+                            return fixer.replaceText(body, sortedPackageJsonText);
+                        },
+                    });
+                }
+            },
+        };
+    },
+};
+/**
+ * ESLint plugin to sort package.json files in a consistent way.
+ */
+const Plugin = {
+    meta: {
+        name: '@nextcloud/package-json',
+        version: packageVersion,
+    },
+    rules: {
+        'sort-package-json': SortPackageJsonRule,
+    },
+};
+export default Plugin;

package/dist/utils.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';
+/**
+ * Restrict a set of configurations to a given glob pattern
+ *
+ * @param configs The configs to restrict
+ * @param files The glob pattern to assign
+ */
+export declare function restrictConfigFiles(configs: Linter.Config[], files: string[]): Linter.Config[];

package/dist/utils.js

@@ -0,0 +1,19 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+/**
+ * Restrict a set of configurations to a given glob pattern
+ *
+ * @param configs The configs to restrict
+ * @param files The glob pattern to assign
+ */
+export function restrictConfigFiles(configs, files) {
+    return configs.map((config) => ({
+        ...config,
+        files: [
+            ...(config.files ?? []),
+            ...files,
+        ],
+    }));
+}

package/dist/version.d.ts

@@ -0,0 +1 @@
+export declare const packageVersion: string;

package/dist/version.js

@@ -0,0 +1,6 @@
+/*!
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+import packageJson from '../package.json' with { type: 'json' };
+export const packageVersion = packageJson.version;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextcloud/eslint-config",
-  "version": "9.0.0-rc.0",
+  "version": "9.0.0-rc.10",
   "description": "Eslint shared config for nextcloud apps and libraries",
   "keywords": [
     "eslint",
@@ -22,7 +22,7 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "default": "./dist/index.mjs"
+      "default": "./dist/index.js"
     }
   },
   "main": "dist/index.mjs",
@@ -34,44 +34,52 @@
     "dist"
   ],
   "scripts": {
-    "build": "vite --mode production build",
-    "lint": "npm run build && eslint",
-    "lint:fix": "eslint --fix",
+    "build": "npm run build:cleanup && npm run build:source",
+    "build:cleanup": "tsc --build --clean",
+    "build:source": "tsc",
+    "lint": "eslint --flag unstable_native_nodejs_ts_config",
+    "lint:fix": "eslint --flag unstable_native_nodejs_ts_config --fix",
+    "prerelease:format-changelog": "node build/format-changelog.mjs",
     "test": "vitest run"
   },
   "dependencies": {
-    "@eslint/json": "^0.11.0",
-    "@stylistic/eslint-plugin": "^4.2.0",
-    "eslint-plugin-jsdoc": "^50.6.9",
-    "eslint-plugin-vue": "^10.0.0",
-    "fast-xml-parser": "^5.0.9",
-    "globals": "^16.0.0",
-    "semver": "^7.7.1",
-    "sort-package-json": "^3.0.0",
-    "typescript-eslint": "^8.28.0"
+    "@eslint/js": "^10.0.1",
+    "@eslint/json": "^2.0.0",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "eslint-config-flat-gitignore": "^2.3.0",
+    "eslint-plugin-antfu": "^3.2.3",
+    "eslint-plugin-jsdoc": "^63.0.4",
+    "eslint-plugin-perfectionist": "^5.9.1",
+    "eslint-plugin-vue": "^10.9.2",
+    "fast-xml-parser": "^5.9.0",
+    "globals": "^17.6.0",
+    "semver": "^7.8.4",
+    "sort-package-json": "^4.0.0",
+    "typescript-eslint": "^8.61.1"
   },
   "devDependencies": {
-    "@nextcloud/vite-config": "^2.3.2",
-    "@types/node": "^22.13.13",
-    "eslint": "^9.23.0",
-    "memfs": "^4.17.0",
-    "vite": "^6.2.3",
-    "vitest": "^3.0.9"
+    "@types/node": "^26.0.0",
+    "@types/semver": "^7.7.1",
+    "eslint": "^10.5.0",
+    "memfs": "^4.57.7",
+    "vitest": "^4.1.9"
   },
   "peerDependencies": {
-    "eslint": ">=9"
+    "eslint": ">=10"
   },
   "engines": {
-    "node": "^20.9 || ^22"
+    "node": "^22.13 || ^24 || >=26"
   },
   "devEngines": {
-    "packageManager": {
-      "name": "npm",
-      "version": "^10"
-    },
+    "packageManager": [
+      {
+        "name": "npm",
+        "version": "^11.3.0"
+      }
+    ],
     "runtime": {
       "name": "node",
-      "version": "^22"
+      "version": "^24.3.0"
     }
   }
 }