immosquare-cleaner 0.1.62 → 0.1.63

data/node_modules/@eslint/eslintrc/dist/eslintrc.d.cts

@@ -0,0 +1,76 @@
+/**
+ * @fileoverview This file contains the core types for ESLint. It was initially extracted
+ * from the `@types/eslint__eslintrc` package.
+ */
+
+/*
+ * MIT License
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE
+ */
+
+import type { Linter } from "eslint";
+
+/**
+ * A compatibility class for working with configs.
+ */
+export class FlatCompat {
+    constructor({
+        baseDirectory,
+        resolvePluginsRelativeTo,
+        recommendedConfig,
+        allConfig,
+    }?: {
+        /**
+         * default: process.cwd()
+         */
+        baseDirectory?: string;
+        resolvePluginsRelativeTo?: string;
+        recommendedConfig?: Linter.LegacyConfig;
+        allConfig?: Linter.LegacyConfig;
+    });
+
+    /**
+     * Translates an ESLintRC-style config into a flag-config-style config.
+     * @param eslintrcConfig The ESLintRC-style config object.
+     * @returns A flag-config-style config object.
+     */
+    config(eslintrcConfig: Linter.LegacyConfig): Linter.Config[];
+
+    /**
+     * Translates the `env` section of an ESLintRC-style config.
+     * @param envConfig The `env` section of an ESLintRC config.
+     * @returns An array of flag-config objects representing the environments.
+     */
+    env(envConfig: { [name: string]: boolean }): Linter.Config[];
+
+    /**
+     * Translates the `extends` section of an ESLintRC-style config.
+     * @param configsToExtend The names of the configs to load.
+     * @returns An array of flag-config objects representing the config.
+     */
+    extends(...configsToExtend: string[]): Linter.Config[];
+
+    /**
+     * Translates the `plugins` section of an ESLintRC-style config.
+     * @param plugins The names of the plugins to load.
+     * @returns An array of flag-config objects representing the plugins.
+     */
+    plugins(...plugins: string[]): Linter.Config[];
+}

data/node_modules/@eslint/eslintrc/lib/cascading-config-array-factory.js

@@ -23,8 +23,8 @@
 //------------------------------------------------------------------------------
 
 import debugOrig from "debug";
