@vercel/fs-detectors 5.0.1 → 5.0.2

package/dist/detect-framework.js

@@ -1,166 +1,219 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.detectFrameworkVersion = exports.detectFrameworkRecord = exports.detectFrameworks = exports.detectFramework = exports.removeSupersededFrameworks = void 0;
-const child_process_1 = require("child_process");
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var detect_framework_exports = {};
+__export(detect_framework_exports, {
+  detectFramework: () => detectFramework,
+  detectFrameworkRecord: () => detectFrameworkRecord,
+  detectFrameworkVersion: () => detectFrameworkVersion,
+  detectFrameworks: () => detectFrameworks,
+  removeSupersededFrameworks: () => removeSupersededFrameworks
+});
+module.exports = __toCommonJS(detect_framework_exports);
+var import_child_process = require("child_process");
 async function matches(fs, framework) {
-    const { detectors } = framework;
-    if (!detectors) {
-        return;
+  const { detectors } = framework;
+  if (!detectors) {
+    return;
+  }
+  const { every, some } = detectors;
+  if (every !== void 0 && !Array.isArray(every)) {
+    return;
+  }
+  if (some !== void 0 && !Array.isArray(some)) {
+    return;
+  }
+  const check = async ({
+    path,
+    matchContent,
+    matchPackage
+  }) => {
+    if (matchPackage && matchContent) {
+      throw new Error(
+        `Cannot specify "matchPackage" and "matchContent" in the same detector for "${framework.slug}"`
+      );
     }
-    const { every, some } = detectors;
-    if (every !== undefined && !Array.isArray(every)) {
-        return;
+    if (matchPackage && path) {
+      throw new Error(
+        `Cannot specify "matchPackage" and "path" in the same detector for "${framework.slug}" because "path" is assumed to be "package.json".`
+      );
     }
-    if (some !== undefined && !Array.isArray(some)) {
-        return;
+    if (!path && !matchPackage) {
+      throw new Error(
+        `Must specify either "path" or "matchPackage" in detector for "${framework.slug}".`
+      );
     }
-    const check = async ({ path, matchContent, matchPackage, }) => {
-        if (matchPackage && matchContent) {
-            throw new Error(`Cannot specify "matchPackage" and "matchContent" in the same detector for "${framework.slug}"`);
-        }
-        if (matchPackage && path) {
-            throw new Error(`Cannot specify "matchPackage" and "path" in the same detector for "${framework.slug}" because "path" is assumed to be "package.json".`);
-        }
-        if (!path && !matchPackage) {
-            throw new Error(`Must specify either "path" or "matchPackage" in detector for "${framework.slug}".`);
-        }
-        if (!path) {
-            path = 'package.json';
-        }
-        if (matchPackage) {
-            matchContent = `"(dev)?(d|D)ependencies":\\s*{[^}]*"${matchPackage}":\\s*"(.+?)"[^}]*}`;
-        }
-        if ((await fs.hasPath(path)) === false) {
-            return;
-        }
-        if (matchContent) {
-            if ((await fs.isFile(path)) === false) {
-                return;
-            }
-            const regex = new RegExp(matchContent, 'm');
-            const content = await fs.readFile(path);
-            const match = content.toString().match(regex);
-            if (!match) {
-                return;
-            }
-            if (matchPackage && match[3]) {
-                return {
-                    framework,
-                    detectedVersion: match[3],
-                };
-            }
-        }
-        return {
-            framework,
-        };
-    };
-    const result = [];
-    if (every) {
-        const everyResult = await Promise.all(every.map(item => check(item)));
-        result.push(...everyResult);
+    if (!path) {
+      path = "package.json";
     }
-    if (some) {
-        let someResult;
-        for (const item of some) {
-            const itemResult = await check(item);
-            if (itemResult) {
-                someResult = itemResult;
-                break;
-            }
-        }
-        result.push(someResult);
+    if (matchPackage) {
+      matchContent = `"(dev)?(d|D)ependencies":\\s*{[^}]*"${matchPackage}":\\s*"(.+?)"[^}]*}`;
     }
-    if (!result.every(res => !!res)) {
+    if (await fs.hasPath(path) === false) {
+      return;
+    }
+    if (matchContent) {
+      if (await fs.isFile(path) === false) {
+        return;
+      }
+      const regex = new RegExp(matchContent, "m");
+      const content = await fs.readFile(path);
+      const match = content.toString().match(regex);
+      if (!match) {
         return;
+      }
+      if (matchPackage && match[3]) {
+        return {
+          framework,
+          detectedVersion: match[3]
+        };
+      }
     }
-    const detectedVersion = result.find(r => typeof r === 'object' && r.detectedVersion)?.detectedVersion;
     return {
-        framework,
-        detectedVersion,
+      framework
     };
+  };
+  const result = [];
+  if (every) {
+    const everyResult = await Promise.all(every.map((item) => check(item)));
+    result.push(...everyResult);
+  }
+  if (some) {
+    let someResult;
+    for (const item of some) {
+      const itemResult = await check(item);
+      if (itemResult) {
+        someResult = itemResult;
+        break;
+      }
+    }
+    result.push(someResult);
+  }
+  if (!result.every((res) => !!res)) {
+    return;
+  }
+  const detectedVersion = result.find(
+    (r) => typeof r === "object" && r.detectedVersion
+  )?.detectedVersion;
+  return {
+    framework,
+    detectedVersion
+  };
 }
-function removeSupersededFramework(matches, slug) {
-    const index = matches.findIndex(f => f?.slug === slug);
-    const framework = matches[index];
-    if (framework) {
-        if (framework.supersedes) {
-            removeSupersededFramework(matches, framework.supersedes);
-        }
-        matches.splice(index, 1);
+function removeSupersededFramework(matches2, slug) {
+  const index = matches2.findIndex((f) => f?.slug === slug);
+  const framework = matches2[index];
+  if (framework) {
+    if (framework.supersedes) {
+      removeSupersededFramework(matches2, framework.supersedes);
     }
+    matches2.splice(index, 1);
+  }
 }
-function removeSupersededFrameworks(matches) {
-    for (const match of matches.slice()) {
-        if (match?.supersedes) {
-            removeSupersededFramework(matches, match.supersedes);
-        }
+function removeSupersededFrameworks(matches2) {
+  for (const match of matches2.slice()) {
+    if (match?.supersedes) {
+      removeSupersededFramework(matches2, match.supersedes);
     }
+  }
 }
-exports.removeSupersededFrameworks = removeSupersededFrameworks;
-// TODO: Deprecate and replace with `detectFrameworkRecord`
-async function detectFramework({ fs, frameworkList, }) {
-    const result = await Promise.all(frameworkList.map(async (frameworkMatch) => {
-        if (await matches(fs, frameworkMatch)) {
-            return frameworkMatch;
-        }
-        return null;
-    }));
-    removeSupersededFrameworks(result);
-    return result.find(res => res !== null)?.slug ?? null;
+async function detectFramework({
+  fs,
+  frameworkList
+}) {
+  const result = await Promise.all(
+    frameworkList.map(async (frameworkMatch) => {
+      if (await matches(fs, frameworkMatch)) {
+        return frameworkMatch;
+      }
+      return null;
+    })
+  );
+  removeSupersededFrameworks(result);
+  return result.find((res) => res !== null)?.slug ?? null;
 }
-exports.detectFramework = detectFramework;
-/**
- * Detects all matching Frameworks based on the given virtual filesystem.
- */
-async function detectFrameworks({ fs, frameworkList, }) {
-    const result = await Promise.all(frameworkList.map(async (frameworkMatch) => {
-        if (await matches(fs, frameworkMatch)) {
-            return frameworkMatch;
-        }
-        return null;
-    }));
-    removeSupersededFrameworks(result);
-    return result.filter(res => res !== null);
+async function detectFrameworks({
+  fs,
+  frameworkList
+}) {
+  const result = await Promise.all(
+    frameworkList.map(async (frameworkMatch) => {
+      if (await matches(fs, frameworkMatch)) {
+        return frameworkMatch;
+      }
+      return null;
+    })
+  );
+  removeSupersededFrameworks(result);
+  return result.filter((res) => res !== null);
 }
-exports.detectFrameworks = detectFrameworks;
-// Note: Does not currently support a `frameworkList` of monorepo managers
-async function detectFrameworkRecord({ fs, frameworkList, }) {
-    const result = await Promise.all(frameworkList.map(async (frameworkMatch) => {
-        const matchResult = await matches(fs, frameworkMatch);
-        if (matchResult) {
-            return {
-                ...frameworkMatch,
-                detectedVersion: matchResult?.detectedVersion,
-            };
-        }
-        return null;
-    }));
-    removeSupersededFrameworks(result);
-    return result.find(res => res !== null) ?? null;
+async function detectFrameworkRecord({
+  fs,
+  frameworkList
+}) {
+  const result = await Promise.all(
+    frameworkList.map(async (frameworkMatch) => {
+      const matchResult = await matches(fs, frameworkMatch);
+      if (matchResult) {
+        return {
+          ...frameworkMatch,
+          detectedVersion: matchResult?.detectedVersion
+        };
+      }
+      return null;
+    })
+  );
+  removeSupersededFrameworks(result);
+  return result.find((res) => res !== null) ?? null;
 }
-exports.detectFrameworkRecord = detectFrameworkRecord;
 function detectFrameworkVersion(frameworkRecord) {
-    const allDetectors = [
-        ...(frameworkRecord.detectors?.every || []),
-        ...(frameworkRecord.detectors?.some || []),
-    ];
-    const firstMatchPackage = allDetectors.find(d => d.matchPackage);
-    if (!firstMatchPackage?.matchPackage) {
-        return;
-    }
-    return lookupInstalledVersion(process.execPath, firstMatchPackage.matchPackage);
+  const allDetectors = [
+    ...frameworkRecord.detectors?.every || [],
+    ...frameworkRecord.detectors?.some || []
+  ];
+  const firstMatchPackage = allDetectors.find((d) => d.matchPackage);
+  if (!firstMatchPackage?.matchPackage) {
+    return;
+  }
+  return lookupInstalledVersion(
+    process.execPath,
+    firstMatchPackage.matchPackage
+  );
 }
-exports.detectFrameworkVersion = detectFrameworkVersion;
 function lookupInstalledVersion(cwd, packageName) {
-    try {
-        const script = `require('${packageName}/package.json').version`;
-        return (0, child_process_1.spawnSync)(cwd, ['-p', script], {
-            encoding: 'utf-8',
-        }).stdout.trim();
-    }
-    catch (error) {
-        console.debug(`Error looking up version of installed package "${packageName}": ${error}`);
-    }
-    return;
+  try {
+    const script = `require('${packageName}/package.json').version`;
+    return (0, import_child_process.spawnSync)(cwd, ["-p", script], {
+      encoding: "utf-8"
+    }).stdout.trim();
+  } catch (error) {
+    console.debug(
+      `Error looking up version of installed package "${packageName}": ${error}`
+    );
+  }
+  return;
 }
-//# sourceMappingURL=detect-framework.js.map
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  detectFramework,
+  detectFrameworkRecord,
+  detectFrameworkVersion,
+  detectFrameworks,
+  removeSupersededFrameworks
+});
+//# sourceMappingURL=detect-framework.js.map

package/dist/detect-framework.js.map

@@ -1 +1,7 @@
-{"version":3,"file":"detect-framework.js","sourceRoot":"","sources":["../src/detect-framework.ts"],"names":[],"mappings":";;;AACA,iDAA0C;AAuB1C,KAAK,UAAU,OAAO,CACpB,EAAsB,EACtB,SAAwB;IAExB,MAAM,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAEhC,IAAI,CAAC,SAAS,EAAE;QACd,OAAO;KACR;IAED,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,SAAS,CAAC;IAElC,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;QAChD,OAAO;KACR;IAED,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;QAC9C,OAAO;KACR;IAED,MAAM,KAAK,GAAG,KAAK,EAAE,EACnB,IAAI,EACJ,YAAY,EACZ,YAAY,GACW,EAAoC,EAAE;QAC7D,IAAI,YAAY,IAAI,YAAY,EAAE;YAChC,MAAM,IAAI,KAAK,CACb,8EAA8E,SAAS,CAAC,IAAI,GAAG,CAChG,CAAC;SACH;QACD,IAAI,YAAY,IAAI,IAAI,EAAE;YACxB,MAAM,IAAI,KAAK,CACb,sEAAsE,SAAS,CAAC,IAAI,mDAAmD,CACxI,CAAC;SACH;QAED,IAAI,CAAC,IAAI,IAAI,CAAC,YAAY,EAAE;YAC1B,MAAM,IAAI,KAAK,CACb,iEAAiE,SAAS,CAAC,IAAI,IAAI,CACpF,CAAC;SACH;QAED,IAAI,CAAC,IAAI,EAAE;YACT,IAAI,GAAG,cAAc,CAAC;SACvB;QAED,IAAI,YAAY,EAAE;YAChB,YAAY,GAAG,uCAAuC,YAAY,qBAAqB,CAAC;SACzF;QAED,IAAI,CAAC,MAAM,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE;YACtC,OAAO;SACR;QAED,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,KAAK,EAAE;gBACrC,OAAO;aACR;YAED,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC;YAC5C,MAAM,OAAO,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;YAExC,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK,EAAE;gBACV,OAAO;aACR;YACD,IAAI,YAAY,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE;gBAC5B,OAAO;oBACL,SAAS;oBACT,eAAe,EAAE,KAAK,CAAC,CAAC,CAAC;iBAC1B,CAAC;aACH;SACF;QAED,OAAO;YACL,SAAS;SACV,CAAC;IACJ,CAAC,CAAC;IAEF,MAAM,MAAM,GAAgC,EAAE,CAAC;IAE/C,IAAI,KAAK,EAAE;QACT,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACtE,MAAM,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,CAAC;KAC7B;IAED,IAAI,IAAI,EAAE;QACR,IAAI,UAAmC,CAAC;QAExC,KAAK,MAAM,IAAI,IAAI,IAAI,EAAE;YACvB,MAAM,UAAU,GAAG,MAAM,KAAK,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,UAAU,EAAE;gBACd,UAAU,GAAG,UAAU,CAAC;gBACxB,MAAM;aACP;SACF;QAED,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;KACzB;IAED,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE;QAC/B,OAAO;KACR;IAED,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CACjC,CAAC,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,eAAe,CAChD,EAAE,eAAe,CAAC;IACnB,OAAO;QACL,SAAS;QACT,eAAe;KAChB,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,OAA0D,EAC1D,IAAY;IAEZ,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,KAAK,IAAI,CAAC,CAAC;IACvD,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACjC,IAAI,SAAS,EAAE;QACb,IAAI,SAAS,CAAC,UAAU,EAAE;YACxB,yBAAyB,CAAC,OAAO,EAAE,SAAS,CAAC,UAAU,CAAC,CAAC;SAC1D;QACD,OAAO,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;KAC1B;AACH,CAAC;AAED,SAAgB,0BAA0B,CACxC,OAA0D;IAE1D,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,KAAK,EAAE,EAAE;QACnC,IAAI,KAAK,EAAE,UAAU,EAAE;YACrB,yBAAyB,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;SACtD;KACF;AACH,CAAC;AARD,gEAQC;AAED,2DAA2D;AACpD,KAAK,UAAU,eAAe,CAAC,EACpC,EAAE,EACF,aAAa,GACU;IACvB,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,aAAa,CAAC,GAAG,CAAC,KAAK,EAAC,cAAc,EAAC,EAAE;QACvC,IAAI,MAAM,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE;YACrC,OAAO,cAAc,CAAC;SACvB;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CACH,CAAC;IACF,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,IAAI,CAAC;AACxD,CAAC;AAdD,0CAcC;AAED;;GAEG;AACI,KAAK,UAAU,gBAAgB,CAAC,EACrC,EAAE,EACF,aAAa,GACgB;IAC7B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,aAAa,CAAC,GAAG,CAAC,KAAK,EAAC,cAAc,EAAC,EAAE;QACvC,IAAI,MAAM,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,EAAE;YACrC,OAAO,cAAc,CAAC;SACvB;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CACH,CAAC;IACF,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,CAAgB,CAAC;AAC3D,CAAC;AAdD,4CAcC;AAUD,0EAA0E;AACnE,KAAK,UAAU,qBAAqB,CAAC,EAC1C,EAAE,EACF,aAAa,GACgB;IAC7B,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,GAAG,CAC9B,aAAa,CAAC,GAAG,CAAC,KAAK,EAAC,cAAc,EAAC,EAAE;QACvC,MAAM,WAAW,GAAG,MAAM,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,CAAC;QACtD,IAAI,WAAW,EAAE;YACf,OAAO;gBACL,GAAG,cAAc;gBACjB,eAAe,EAAE,WAAW,EAAE,eAAe;aAC9C,CAAC;SACH;QACD,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CACH,CAAC;IACF,0BAA0B,CAAC,MAAM,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC;AAClD,CAAC;AAlBD,sDAkBC;AAED,SAAgB,sBAAsB,CACpC,eAA0B;IAE1B,MAAM,YAAY,GAAG;QACnB,GAAG,CAAC,eAAe,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE,CAAC;QAC3C,GAAG,CAAC,eAAe,CAAC,SAAS,EAAE,IAAI,IAAI,EAAE,CAAC;KAC3C,CAAC;IACF,MAAM,iBAAiB,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC;IAEjE,IAAI,CAAC,iBAAiB,EAAE,YAAY,EAAE;QACpC,OAAO;KACR;IAED,OAAO,sBAAsB,CAC3B,OAAO,CAAC,QAAQ,EAChB,iBAAiB,CAAC,YAAY,CAC/B,CAAC;AACJ,CAAC;AAjBD,wDAiBC;AAED,SAAS,sBAAsB,CAC7B,GAAW,EACX,WAAmB;IAEnB,IAAI;QACF,MAAM,MAAM,GAAG,YAAY,WAAW,yBAAyB,CAAC;QAChE,OAAO,IAAA,yBAAS,EAAC,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;YACpC,QAAQ,EAAE,OAAO;SAClB,CAAC,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;KAClB;IAAC,OAAO,KAAK,EAAE;QACd,OAAO,CAAC,KAAK,CACX,kDAAkD,WAAW,MAAM,KAAK,EAAE,CAC3E,CAAC;KACH;IAED,OAAO;AACT,CAAC"}
+{
+  "version": 3,
+  "sources": ["../src/detect-framework.ts"],
+  "sourcesContent": ["import type { Framework, FrameworkDetectionItem } from '@vercel/frameworks';\nimport { spawnSync } from 'child_process';\nimport { DetectorFilesystem } from './detectors/filesystem';\n\ninterface BaseFramework {\n  slug: Framework['slug'];\n  detectors?: Framework['detectors'];\n}\n\nexport interface DetectFrameworkOptions {\n  fs: DetectorFilesystem;\n  frameworkList: readonly BaseFramework[];\n}\n\nexport interface DetectFrameworkRecordOptions {\n  fs: DetectorFilesystem;\n  frameworkList: readonly Framework[];\n}\n\ntype MatchResult = {\n  framework: BaseFramework;\n  detectedVersion?: string;\n};\n\nasync function matches(\n  fs: DetectorFilesystem,\n  framework: BaseFramework\n): Promise<MatchResult | undefined> {\n  const { detectors } = framework;\n\n  if (!detectors) {\n    return;\n  }\n\n  const { every, some } = detectors;\n\n  if (every !== undefined && !Array.isArray(every)) {\n    return;\n  }\n\n  if (some !== undefined && !Array.isArray(some)) {\n    return;\n  }\n\n  const check = async ({\n    path,\n    matchContent,\n    matchPackage,\n  }: FrameworkDetectionItem): Promise<MatchResult | undefined> => {\n    if (matchPackage && matchContent) {\n      throw new Error(\n        `Cannot specify \"matchPackage\" and \"matchContent\" in the same detector for \"${framework.slug}\"`\n      );\n    }\n    if (matchPackage && path) {\n      throw new Error(\n        `Cannot specify \"matchPackage\" and \"path\" in the same detector for \"${framework.slug}\" because \"path\" is assumed to be \"package.json\".`\n      );\n    }\n\n    if (!path && !matchPackage) {\n      throw new Error(\n        `Must specify either \"path\" or \"matchPackage\" in detector for \"${framework.slug}\".`\n      );\n    }\n\n    if (!path) {\n      path = 'package.json';\n    }\n\n    if (matchPackage) {\n      matchContent = `\"(dev)?(d|D)ependencies\":\\\\s*{[^}]*\"${matchPackage}\":\\\\s*\"(.+?)\"[^}]*}`;\n    }\n\n    if ((await fs.hasPath(path)) === false) {\n      return;\n    }\n\n    if (matchContent) {\n      if ((await fs.isFile(path)) === false) {\n        return;\n      }\n\n      const regex = new RegExp(matchContent, 'm');\n      const content = await fs.readFile(path);\n\n      const match = content.toString().match(regex);\n      if (!match) {\n        return;\n      }\n      if (matchPackage && match[3]) {\n        return {\n          framework,\n          detectedVersion: match[3],\n        };\n      }\n    }\n\n    return {\n      framework,\n    };\n  };\n\n  const result: (MatchResult | undefined)[] = [];\n\n  if (every) {\n    const everyResult = await Promise.all(every.map(item => check(item)));\n    result.push(...everyResult);\n  }\n\n  if (some) {\n    let someResult: MatchResult | undefined;\n\n    for (const item of some) {\n      const itemResult = await check(item);\n      if (itemResult) {\n        someResult = itemResult;\n        break;\n      }\n    }\n\n    result.push(someResult);\n  }\n\n  if (!result.every(res => !!res)) {\n    return;\n  }\n\n  const detectedVersion = result.find(\n    r => typeof r === 'object' && r.detectedVersion\n  )?.detectedVersion;\n  return {\n    framework,\n    detectedVersion,\n  };\n}\n\nfunction removeSupersededFramework(\n  matches: (Pick<Framework, 'supersedes' | 'slug'> | null)[],\n  slug: string\n) {\n  const index = matches.findIndex(f => f?.slug === slug);\n  const framework = matches[index];\n  if (framework) {\n    if (framework.supersedes) {\n      removeSupersededFramework(matches, framework.supersedes);\n    }\n    matches.splice(index, 1);\n  }\n}\n\nexport function removeSupersededFrameworks(\n  matches: (Pick<Framework, 'supersedes' | 'slug'> | null)[]\n) {\n  for (const match of matches.slice()) {\n    if (match?.supersedes) {\n      removeSupersededFramework(matches, match.supersedes);\n    }\n  }\n}\n\n// TODO: Deprecate and replace with `detectFrameworkRecord`\nexport async function detectFramework({\n  fs,\n  frameworkList,\n}: DetectFrameworkOptions): Promise<string | null> {\n  const result = await Promise.all(\n    frameworkList.map(async frameworkMatch => {\n      if (await matches(fs, frameworkMatch)) {\n        return frameworkMatch;\n      }\n      return null;\n    })\n  );\n  removeSupersededFrameworks(result);\n  return result.find(res => res !== null)?.slug ?? null;\n}\n\n/**\n * Detects all matching Frameworks based on the given virtual filesystem.\n */\nexport async function detectFrameworks({\n  fs,\n  frameworkList,\n}: DetectFrameworkRecordOptions): Promise<Framework[]> {\n  const result = await Promise.all(\n    frameworkList.map(async frameworkMatch => {\n      if (await matches(fs, frameworkMatch)) {\n        return frameworkMatch;\n      }\n      return null;\n    })\n  );\n  removeSupersededFrameworks(result);\n  return result.filter(res => res !== null) as Framework[];\n}\n\n/**\n * Framework with a `detectedVersion` specifying the version\n * or version range of the relevant package\n */\ntype VersionedFramework = Framework & {\n  detectedVersion?: string;\n};\n\n// Note: Does not currently support a `frameworkList` of monorepo managers\nexport async function detectFrameworkRecord({\n  fs,\n  frameworkList,\n}: DetectFrameworkRecordOptions): Promise<VersionedFramework | null> {\n  const result = await Promise.all(\n    frameworkList.map(async frameworkMatch => {\n      const matchResult = await matches(fs, frameworkMatch);\n      if (matchResult) {\n        return {\n          ...frameworkMatch,\n          detectedVersion: matchResult?.detectedVersion,\n        };\n      }\n      return null;\n    })\n  );\n  removeSupersededFrameworks(result);\n  return result.find(res => res !== null) ?? null;\n}\n\nexport function detectFrameworkVersion(\n  frameworkRecord: Framework\n): string | undefined {\n  const allDetectors = [\n    ...(frameworkRecord.detectors?.every || []),\n    ...(frameworkRecord.detectors?.some || []),\n  ];\n  const firstMatchPackage = allDetectors.find(d => d.matchPackage);\n\n  if (!firstMatchPackage?.matchPackage) {\n    return;\n  }\n\n  return lookupInstalledVersion(\n    process.execPath,\n    firstMatchPackage.matchPackage\n  );\n}\n\nfunction lookupInstalledVersion(\n  cwd: string,\n  packageName: string\n): string | undefined {\n  try {\n    const script = `require('${packageName}/package.json').version`;\n    return spawnSync(cwd, ['-p', script], {\n      encoding: 'utf-8',\n    }).stdout.trim();\n  } catch (error) {\n    console.debug(\n      `Error looking up version of installed package \"${packageName}\": ${error}`\n    );\n  }\n\n  return;\n}\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,2BAA0B;AAuB1B,eAAe,QACb,IACA,WACkC;AAClC,QAAM,EAAE,UAAU,IAAI;AAEtB,MAAI,CAAC,WAAW;AACd;AAAA,EACF;AAEA,QAAM,EAAE,OAAO,KAAK,IAAI;AAExB,MAAI,UAAU,UAAa,CAAC,MAAM,QAAQ,KAAK,GAAG;AAChD;AAAA,EACF;AAEA,MAAI,SAAS,UAAa,CAAC,MAAM,QAAQ,IAAI,GAAG;AAC9C;AAAA,EACF;AAEA,QAAM,QAAQ,OAAO;AAAA,IACnB;AAAA,IACA;AAAA,IACA;AAAA,EACF,MAAgE;AAC9D,QAAI,gBAAgB,cAAc;AAChC,YAAM,IAAI;AAAA,QACR,8EAA8E,UAAU,IAAI;AAAA,MAC9F;AAAA,IACF;AACA,QAAI,gBAAgB,MAAM;AACxB,YAAM,IAAI;AAAA,QACR,sEAAsE,UAAU,IAAI;AAAA,MACtF;AAAA,IACF;AAEA,QAAI,CAAC,QAAQ,CAAC,cAAc;AAC1B,YAAM,IAAI;AAAA,QACR,iEAAiE,UAAU,IAAI;AAAA,MACjF;AAAA,IACF;AAEA,QAAI,CAAC,MAAM;AACT,aAAO;AAAA,IACT;AAEA,QAAI,cAAc;AAChB,qBAAe,uCAAuC,YAAY;AAAA,IACpE;AAEA,QAAK,MAAM,GAAG,QAAQ,IAAI,MAAO,OAAO;AACtC;AAAA,IACF;AAEA,QAAI,cAAc;AAChB,UAAK,MAAM,GAAG,OAAO,IAAI,MAAO,OAAO;AACrC;AAAA,MACF;AAEA,YAAM,QAAQ,IAAI,OAAO,cAAc,GAAG;AAC1C,YAAM,UAAU,MAAM,GAAG,SAAS,IAAI;AAEtC,YAAM,QAAQ,QAAQ,SAAS,EAAE,MAAM,KAAK;AAC5C,UAAI,CAAC,OAAO;AACV;AAAA,MACF;AACA,UAAI,gBAAgB,MAAM,CAAC,GAAG;AAC5B,eAAO;AAAA,UACL;AAAA,UACA,iBAAiB,MAAM,CAAC;AAAA,QAC1B;AAAA,MACF;AAAA,IACF;AAEA,WAAO;AAAA,MACL;AAAA,IACF;AAAA,EACF;AAEA,QAAM,SAAsC,CAAC;AAE7C,MAAI,OAAO;AACT,UAAM,cAAc,MAAM,QAAQ,IAAI,MAAM,IAAI,UAAQ,MAAM,IAAI,CAAC,CAAC;AACpE,WAAO,KAAK,GAAG,WAAW;AAAA,EAC5B;AAEA,MAAI,MAAM;AACR,QAAI;AAEJ,eAAW,QAAQ,MAAM;AACvB,YAAM,aAAa,MAAM,MAAM,IAAI;AACnC,UAAI,YAAY;AACd,qBAAa;AACb;AAAA,MACF;AAAA,IACF;AAEA,WAAO,KAAK,UAAU;AAAA,EACxB;AAEA,MAAI,CAAC,OAAO,MAAM,SAAO,CAAC,CAAC,GAAG,GAAG;AAC/B;AAAA,EACF;AAEA,QAAM,kBAAkB,OAAO;AAAA,IAC7B,OAAK,OAAO,MAAM,YAAY,EAAE;AAAA,EAClC,GAAG;AACH,SAAO;AAAA,IACL;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,0BACPA,UACA,MACA;AACA,QAAM,QAAQA,SAAQ,UAAU,OAAK,GAAG,SAAS,IAAI;AACrD,QAAM,YAAYA,SAAQ,KAAK;AAC/B,MAAI,WAAW;AACb,QAAI,UAAU,YAAY;AACxB,gCAA0BA,UAAS,UAAU,UAAU;AAAA,IACzD;AACA,IAAAA,SAAQ,OAAO,OAAO,CAAC;AAAA,EACzB;AACF;AAEO,SAAS,2BACdA,UACA;AACA,aAAW,SAASA,SAAQ,MAAM,GAAG;AACnC,QAAI,OAAO,YAAY;AACrB,gCAA0BA,UAAS,MAAM,UAAU;AAAA,IACrD;AAAA,EACF;AACF;AAGA,eAAsB,gBAAgB;AAAA,EACpC;AAAA,EACA;AACF,GAAmD;AACjD,QAAM,SAAS,MAAM,QAAQ;AAAA,IAC3B,cAAc,IAAI,OAAM,mBAAkB;AACxC,UAAI,MAAM,QAAQ,IAAI,cAAc,GAAG;AACrC,eAAO;AAAA,MACT;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACA,6BAA2B,MAAM;AACjC,SAAO,OAAO,KAAK,SAAO,QAAQ,IAAI,GAAG,QAAQ;AACnD;AAKA,eAAsB,iBAAiB;AAAA,EACrC;AAAA,EACA;AACF,GAAuD;AACrD,QAAM,SAAS,MAAM,QAAQ;AAAA,IAC3B,cAAc,IAAI,OAAM,mBAAkB;AACxC,UAAI,MAAM,QAAQ,IAAI,cAAc,GAAG;AACrC,eAAO;AAAA,MACT;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACA,6BAA2B,MAAM;AACjC,SAAO,OAAO,OAAO,SAAO,QAAQ,IAAI;AAC1C;AAWA,eAAsB,sBAAsB;AAAA,EAC1C;AAAA,EACA;AACF,GAAqE;AACnE,QAAM,SAAS,MAAM,QAAQ;AAAA,IAC3B,cAAc,IAAI,OAAM,mBAAkB;AACxC,YAAM,cAAc,MAAM,QAAQ,IAAI,cAAc;AACpD,UAAI,aAAa;AACf,eAAO;AAAA,UACL,GAAG;AAAA,UACH,iBAAiB,aAAa;AAAA,QAChC;AAAA,MACF;AACA,aAAO;AAAA,IACT,CAAC;AAAA,EACH;AACA,6BAA2B,MAAM;AACjC,SAAO,OAAO,KAAK,SAAO,QAAQ,IAAI,KAAK;AAC7C;AAEO,SAAS,uBACd,iBACoB;AACpB,QAAM,eAAe;AAAA,IACnB,GAAI,gBAAgB,WAAW,SAAS,CAAC;AAAA,IACzC,GAAI,gBAAgB,WAAW,QAAQ,CAAC;AAAA,EAC1C;AACA,QAAM,oBAAoB,aAAa,KAAK,OAAK,EAAE,YAAY;AAE/D,MAAI,CAAC,mBAAmB,cAAc;AACpC;AAAA,EACF;AAEA,SAAO;AAAA,IACL,QAAQ;AAAA,IACR,kBAAkB;AAAA,EACpB;AACF;AAEA,SAAS,uBACP,KACA,aACoB;AACpB,MAAI;AACF,UAAM,SAAS,YAAY,WAAW;AACtC,eAAO,gCAAU,KAAK,CAAC,MAAM,MAAM,GAAG;AAAA,MACpC,UAAU;AAAA,IACZ,CAAC,EAAE,OAAO,KAAK;AAAA,EACjB,SAAS,OAAO;AACd,YAAQ;AAAA,MACN,kDAAkD,WAAW,MAAM,KAAK;AAAA,IAC1E;AAAA,EACF;AAEA;AACF;",
+  "names": ["matches"]
+}

package/dist/detectors/filesystem.js

@@ -1,112 +1,109 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DetectorFilesystem = void 0;
-const path_1 = require("path");
-/**
- * `DetectorFilesystem` is an abstract class that represents a virtual filesystem
- * to perform read-only operations on in order to detect which framework is being
- * used.
- *
- * Its abstract methods must be implemented by a subclass that perform the actual
- * FS operations. Example subclasses could be implemented as:
- *
- *  - Local filesystem, which proxies the FS operations to the equivalent `fs`
- *    module functions.
- *  - HTTP filesystem, which implements the FS operations over an HTTP server
- *    and does not require a local copy of the files.
- *  - `Files` filesystem, which operates on a virtual `Files` object (i.e. from
- *    the `glob()` function) which could include `FileFsRef`, `FileBlob`, etc.
- *
- * This base class implements various helper functions for common tasks (i.e.
- * read and parse a JSON file). It also includes caching for all FS operations
- * so that multiple detector functions de-dup read operations on the same file
- * to reduce network/filesystem overhead.
- *
- * **NOTE:** It's important that all instance methods in this base class are
- * bound to `this` so that the `fs` object may be destructured in the detector
- * functions. The easiest way to do this is to use the `=` syntax when defining
- * methods in this class definition.
- */
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var filesystem_exports = {};
+__export(filesystem_exports, {
+  DetectorFilesystem: () => DetectorFilesystem
+});
+module.exports = __toCommonJS(filesystem_exports);
+var import_path = require("path");
 class DetectorFilesystem {
-    constructor() {
-        this.hasPath = async (path) => {
-            let p = this.pathCache.get(path);
-            if (!p) {
-                p = this._hasPath(path);
-                this.pathCache.set(path, p);
-            }
-            return p;
-        };
-        this.isFile = async (name) => {
-            let p = this.fileCache.get(name);
-            if (!p) {
-                p = this._isFile(name);
-                this.fileCache.set(name, p);
-            }
-            return p;
-        };
-        this.readFile = async (name) => {
-            let p = this.readFileCache.get(name);
-            if (!p) {
-                p = this._readFile(name);
-                this.readFileCache.set(name, p);
-            }
-            return p;
-        };
-        /**
-         * Returns a list of Stat objects from the current working directory.
-         * @param dirPath The path of the directory to read.
-         * @param options.potentialFiles optional. Array of potential file names (relative to the path).  If provided, these will be used to mark the filesystem caches as existing or not existing.
-         */
-        this.readdir = async (dirPath, options) => {
-            let p = this.readdirCache.get(dirPath);
-            if (!p) {
-                p = this._readdir(dirPath);
-                this.readdirCache.set(dirPath, p);
-            }
-            const directoryContent = await p;
-            const directoryFiles = new Set();
-            for (const file of directoryContent) {
-                if (file.type === 'file') {
-                    // we know this file exists, mark it as so on the filesystem
-                    this.fileCache.set(file.path, Promise.resolve(true));
-                    this.pathCache.set(file.path, Promise.resolve(true));
-                    directoryFiles.add(file.name);
-                }
-            }
-            if (options?.potentialFiles) {
-                // calculate the set of paths that truly do not exist
-                const filesThatDoNotExist = options.potentialFiles.filter(path => !directoryFiles.has(path));
-                for (const filePath of filesThatDoNotExist) {
-                    const fullFilePath = dirPath === '/' ? filePath : path_1.posix.join(dirPath, filePath);
-                    // we know this file does not exist, mark it as so on the filesystem
-                    this.fileCache.set(fullFilePath, Promise.resolve(false));
-                    this.pathCache.set(fullFilePath, Promise.resolve(false));
-                }
-            }
-            return p;
-        };
-        /**
-         * Changes the current directory to the specified path and returns a new instance of DetectorFilesystem.
-         */
-        this.chdir = (name) => {
-            return this._chdir(name);
-        };
-        /**
-         * Writes a file to the filesystem cache.
-         * @param name the name of the file to write
-         * @param content The content of the file
-         */
-        this.writeFile = async (name, content) => {
-            this.readFileCache.set(name, Promise.resolve(Buffer.from(content)));
-            this.fileCache.set(name, Promise.resolve(true));
-            this.pathCache.set(name, Promise.resolve(true));
-        };
-        this.pathCache = new Map();
-        this.fileCache = new Map();
-        this.readFileCache = new Map();
-        this.readdirCache = new Map();
-    }
+  constructor() {
+    this.hasPath = async (path) => {
+      let p = this.pathCache.get(path);
+      if (!p) {
+        p = this._hasPath(path);
+        this.pathCache.set(path, p);
+      }
+      return p;
+    };
+    this.isFile = async (name) => {
+      let p = this.fileCache.get(name);
+      if (!p) {
+        p = this._isFile(name);
+        this.fileCache.set(name, p);
+      }
+      return p;
+    };
+    this.readFile = async (name) => {
+      let p = this.readFileCache.get(name);
+      if (!p) {
+        p = this._readFile(name);
+        this.readFileCache.set(name, p);
+      }
+      return p;
+    };
+    /**
+     * Returns a list of Stat objects from the current working directory.
+     * @param dirPath The path of the directory to read.
+     * @param options.potentialFiles optional. Array of potential file names (relative to the path).  If provided, these will be used to mark the filesystem caches as existing or not existing.
+     */
+    this.readdir = async (dirPath, options) => {
+      let p = this.readdirCache.get(dirPath);
+      if (!p) {
+        p = this._readdir(dirPath);
+        this.readdirCache.set(dirPath, p);
+      }
+      const directoryContent = await p;
+      const directoryFiles = /* @__PURE__ */ new Set();
+      for (const file of directoryContent) {
+        if (file.type === "file") {
+          this.fileCache.set(file.path, Promise.resolve(true));
+          this.pathCache.set(file.path, Promise.resolve(true));
+          directoryFiles.add(file.name);
+        }
+      }
+      if (options?.potentialFiles) {
+        const filesThatDoNotExist = options.potentialFiles.filter(
+          (path) => !directoryFiles.has(path)
+        );
+        for (const filePath of filesThatDoNotExist) {
+          const fullFilePath = dirPath === "/" ? filePath : import_path.posix.join(dirPath, filePath);
+          this.fileCache.set(fullFilePath, Promise.resolve(false));
+          this.pathCache.set(fullFilePath, Promise.resolve(false));
+        }
+      }
+      return p;
+    };
+    /**
+     * Changes the current directory to the specified path and returns a new instance of DetectorFilesystem.
+     */
+    this.chdir = (name) => {
+      return this._chdir(name);
+    };
+    /**
+     * Writes a file to the filesystem cache.
+     * @param name the name of the file to write
+     * @param content The content of the file
+     */
+    this.writeFile = async (name, content) => {
+      this.readFileCache.set(name, Promise.resolve(Buffer.from(content)));
+      this.fileCache.set(name, Promise.resolve(true));
+      this.pathCache.set(name, Promise.resolve(true));
+    };
+    this.pathCache = /* @__PURE__ */ new Map();
+    this.fileCache = /* @__PURE__ */ new Map();
+    this.readFileCache = /* @__PURE__ */ new Map();
+    this.readdirCache = /* @__PURE__ */ new Map();
+  }
 }
-exports.DetectorFilesystem = DetectorFilesystem;
-//# sourceMappingURL=filesystem.js.map
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DetectorFilesystem
+});
+//# sourceMappingURL=filesystem.js.map