@vercel/fs-detectors 5.7.13 → 5.7.14

package/dist/detect-framework.d.ts

@@ -7,17 +7,29 @@ interface BaseFramework {
 export interface DetectFrameworkOptions {
     fs: DetectorFilesystem;
     frameworkList: readonly BaseFramework[];
+    /**
+     * When true, includes experimental frameworks in detection.
+     * If undefined, falls back to VERCEL_USE_EXPERIMENTAL_FRAMEWORKS env var.
+     * Defaults to false if neither is set.
+     */
+    useExperimentalFrameworks?: boolean;
 }
 export interface DetectFrameworkRecordOptions {
     fs: DetectorFilesystem;
     frameworkList: readonly Framework[];
+    /**
+     * When true, includes experimental frameworks in detection.
+     * If undefined, falls back to VERCEL_USE_EXPERIMENTAL_FRAMEWORKS env var.
+     * Defaults to false if neither is set.
+     */
+    useExperimentalFrameworks?: boolean;
 }
 export declare function removeSupersededFrameworks(matches: (Pick<Framework, 'supersedes' | 'slug'> | null)[]): void;
-export declare function detectFramework({ fs, frameworkList, }: DetectFrameworkOptions): Promise<string | null>;
+export declare function detectFramework({ fs, frameworkList, useExperimentalFrameworks, }: DetectFrameworkOptions): Promise<string | null>;
 /**
  * Detects all matching Frameworks based on the given virtual filesystem.
  */
-export declare function detectFrameworks({ fs, frameworkList, }: DetectFrameworkRecordOptions): Promise<Framework[]>;
+export declare function detectFrameworks({ fs, frameworkList, useExperimentalFrameworks, }: DetectFrameworkRecordOptions): Promise<Framework[]>;
 /**
  * Framework with a `detectedVersion` specifying the version
  * or version range of the relevant package
@@ -25,6 +37,6 @@ export declare function detectFrameworks({ fs, frameworkList, }: DetectFramework
 type VersionedFramework = Framework & {
     detectedVersion?: string;
 };
-export declare function detectFrameworkRecord({ fs, frameworkList, }: DetectFrameworkRecordOptions): Promise<VersionedFramework | null>;
+export declare function detectFrameworkRecord({ fs, frameworkList, useExperimentalFrameworks, }: DetectFrameworkRecordOptions): Promise<VersionedFramework | null>;
 export declare function detectFrameworkVersion(frameworkRecord: Framework): string | undefined;
 export {};

package/dist/detect-framework.js

@@ -26,6 +26,23 @@ __export(detect_framework_exports, {
 });
 module.exports = __toCommonJS(detect_framework_exports);
 var import_child_process = require("child_process");
+function shouldIncludeExperimentalFrameworks(useExperimentalFrameworks) {
+  if (typeof useExperimentalFrameworks === "boolean") {
+    return useExperimentalFrameworks;
+  }
+  const experimentalEnv = process.env.VERCEL_USE_EXPERIMENTAL_FRAMEWORKS;
+  const isEnabled = (val) => val === "1" || typeof val === "string" && val.toLowerCase() === "true";
+  return isEnabled(experimentalEnv);
+}
+function filterFrameworkList(frameworkList, useExperimentalFrameworks) {
+  if (shouldIncludeExperimentalFrameworks(useExperimentalFrameworks)) {
+    return frameworkList;
+  }
+  return frameworkList.filter((f) => {
+    const experimental = f.experimental;
+    return !experimental;
+  });
+}
 async function matches(fs, framework) {
   const { detectors } = framework;
   if (!detectors) {
@@ -138,10 +155,15 @@ function removeSupersededFrameworks(matches2) {
 }
 async function detectFramework({
   fs,
-  frameworkList
+  frameworkList,
+  useExperimentalFrameworks
 }) {
+  const filteredList = filterFrameworkList(
+    frameworkList,
+    useExperimentalFrameworks
+  );
   const result = await Promise.all(
-    frameworkList.map(async (frameworkMatch) => {
+    filteredList.map(async (frameworkMatch) => {
       if (await matches(fs, frameworkMatch)) {
         return frameworkMatch;
       }
@@ -153,10 +175,15 @@ async function detectFramework({
 }
 async function detectFrameworks({
   fs,
-  frameworkList
+  frameworkList,
+  useExperimentalFrameworks
 }) {
+  const filteredList = filterFrameworkList(
+    frameworkList,
+    useExperimentalFrameworks
+  );
   const result = await Promise.all(
-    frameworkList.map(async (frameworkMatch) => {
+    filteredList.map(async (frameworkMatch) => {
       if (await matches(fs, frameworkMatch)) {
         return frameworkMatch;
       }
@@ -168,10 +195,15 @@ async function detectFrameworks({
 }
 async function detectFrameworkRecord({
   fs,
-  frameworkList
+  frameworkList,
+  useExperimentalFrameworks
 }) {
+  const filteredList = filterFrameworkList(
+    frameworkList,
+    useExperimentalFrameworks
+  );
   const result = await Promise.all(
-    frameworkList.map(async (frameworkMatch) => {
+    filteredList.map(async (frameworkMatch) => {
       const matchResult = await matches(fs, frameworkMatch);
       if (matchResult) {
         return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/fs-detectors",
-  "version": "5.7.13",
+  "version": "5.7.14",
   "description": "Vercel filesystem detectors",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,8 +20,8 @@
     "minimatch": "3.1.2",
     "semver": "6.3.1",
     "@vercel/error-utils": "2.0.3",
-    "@vercel/frameworks": "3.15.5",
-    "@vercel/routing-utils": "5.3.2"
+    "@vercel/routing-utils": "5.3.2",
+    "@vercel/frameworks": "3.15.6"
   },
   "devDependencies": {
     "@types/glob": "7.2.0",
@@ -32,7 +32,7 @@
     "@types/semver": "7.3.10",
     "jest-junit": "16.0.0",
     "typescript": "4.9.5",
-    "@vercel/build-utils": "13.2.7"
+    "@vercel/build-utils": "13.2.10"
   },
   "scripts": {
     "build": "node ../../utils/build.mjs",