-import os from "os";
-import path from "path";
+import os from "node:os";
+import path from "node:path";
 
 import { ConfigArrayFactory } from "./config-array-factory.js";
 import {
@@ -193,7 +193,7 @@ function createCLIConfigArray({
  */
 class ConfigurationNotFoundError extends Error {
 
-    // eslint-disable-next-line jsdoc/require-description
+
     /**
      * @param {string} directoryPath The directory path.
      */
@@ -345,6 +345,7 @@ class CascadingConfigArrayFactory {
      * @param {string} directoryPath The path to a leaf directory.
      * @param {boolean} configsExistInSubdirs `true` if configurations exist in subdirectories.
      * @returns {ConfigArray} The loaded config.
+     * @throws {Error} If a config file is invalid.
      * @private
      */
     _loadConfigInAncestors(directoryPath, configsExistInSubdirs = false) {
@@ -446,6 +447,7 @@ class CascadingConfigArrayFactory {
      * @param {string} directoryPath The path to the leaf directory to find config files.
      * @param {boolean} ignoreNotFoundError If `true` then it doesn't throw `ConfigurationNotFoundError`.
      * @returns {ConfigArray} The loaded config.
+     * @throws {Error} If a config file is invalid.
      * @private
      */
     _finalizeConfigArray(configArray, directoryPath, ignoreNotFoundError) {
@@ -482,7 +484,7 @@ class CascadingConfigArrayFactory {
                     !directoryPath.startsWith(homePath)
                 ) {
                     const lastElement =
-                        personalConfigArray[personalConfigArray.length - 1];
+                        personalConfigArray.at(-1);
 
                     emitDeprecationWarning(
                         lastElement.filePath,

data/node_modules/@eslint/eslintrc/lib/config-array/config-array.js

@@ -178,6 +178,7 @@ class PluginConflictError extends Error {
  * @param {Record<string, DependentPlugin>} target The destination to merge
  * @param {Record<string, DependentPlugin>|undefined} source The source to merge.
  * @returns {void}
+ * @throws {PluginConflictError} When a plugin was conflicted.
  */
 function mergePlugins(target, source) {
     if (!isNonNullObject(source)) {
@@ -258,6 +259,7 @@ function mergeRuleConfigs(target, source) {
  * @param {ConfigArray} instance The config elements.
  * @param {number[]} indices The indices to use.
  * @returns {ExtractedConfig} The extracted config.
+ * @throws {Error} When a plugin is conflicted.
  */
 function createConfig(instance, indices) {
     const config = new ExtractedConfig();

data/node_modules/@eslint/eslintrc/lib/config-array/config-dependency.js

@@ -15,7 +15,7 @@
  * @author Toru Nagashima <https://github.com/mysticatea>
  */
 
-import util from "util";
+import util from "node:util";
 
 /**
  * The class is to store parsers or plugins.
@@ -88,8 +88,8 @@ class ConfigDependency {
         this.importerPath = importerPath;
     }
 
-    // eslint-disable-next-line jsdoc/require-description
     /**
+     * Converts this instance to a JSON compatible object.
      * @returns {Object} a JSON compatible object.
      */
     toJSON() {
@@ -103,14 +103,14 @@ class ConfigDependency {
         return obj;
     }
 
-    // eslint-disable-next-line jsdoc/require-description
     /**
+     * Custom inspect method for Node.js `console.log()`.
      * @returns {Object} an object to display by `console.log()`.
      */
     [util.inspect.custom]() {
         const {
-            definition: _ignore1, // eslint-disable-line no-unused-vars
-            original: _ignore2, // eslint-disable-line no-unused-vars
+            definition: _ignore1, // eslint-disable-line no-unused-vars -- needed to make `obj` correct
+            original: _ignore2, // eslint-disable-line no-unused-vars -- needed to make `obj` correct
             ...obj
         } = this;
 

data/node_modules/@eslint/eslintrc/lib/config-array/extracted-config.js

@@ -120,10 +120,10 @@ class ExtractedConfig {
      */
     toCompatibleObjectAsConfigFileContent() {
         const {
-            /* eslint-disable no-unused-vars */
+            /* eslint-disable no-unused-vars -- needed to make `config` correct */
             configNameOfNoInlineConfig: _ignore1,
             processor: _ignore2,
-            /* eslint-enable no-unused-vars */
+            /* eslint-enable no-unused-vars -- needed to make `config` correct */
             ignores,
             ...config
         } = this;

data/node_modules/@eslint/eslintrc/lib/config-array/ignore-pattern.js

@@ -32,8 +32,8 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-import assert from "assert";
-import path from "path";
+import assert from "node:assert";
+import path from "node:path";
 import ignore from "ignore";
 import debugOrig from "debug";
 
@@ -117,6 +117,9 @@ const DotPatterns = Object.freeze([".*", "!.eslintrc.*", "!../"]);
 // Public
 //------------------------------------------------------------------------------
 
+/**
+ * Represents a set of glob patterns to ignore against a base path.
+ */
 class IgnorePattern {
 
     /**
@@ -153,9 +156,7 @@ class IgnorePattern {
         debug("Create with: %o", ignorePatterns);
 
         const basePath = getCommonAncestorPath(ignorePatterns.map(p => p.basePath));
-        const patterns = [].concat(
-            ...ignorePatterns.map(p => p.getPatternsRelativeTo(basePath))
-        );
+        const patterns = ignorePatterns.flatMap(p => p.getPatternsRelativeTo(basePath));
         const ig = ignore({ allowRelativePaths: true }).add([...DotPatterns, ...patterns]);
         const dotIg = ignore({ allowRelativePaths: true }).add(patterns);
 

data/node_modules/@eslint/eslintrc/lib/config-array/override-tester.js

@@ -17,9 +17,9 @@
  * @author Toru Nagashima <https://github.com/mysticatea>
  */
 
-import assert from "assert";
-import path from "path";
-import util from "util";
+import assert from "node:assert";
+import path from "node:path";
+import util from "node:util";
 import minimatch from "minimatch";
 
 const { Minimatch } = minimatch;
@@ -94,6 +94,7 @@ class OverrideTester {
      * @param {string|string[]} excludedFiles The glob patterns for excluded files.
      * @param {string} basePath The path to the base directory to test paths.
      * @returns {OverrideTester|null} The created instance or `null`.
+     * @throws {Error} When invalid patterns are given.
      */
     static create(files, excludedFiles, basePath) {
         const includePatterns = normalizePatterns(files);
@@ -183,6 +184,7 @@ class OverrideTester {
      * Test if a given path is matched or not.
      * @param {string} filePath The absolute path to the target file.
      * @returns {boolean} `true` if the path was matched.
+     * @throws {Error} When invalid `filePath` is given.
      */
     test(filePath) {
         if (typeof filePath !== "string" || !path.isAbsolute(filePath)) {
@@ -196,8 +198,8 @@ class OverrideTester {
         ));
     }
 
-    // eslint-disable-next-line jsdoc/require-description
     /**
+     * Converts this instance to a JSON compatible object.
      * @returns {Object} a JSON compatible object.
      */
     toJSON() {
@@ -213,8 +215,8 @@ class OverrideTester {
         };
     }
 
-    // eslint-disable-next-line jsdoc/require-description
     /**
+     * Custom inspect method for Node.js `console.log()`.
      * @returns {Object} an object to display by `console.log()`.
      */
     [util.inspect.custom]() {

data/node_modules/@eslint/eslintrc/lib/config-array-factory.js

@@ -39,10 +39,10 @@
 //------------------------------------------------------------------------------
 
 import debugOrig from "debug";
-import fs from "fs";
+import fs from "node:fs";
 import importFresh from "import-fresh";
-import { createRequire } from "module";
-import path from "path";
+import { createRequire } from "node:module";
+import path from "node:path";
 import stripComments from "strip-json-comments";
 
 import {
@@ -254,7 +254,7 @@ function loadPackageJSONConfigFile(filePath) {
     try {
         const packageData = loadJSONConfigFile(filePath);
 
-        if (!Object.hasOwnProperty.call(packageData, "eslintConfig")) {
+        if (!Object.hasOwn(packageData, "eslintConfig")) {
             throw Object.assign(
                 new Error("package.json file doesn't have 'eslintConfig' field."),
                 { code: "ESLINT_CONFIG_FIELD_NOT_FOUND" }
@@ -273,6 +273,7 @@ function loadPackageJSONConfigFile(filePath) {
  * Loads a `.eslintignore` from a file.
  * @param {string} filePath The filename to load.
  * @returns {string[]} The ignore patterns from the file.
+ * @throws {Error} If the file cannot be read.
  * @private
  */
 function loadESLintIgnoreFile(filePath) {
@@ -345,7 +346,7 @@ function loadConfigFile(filePath) {
 function writeDebugLogForLoading(request, relativeTo, filePath) {
     /* istanbul ignore next */
     if (debug.enabled) {
-        let nameAndVersion = null;
+        let nameAndVersion = null; // eslint-disable-line no-useless-assignment -- known bug in the rule
 
         try {
             const packageJsonPath = ModuleResolver.resolve(
@@ -510,6 +511,7 @@ class ConfigArrayFactory {
      * @param {Object} [options] The options.
      * @param {string} [options.basePath] The base path to resolve relative paths in `overrides[].files`, `overrides[].excludedFiles`, and `ignorePatterns`.
      * @param {string} [options.name] The config name.
+     * @throws {Error} If the config file is invalid.
      * @returns {ConfigArray} Loaded config. An empty `ConfigArray` if any config doesn't exist.
      */
     loadInDirectory(directoryPath, { basePath, name } = {}) {
@@ -595,6 +597,7 @@ class ConfigArrayFactory {
     /**
      * Load `.eslintignore` file in the current working directory.
      * @returns {ConfigArray} Loaded config. An empty `ConfigArray` if any config doesn't exist.
+     * @throws {Error} If the ignore file is invalid.
      */
     loadDefaultESLintIgnore() {
         const slots = internalSlotsMap.get(this);
@@ -607,7 +610,7 @@ class ConfigArrayFactory {
         if (fs.existsSync(packageJsonPath)) {
             const data = loadJSONConfigFile(packageJsonPath);
 
-            if (Object.hasOwnProperty.call(data, "eslintIgnore")) {
+            if (Object.hasOwn(data, "eslintIgnore")) {
                 if (!Array.isArray(data.eslintIgnore)) {
                     throw new Error("Package.json eslintIgnore property requires an array of paths");
                 }
@@ -796,6 +799,7 @@ class ConfigArrayFactory {
      * @param {string} extendName The name of a base config.
      * @param {ConfigArrayFactoryLoadingContext} ctx The loading context.
      * @returns {IterableIterator<ConfigArrayElement>} The normalized config.
+     * @throws {Error} If the extended config file can't be loaded.
      * @private
      */
     _loadExtends(extendName, ctx) {
@@ -819,6 +823,7 @@ class ConfigArrayFactory {
      * @param {string} extendName The name of a base config.
      * @param {ConfigArrayFactoryLoadingContext} ctx The loading context.
      * @returns {IterableIterator<ConfigArrayElement>} The normalized config.
+     * @throws {Error} If the extended config file can't be loaded.
      * @private
      */
     _loadExtendedBuiltInConfig(extendName, ctx) {
@@ -868,6 +873,7 @@ class ConfigArrayFactory {
      * @param {string} extendName The name of a base config.
      * @param {ConfigArrayFactoryLoadingContext} ctx The loading context.
      * @returns {IterableIterator<ConfigArrayElement>} The normalized config.
+     * @throws {Error} If the extended config file can't be loaded.
      * @private
      */
     _loadExtendedPluginConfig(extendName, ctx) {
@@ -905,6 +911,7 @@ class ConfigArrayFactory {
      * @param {string} extendName The name of a base config.
      * @param {ConfigArrayFactoryLoadingContext} ctx The loading context.
      * @returns {IterableIterator<ConfigArrayElement>} The normalized config.
+     * @throws {Error} If the extended config file can't be loaded.
      * @private
      */
     _loadExtendedShareableConfig(extendName, ctx) {

data/node_modules/@eslint/eslintrc/lib/flat-compat.js

@@ -8,7 +8,7 @@
 //-----------------------------------------------------------------------------
 
 import createDebug from "debug";
-import path from "path";
+import path from "node:path";
 
 import environments from "../conf/environments.js";
 import { ConfigArrayFactory } from "./config-array-factory.js";
@@ -37,6 +37,7 @@ const cafactory = Symbol("cafactory");
  * @param {ReadOnlyMap<string,Processor>} options.pluginProcessors A map of plugin processor
  *      names to objects.
  * @returns {Object} A flag-config-style config object.
+ * @throws {Error} If a plugin or environment cannot be resolved.
  */
 function translateESLintRC(eslintrcConfig, {
     resolveConfigRelativeTo,
@@ -219,7 +220,7 @@ class FlatCompat {
         this[cafactory] = new ConfigArrayFactory({
             cwd: baseDirectory,
             resolvePluginsRelativeTo,
-            getEslintAllConfig: () => {
+            getEslintAllConfig() {
 
                 if (!allConfig) {
                     throw new TypeError("Missing parameter 'allConfig' in FlatCompat constructor.");
@@ -227,7 +228,7 @@ class FlatCompat {
 
                 return allConfig;
             },
-            getEslintRecommendedConfig: () => {
+            getEslintRecommendedConfig() {
 
                 if (!recommendedConfig) {
                     throw new TypeError("Missing parameter 'recommendedConfig' in FlatCompat constructor.");

data/node_modules/@eslint/eslintrc/lib/shared/ajv.js

@@ -184,7 +184,7 @@ export default (additionalOptions = {}) => {
     });
 
     ajv.addMetaSchema(metaSchema);
-    // eslint-disable-next-line no-underscore-dangle
+    // eslint-disable-next-line no-underscore-dangle -- part of the API
     ajv._opts.defaultMeta = metaSchema.id;
 
     return ajv;

data/node_modules/@eslint/eslintrc/lib/shared/config-ops.js

@@ -13,7 +13,7 @@ const RULE_SEVERITY_STRINGS = ["off", "warn", "error"],
         map[value] = index;
         return map;
     }, {}),
-    VALID_SEVERITIES = [0, 1, 2, "off", "warn", "error"];
+    VALID_SEVERITIES = new Set([0, 1, 2, "off", "warn", "error"]);
 
 //------------------------------------------------------------------------------
 // Public Interface
@@ -83,7 +83,7 @@ function isValidSeverity(ruleConfig) {
     if (typeof severity === "string") {
         severity = severity.toLowerCase();
     }
-    return VALID_SEVERITIES.indexOf(severity) !== -1;
+    return VALID_SEVERITIES.has(severity);
 }
 
 /**

data/node_modules/@eslint/eslintrc/lib/shared/config-validator.js

@@ -3,7 +3,7 @@
  * @author Brandon Mills
  */
 
-/* eslint class-methods-use-this: "off" */
+/* eslint class-methods-use-this: "off" -- not needed in this file */
 
 //------------------------------------------------------------------------------
 // Typedefs
@@ -15,7 +15,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-import util from "util";
+import util from "node:util";
 import * as ConfigOps from "./config-ops.js";
 import { emitDeprecationWarning } from "./deprecation-warnings.js";
 import ajvOrig from "./ajv.js";
@@ -51,6 +51,9 @@ const noOptionsSchema = Object.freeze({
 // Exports
 //-----------------------------------------------------------------------------
 
+/**
+ * Validator for configuration objects.
+ */
 export default class ConfigValidator {
     constructor({ builtInRules = new Map() } = {}) {
         this.builtInRules = builtInRules;
@@ -110,6 +113,7 @@ export default class ConfigValidator {
      * Validates a rule's severity and returns the severity value. Throws an error if the severity is invalid.
      * @param {options} options The given options for the rule.
      * @returns {number|string} The rule's severity value
+     * @throws {Error} If the severity is invalid.
      */
     validateRuleSeverity(options) {
         const severity = Array.isArray(options) ? options[0] : options;
@@ -128,6 +132,7 @@ export default class ConfigValidator {
      * @param {{create: Function}} rule The rule to validate
      * @param {Array} localOptions The options for the rule, excluding severity
      * @returns {void}
+     * @throws {Error} If the options are invalid.
      */
     validateRuleSchema(rule, localOptions) {
         if (!ruleValidators.has(rule)) {
@@ -169,6 +174,7 @@ export default class ConfigValidator {
      * @param {string|null} source The name of the configuration source to report in any errors. If null or undefined,
      * no source is prepended to the message.
      * @returns {void}
+     * @throws {Error} If the options are invalid.
      */
     validateRuleOptions(rule, ruleId, options, source = null) {
         try {
@@ -200,8 +206,9 @@ export default class ConfigValidator {
      * Validates an environment object
      * @param {Object} environment The environment config object to validate.
      * @param {string} source The name of the configuration source to report in any errors.
-     * @param {function(envId:string): Object} [getAdditionalEnv] A map from strings to loaded environments.
+     * @param {(envId:string) => Object} [getAdditionalEnv] A map from strings to loaded environments.
      * @returns {void}
+     * @throws {Error} If the environment is invalid.
      */
     validateEnvironment(
         environment,
@@ -229,7 +236,7 @@ export default class ConfigValidator {
      * Validates a rules config object
      * @param {Object} rulesConfig The rules config object to validate.
      * @param {string} source The name of the configuration source to report in any errors.
-     * @param {function(ruleId:string): Object} getAdditionalRule A map from strings to loaded rules
+     * @param {(ruleId:string) => Object} getAdditionalRule A map from strings to loaded rules
      * @returns {void}
      */
     validateRules(
@@ -273,8 +280,9 @@ export default class ConfigValidator {
      * Validate `processor` configuration.
      * @param {string|undefined} processorName The processor name.
      * @param {string} source The name of config file.
-     * @param {function(id:string): Processor} getProcessor The getter of defined processors.
+     * @param {(id:string) => Processor} getProcessor The getter of defined processors.
      * @returns {void}
+     * @throws {Error} If the processor is invalid.
      */
     validateProcessor(processorName, source, getProcessor) {
         if (processorName && !getProcessor(processorName)) {
@@ -313,6 +321,7 @@ export default class ConfigValidator {
      * @param {Object} config The config object to validate.
      * @param {string} source The name of the configuration source to report in any errors.
      * @returns {void}
+     * @throws {Error} If the config is invalid.
      */
     validateConfigSchema(config, source = null) {
         validateSchema = validateSchema || ajv.compile(configSchema);
@@ -321,7 +330,7 @@ export default class ConfigValidator {
             throw new Error(`ESLint configuration in ${source} is invalid:\n${this.formatErrors(validateSchema.errors)}`);
         }
 
-        if (Object.hasOwnProperty.call(config, "ecmaFeatures")) {
+        if (Object.hasOwn(config, "ecmaFeatures")) {
             emitDeprecationWarning(source, "ESLINT_LEGACY_ECMAFEATURES");
         }
     }
@@ -330,8 +339,8 @@ export default class ConfigValidator {
      * Validates an entire config object.
      * @param {Object} config The config object to validate.
      * @param {string} source The name of the configuration source to report in any errors.
-     * @param {function(ruleId:string): Object} [getAdditionalRule] A map from strings to loaded rules.
-     * @param {function(envId:string): Object} [getAdditionalEnv] A map from strings to loaded envs.
+     * @param {(ruleId:string) => Object} [getAdditionalRule] A map from strings to loaded rules.
+     * @param {(envId:string) => Object} [getAdditionalEnv] A map from strings to loaded envs.
      * @returns {void}
      */
     validate(config, source, getAdditionalRule, getAdditionalEnv) {

data/node_modules/@eslint/eslintrc/lib/shared/deprecation-warnings.js

@@ -7,7 +7,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-import path from "path";
+import path from "node:path";
 
 //------------------------------------------------------------------------------
 // Private

data/node_modules/@eslint/eslintrc/lib/shared/relative-module-resolver.js

@@ -3,7 +3,7 @@
  * @author Teddy Katz
  */
 
-import Module from "module";
+import Module from "node:module";
 
 /*
  * `Module.createRequire` is added in v12.2.0. It supports URL as well.
@@ -17,6 +17,7 @@ const createRequire = Module.createRequire;
  * @param {string} relativeToPath An absolute path indicating the module that `moduleName` should be resolved relative to. This must be
  * a file rather than a directory, but the file need not actually exist.
  * @returns {string} The absolute path that would result from calling `require.resolve(moduleName)` in a file located at `relativeToPath`
+ * @throws {Error} When the module cannot be resolved.
  */
 function resolve(moduleName, relativeToPath) {
     try {

data/node_modules/@eslint/eslintrc/lib/types/index.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @fileoverview This file contains the core types for ESLint. It was initially extracted
+ * from the `@types/eslint__eslintrc` package.
+ */
+
+/*
+ * MIT License
+ * Copyright (c) Microsoft Corporation.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE
+ */
+
+import type { Linter } from "eslint";
+
+/**
+ * A compatibility class for working with configs.
+ */
+export class FlatCompat {
+    constructor({
+        baseDirectory,
+        resolvePluginsRelativeTo,
+        recommendedConfig,
+        allConfig,
+    }?: {
+        /**
+         * default: process.cwd()
+         */
+        baseDirectory?: string;
+        resolvePluginsRelativeTo?: string;
+        recommendedConfig?: Linter.LegacyConfig;
+        allConfig?: Linter.LegacyConfig;
+    });
+
+    /**
+     * Translates an ESLintRC-style config into a flag-config-style config.
+     * @param eslintrcConfig The ESLintRC-style config object.
+     * @returns A flag-config-style config object.
+     */
+    config(eslintrcConfig: Linter.LegacyConfig): Linter.Config[];
+
+    /**
+     * Translates the `env` section of an ESLintRC-style config.
+     * @param envConfig The `env` section of an ESLintRC config.
+     * @returns An array of flag-config objects representing the environments.
+     */
+    env(envConfig: { [name: string]: boolean }): Linter.Config[];
+
+    /**
+     * Translates the `extends` section of an ESLintRC-style config.
+     * @param configsToExtend The names of the configs to load.
+     * @returns An array of flag-config objects representing the config.
+     */
+    extends(...configsToExtend: string[]): Linter.Config[];
+
+    /**
+     * Translates the `plugins` section of an ESLintRC-style config.
+     * @param plugins The names of the plugins to load.
+     * @returns An array of flag-config objects representing the plugins.
+     */
+    plugins(...plugins: string[]): Linter.Config[];
+}