12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226 |
- 'use strict';
- var path = require('node:path');
- var minimatch = require('minimatch');
- var createDebug = require('debug');
- var objectSchema = require('@eslint/object-schema');
- const NOOP_STRATEGY = {
- required: false,
- merge() {
- return undefined;
- },
- validate() {},
- };
- const baseSchema = Object.freeze({
- name: {
- required: false,
- merge() {
- return undefined;
- },
- validate(value) {
- if (typeof value !== "string") {
- throw new TypeError("Property must be a string.");
- }
- },
- },
- files: NOOP_STRATEGY,
- ignores: NOOP_STRATEGY,
- });
- function assertIsArray(value) {
- if (!Array.isArray(value)) {
- throw new TypeError("Expected value to be an array.");
- }
- }
- function assertIsArrayOfStringsAndFunctions(value) {
- assertIsArray(value);
- if (
- value.some(
- item => typeof item !== "string" && typeof item !== "function",
- )
- ) {
- throw new TypeError(
- "Expected array to only contain strings and functions.",
- );
- }
- }
- function assertIsNonEmptyArray(value) {
- if (!Array.isArray(value) || value.length === 0) {
- throw new TypeError("Expected value to be a non-empty array.");
- }
- }
- const filesAndIgnoresSchema = Object.freeze({
- files: {
- required: false,
- merge() {
- return undefined;
- },
- validate(value) {
-
- assertIsNonEmptyArray(value);
-
- value.forEach(item => {
- if (Array.isArray(item)) {
- assertIsArrayOfStringsAndFunctions(item);
- } else if (
- typeof item !== "string" &&
- typeof item !== "function"
- ) {
- throw new TypeError(
- "Items must be a string, a function, or an array of strings and functions.",
- );
- }
- });
- },
- },
- ignores: {
- required: false,
- merge() {
- return undefined;
- },
- validate: assertIsArrayOfStringsAndFunctions,
- },
- });
- const Minimatch = minimatch.Minimatch;
- const debug = createDebug("@eslint/config-array");
- const minimatchCache = new Map();
- const negatedMinimatchCache = new Map();
- const MINIMATCH_OPTIONS = {
-
- dot: true,
- allowWindowsEscape: true,
- };
- const CONFIG_TYPES = new Set(["array", "function"]);
- const META_FIELDS = new Set(["name"]);
- const FILES_AND_IGNORES_SCHEMA = new objectSchema.ObjectSchema(filesAndIgnoresSchema);
- const CONFIG_WITH_STATUS_EXTERNAL = Object.freeze({ status: "external" });
- const CONFIG_WITH_STATUS_IGNORED = Object.freeze({ status: "ignored" });
- const CONFIG_WITH_STATUS_UNCONFIGURED = Object.freeze({
- status: "unconfigured",
- });
- class ConfigError extends Error {
-
- constructor(name, index, { cause, message }) {
- const finalMessage = message || cause.message;
- super(`Config ${name}: ${finalMessage}`, { cause });
-
- if (cause) {
- for (const key of Object.keys(cause)) {
- if (!(key in this)) {
- this[key] = cause[key];
- }
- }
- }
-
- this.name = "ConfigError";
-
- this.index = index;
- }
- }
- function getConfigName(config) {
- if (config && typeof config.name === "string" && config.name) {
- return `"${config.name}"`;
- }
- return "(unnamed)";
- }
- function rethrowConfigError(config, index, error) {
- const configName = getConfigName(config);
- throw new ConfigError(configName, index, { cause: error });
- }
- function isString(value) {
- return typeof value === "string";
- }
- function assertValidBaseConfig(config, index) {
- if (config === null) {
- throw new ConfigError(getConfigName(config), index, {
- message: "Unexpected null config.",
- });
- }
- if (config === undefined) {
- throw new ConfigError(getConfigName(config), index, {
- message: "Unexpected undefined config.",
- });
- }
- if (typeof config !== "object") {
- throw new ConfigError(getConfigName(config), index, {
- message: "Unexpected non-object config.",
- });
- }
- const validateConfig = {};
- if ("files" in config) {
- validateConfig.files = config.files;
- }
- if ("ignores" in config) {
- validateConfig.ignores = config.ignores;
- }
- try {
- FILES_AND_IGNORES_SCHEMA.validate(validateConfig);
- } catch (validationError) {
- rethrowConfigError(config, index, validationError);
- }
- }
- function doMatch(filepath, pattern, options = {}) {
- let cache = minimatchCache;
- if (options.flipNegate) {
- cache = negatedMinimatchCache;
- }
- let matcher = cache.get(pattern);
- if (!matcher) {
- matcher = new Minimatch(
- pattern,
- Object.assign({}, MINIMATCH_OPTIONS, options),
- );
- cache.set(pattern, matcher);
- }
- return matcher.match(filepath);
- }
- async function normalize(items, context, extraConfigTypes) {
- const allowFunctions = extraConfigTypes.includes("function");
- const allowArrays = extraConfigTypes.includes("array");
- async function* flatTraverse(array) {
- for (let item of array) {
- if (typeof item === "function") {
- if (!allowFunctions) {
- throw new TypeError("Unexpected function.");
- }
- item = item(context);
- if (item.then) {
- item = await item;
- }
- }
- if (Array.isArray(item)) {
- if (!allowArrays) {
- throw new TypeError("Unexpected array.");
- }
- yield* flatTraverse(item);
- } else if (typeof item === "function") {
- throw new TypeError(
- "A config function can only return an object or array.",
- );
- } else {
- yield item;
- }
- }
- }
-
- const asyncIterable = await flatTraverse(items);
- const configs = [];
- for await (const config of asyncIterable) {
- configs.push(config);
- }
- return configs;
- }
- function normalizeSync(items, context, extraConfigTypes) {
- const allowFunctions = extraConfigTypes.includes("function");
- const allowArrays = extraConfigTypes.includes("array");
- function* flatTraverse(array) {
- for (let item of array) {
- if (typeof item === "function") {
- if (!allowFunctions) {
- throw new TypeError("Unexpected function.");
- }
- item = item(context);
- if (item.then) {
- throw new TypeError(
- "Async config functions are not supported.",
- );
- }
- }
- if (Array.isArray(item)) {
- if (!allowArrays) {
- throw new TypeError("Unexpected array.");
- }
- yield* flatTraverse(item);
- } else if (typeof item === "function") {
- throw new TypeError(
- "A config function can only return an object or array.",
- );
- } else {
- yield item;
- }
- }
- }
- return [...flatTraverse(items)];
- }
- function shouldIgnorePath(ignores, filePath, relativeFilePath) {
-
- if (relativeFilePath.startsWith("..")) {
- return true;
- }
- return ignores.reduce((ignored, matcher) => {
- if (!ignored) {
- if (typeof matcher === "function") {
- return matcher(filePath);
- }
-
- if (!matcher.startsWith("!")) {
- return doMatch(relativeFilePath, matcher);
- }
-
- return false;
- }
-
- if (typeof matcher === "string" && matcher.startsWith("!")) {
- return !doMatch(relativeFilePath, matcher, {
- flipNegate: true,
- });
- }
- return ignored;
- }, false);
- }
- function pathMatchesIgnores(filePath, basePath, config) {
-
- const relativeFilePath = path.relative(basePath, filePath);
- return (
- Object.keys(config).filter(key => !META_FIELDS.has(key)).length > 1 &&
- !shouldIgnorePath(config.ignores, filePath, relativeFilePath)
- );
- }
- function pathMatches(filePath, basePath, config) {
-
- const relativeFilePath = path.relative(basePath, filePath);
-
- function match(pattern) {
- if (isString(pattern)) {
- return doMatch(relativeFilePath, pattern);
- }
- if (typeof pattern === "function") {
- return pattern(filePath);
- }
- throw new TypeError(`Unexpected matcher type ${pattern}.`);
- }
-
- let filePathMatchesPattern = config.files.some(pattern => {
- if (Array.isArray(pattern)) {
- return pattern.every(match);
- }
- return match(pattern);
- });
-
- if (filePathMatchesPattern && config.ignores) {
- filePathMatchesPattern = !shouldIgnorePath(
- config.ignores,
- filePath,
- relativeFilePath,
- );
- }
- return filePathMatchesPattern;
- }
- function assertNormalized(configArray) {
-
- if (!configArray.isNormalized()) {
- throw new Error(
- "ConfigArray must be normalized to perform this operation.",
- );
- }
- }
- function assertExtraConfigTypes(extraConfigTypes) {
- if (extraConfigTypes.length > 2) {
- throw new TypeError(
- "configTypes must be an array with at most two items.",
- );
- }
- for (const configType of extraConfigTypes) {
- if (!CONFIG_TYPES.has(configType)) {
- throw new TypeError(
- `Unexpected config type "${configType}" found. Expected one of: "object", "array", "function".`,
- );
- }
- }
- }
- const ConfigArraySymbol = {
- isNormalized: Symbol("isNormalized"),
- configCache: Symbol("configCache"),
- schema: Symbol("schema"),
- finalizeConfig: Symbol("finalizeConfig"),
- preprocessConfig: Symbol("preprocessConfig"),
- };
- const dataCache = new WeakMap();
- class ConfigArray extends Array {
-
- constructor(
- configs,
- {
- basePath = "",
- normalized = false,
- schema: customSchema,
- extraConfigTypes = [],
- } = {},
- ) {
- super();
-
- this[ConfigArraySymbol.isNormalized] = normalized;
-
- this[ConfigArraySymbol.schema] = new objectSchema.ObjectSchema(
- Object.assign({}, customSchema, baseSchema),
- );
-
- this.basePath = basePath;
- assertExtraConfigTypes(extraConfigTypes);
-
- this.extraConfigTypes = [...extraConfigTypes];
- Object.freeze(this.extraConfigTypes);
-
- this[ConfigArraySymbol.configCache] = new Map();
-
- dataCache.set(this, {
- explicitMatches: new Map(),
- directoryMatches: new Map(),
- files: undefined,
- ignores: undefined,
- });
-
- if (Array.isArray(configs)) {
- this.push(...configs);
- } else {
- this.push(configs);
- }
- }
-
- static get [Symbol.species]() {
- return Array;
- }
-
- get files() {
- assertNormalized(this);
-
- const cache = dataCache.get(this);
- if (cache.files) {
- return cache.files;
- }
-
- const result = [];
- for (const config of this) {
- if (config.files) {
- config.files.forEach(filePattern => {
- result.push(filePattern);
- });
- }
- }
-
- cache.files = result;
- dataCache.set(this, cache);
- return result;
- }
-
- get ignores() {
- assertNormalized(this);
-
- const cache = dataCache.get(this);
- if (cache.ignores) {
- return cache.ignores;
- }
-
- const result = [];
- for (const config of this) {
-
- if (
- config.ignores &&
- Object.keys(config).filter(key => !META_FIELDS.has(key))
- .length === 1
- ) {
- result.push(...config.ignores);
- }
- }
-
- cache.ignores = result;
- dataCache.set(this, cache);
- return result;
- }
-
- isNormalized() {
- return this[ConfigArraySymbol.isNormalized];
- }
-
- async normalize(context = {}) {
- if (!this.isNormalized()) {
- const normalizedConfigs = await normalize(
- this,
- context,
- this.extraConfigTypes,
- );
- this.length = 0;
- this.push(
- ...normalizedConfigs.map(
- this[ConfigArraySymbol.preprocessConfig].bind(this),
- ),
- );
- this.forEach(assertValidBaseConfig);
- this[ConfigArraySymbol.isNormalized] = true;
-
- Object.freeze(this);
- }
- return this;
- }
-
- normalizeSync(context = {}) {
- if (!this.isNormalized()) {
- const normalizedConfigs = normalizeSync(
- this,
- context,
- this.extraConfigTypes,
- );
- this.length = 0;
- this.push(
- ...normalizedConfigs.map(
- this[ConfigArraySymbol.preprocessConfig].bind(this),
- ),
- );
- this.forEach(assertValidBaseConfig);
- this[ConfigArraySymbol.isNormalized] = true;
-
- Object.freeze(this);
- }
- return this;
- }
-
-
- [ConfigArraySymbol.finalizeConfig](config) {
- return config;
- }
-
- [ConfigArraySymbol.preprocessConfig](config) {
- return config;
- }
-
-
- getConfigWithStatus(filePath) {
- assertNormalized(this);
- const cache = this[ConfigArraySymbol.configCache];
-
- if (cache.has(filePath)) {
- return cache.get(filePath);
- }
-
- const relativeFilePath = path.relative(this.basePath, filePath);
- if (relativeFilePath.startsWith("..")) {
- debug(`No config for file ${filePath} outside of base path`);
-
- cache.set(filePath, CONFIG_WITH_STATUS_EXTERNAL);
- return CONFIG_WITH_STATUS_EXTERNAL;
- }
-
-
- if (this.isDirectoryIgnored(path.dirname(filePath))) {
- debug(`Ignoring ${filePath} based on directory pattern`);
-
- cache.set(filePath, CONFIG_WITH_STATUS_IGNORED);
- return CONFIG_WITH_STATUS_IGNORED;
- }
- if (shouldIgnorePath(this.ignores, filePath, relativeFilePath)) {
- debug(`Ignoring ${filePath} based on file pattern`);
-
- cache.set(filePath, CONFIG_WITH_STATUS_IGNORED);
- return CONFIG_WITH_STATUS_IGNORED;
- }
-
- const matchingConfigIndices = [];
- let matchFound = false;
- const universalPattern = /^\*$|\/\*{1,2}$/u;
- this.forEach((config, index) => {
- if (!config.files) {
- if (!config.ignores) {
- debug(`Anonymous universal config found for ${filePath}`);
- matchingConfigIndices.push(index);
- return;
- }
- if (pathMatchesIgnores(filePath, this.basePath, config)) {
- debug(
- `Matching config found for ${filePath} (based on ignores: ${config.ignores})`,
- );
- matchingConfigIndices.push(index);
- return;
- }
- debug(
- `Skipped config found for ${filePath} (based on ignores: ${config.ignores})`,
- );
- return;
- }
-
- const universalFiles = config.files.filter(pattern =>
- universalPattern.test(pattern),
- );
-
- if (universalFiles.length) {
- debug("Universal files patterns found. Checking carefully.");
- const nonUniversalFiles = config.files.filter(
- pattern => !universalPattern.test(pattern),
- );
-
- if (
- nonUniversalFiles.length &&
- pathMatches(filePath, this.basePath, {
- files: nonUniversalFiles,
- ignores: config.ignores,
- })
- ) {
- debug(`Matching config found for ${filePath}`);
- matchingConfigIndices.push(index);
- matchFound = true;
- return;
- }
-
- if (
- universalFiles.length &&
- pathMatches(filePath, this.basePath, {
- files: universalFiles,
- ignores: config.ignores,
- })
- ) {
- debug(`Matching config found for ${filePath}`);
- matchingConfigIndices.push(index);
- return;
- }
-
- return;
- }
-
- if (pathMatches(filePath, this.basePath, config)) {
- debug(`Matching config found for ${filePath}`);
- matchingConfigIndices.push(index);
- matchFound = true;
- }
- });
-
- if (!matchFound) {
- debug(`No matching configs found for ${filePath}`);
-
- cache.set(filePath, CONFIG_WITH_STATUS_UNCONFIGURED);
- return CONFIG_WITH_STATUS_UNCONFIGURED;
- }
-
- const indicesKey = matchingConfigIndices.toString();
- let configWithStatus = cache.get(indicesKey);
- if (configWithStatus) {
-
- cache.set(filePath, configWithStatus);
- return configWithStatus;
- }
-
-
- let finalConfig = matchingConfigIndices.reduce((result, index) => {
- try {
- return this[ConfigArraySymbol.schema].merge(
- result,
- this[index],
- );
- } catch (validationError) {
- rethrowConfigError(this[index], index, validationError);
- }
- }, {});
- finalConfig = this[ConfigArraySymbol.finalizeConfig](finalConfig);
- configWithStatus = Object.freeze({
- config: finalConfig,
- status: "matched",
- });
- cache.set(filePath, configWithStatus);
- cache.set(indicesKey, configWithStatus);
- return configWithStatus;
- }
-
- getConfig(filePath) {
- return this.getConfigWithStatus(filePath).config;
- }
-
- getConfigStatus(filePath) {
- return this.getConfigWithStatus(filePath).status;
- }
-
- isIgnored(filePath) {
- return this.isFileIgnored(filePath);
- }
-
- isFileIgnored(filePath) {
- return this.getConfigStatus(filePath) === "ignored";
- }
-
- isDirectoryIgnored(directoryPath) {
- assertNormalized(this);
- const relativeDirectoryPath = path
- .relative(this.basePath, directoryPath)
- .replace(/\\/gu, "/");
-
- if (relativeDirectoryPath === "") {
- return false;
- }
- if (relativeDirectoryPath.startsWith("..")) {
- return true;
- }
-
- const cache = dataCache.get(this).directoryMatches;
- if (cache.has(relativeDirectoryPath)) {
- return cache.get(relativeDirectoryPath);
- }
- const directoryParts = relativeDirectoryPath.split("/");
- let relativeDirectoryToCheck = "";
- let result;
-
- do {
- relativeDirectoryToCheck += `${directoryParts.shift()}/`;
- result = shouldIgnorePath(
- this.ignores,
- path.join(this.basePath, relativeDirectoryToCheck),
- relativeDirectoryToCheck,
- );
- cache.set(relativeDirectoryToCheck, result);
- } while (!result && directoryParts.length);
-
- cache.set(relativeDirectoryPath, result);
- return result;
- }
- }
- Object.defineProperty(exports, "ObjectSchema", {
- enumerable: true,
- get: function () { return objectSchema.ObjectSchema; }
- });
- exports.ConfigArray = ConfigArray;
- exports.ConfigArraySymbol = ConfigArraySymbol;
|