configenvy 0.1.6 → 0.2.0

package/dist/index.js

@@ -32,8 +32,8 @@ function createProgram(dependencies = defaultDependencies) {
   program.command("doctor").argument("[path]", "project directory", ".").option("--format <format>", "output format: text, json, or sarif", "text").option("--strict", "treat documentation warnings as errors").action(async (projectPath, options) => {
     await runDoctor(projectPath, options, dependencies);
   });
-  program.command("check").argument("[path]", "project directory", ".").option("--ci", "fail on warnings and errors").option("--format <format>", "output format: text, json, or sarif", "text").action(async (projectPath, options) => {
-    await runDoctor(projectPath, { ...options, strict: Boolean(options.ci), ci: Boolean(options.ci) }, dependencies);
+  program.command("check").argument("[path]", "project directory", ".").option("--ci", "fail on warnings and errors").option("--format <format>", "output format: text, json, or sarif", "text").option("--strict", "treat documentation warnings as errors").action(async (projectPath, options) => {
+    await runDoctor(projectPath, { ...options, strict: Boolean(options.strict || options.ci), ci: Boolean(options.ci) }, dependencies);
   });
   program.command("table").argument("[path]", "project directory", ".").option("--out <file>", "write markdown table to a file").option("--update <file>", "replace a marked configenvy table block in a markdown file").option("--force", "append a configenvy table block when --update target has no marked block").option("--dry-run", "print the updated markdown instead of writing it").action(async (projectPath, options) => {
     const rootDir = dependencies.resolvePath(projectPath);
@@ -64,6 +64,10 @@ var starterConfig = {
   docs: ["README.md", "docs"]
 };
 var presetConfigs = {
+  astro: {
+    optional: ["PUBLIC_SITE_URL"],
+    ignore: ["BASE_URL", "DEV", "MODE", "PROD", "SSR"]
+  },
   docker: {
     optional: ["COMPOSE_PROJECT_NAME"],
     ignore: ["HOSTNAME"]
@@ -72,6 +76,12 @@ var presetConfigs = {
     optional: ["NEXT_PUBLIC_APP_URL"],
     ignore: ["NEXT_RUNTIME"]
   },
+  nuxt: {
+    optional: ["NUXT_PUBLIC_API_BASE"]
+  },
+  sveltekit: {
+    optional: ["PUBLIC_BASE_URL"]
+  },
   vercel: {
     ignore: ["VERCEL", "VERCEL_ENV", "VERCEL_URL", "VERCEL_BRANCH_URL", "VERCEL_PROJECT_PRODUCTION_URL", "VERCEL_REGION"]
   },
@@ -81,7 +91,7 @@ var presetConfigs = {
   }
 };
 var availablePresetNames = Object.keys(presetConfigs).sort();
-var availablePresetList = availablePresetNames.join(", ");
+var availablePresetList = ["auto", ...availablePresetNames].join(", ");
 var require2 = createRequire(import.meta.url);
 var cliPackage = require2("../package.json");
 var cliVersion = cliPackage.version;
@@ -114,10 +124,11 @@ async function runDoctor(projectPath, options, dependencies = defaultDependencie
 async function runInit(projectPath, options = {}, dependencies = defaultDependencies) {
   const rootDir = dependencies.resolvePath(projectPath);
   const result = await dependencies.scanProject({ rootDir });
-  const preset = resolvePreset(options.preset, dependencies);
-  if (options.preset && !preset) return;
+  const preset = await resolvePreset(rootDir, options.preset, dependencies);
+  if (options.preset && !preset.config && options.preset !== "auto") return;
+  if (preset.message) dependencies.log(preset.message);
   const existingEnvExample = options.envExample && options.force ? await readOptionalText(dependencies.resolvePath(rootDir, ".env.example"), dependencies) : void 0;
-  const files = buildInitFiles(rootDir, result, Boolean(options.envExample), dependencies.resolvePath, existingEnvExample, preset);
+  const files = buildInitFiles(rootDir, result, Boolean(options.envExample), dependencies.resolvePath, existingEnvExample, preset.config);
   if (options.dryRun) {
     for (const file of files) {
       dependencies.log(`Would write ${file.path}`);
@@ -167,14 +178,67 @@ function buildInitFiles(rootDir, result, includeEnvExample, resolvePath = resolv
   }
   return files;
 }
-function resolvePreset(name, dependencies) {
-  if (!name) return void 0;
+async function resolvePreset(rootDir, name, dependencies) {
+  if (!name) return {};
+  if (name === "auto") {
+    return detectPreset(rootDir, dependencies);
+  }
   if (name in presetConfigs) {
-    return presetConfigs[name];
+    return { config: presetConfigs[name] };
   }
   dependencies.error(`Unknown preset "${name}". Available presets: ${availablePresetList}.`);
   dependencies.exit(1);
-  return void 0;
+  return {};
+}
+async function detectPreset(rootDir, dependencies) {
+  const packageJson = await readPackageJson(rootDir, dependencies);
+  const packages = new Set(Object.keys({
+    ...packageJson?.dependencies,
+    ...packageJson?.devDependencies
+  }));
+  const packageDetections = [
+    ["nextjs", "next", 'dependency "next"'],
+    ["astro", "astro", 'dependency "astro"'],
+    ["nuxt", "nuxt", 'dependency "nuxt"'],
+    ["sveltekit", "@sveltejs/kit", 'dependency "@sveltejs/kit"'],
+    ["vite", "vite", 'dependency "vite"']
+  ];
+  for (const [presetName, packageName, reason] of packageDetections) {
+    if (packages.has(packageName)) {
+      return detectedPreset(presetName, reason);
+    }
+  }
+  const configDetections = [
+    ["nextjs", ["next.config.js", "next.config.mjs", "next.config.ts"]],
+    ["astro", ["astro.config.js", "astro.config.mjs", "astro.config.ts"]],
+    ["nuxt", ["nuxt.config.js", "nuxt.config.mjs", "nuxt.config.ts"]],
+    ["sveltekit", ["svelte.config.js", "svelte.config.ts"]],
+    ["vite", ["vite.config.js", "vite.config.mjs", "vite.config.ts"]]
+  ];
+  for (const [presetName, files] of configDetections) {
+    for (const file of files) {
+      if (await readOptionalText(dependencies.resolvePath(rootDir, file), dependencies) !== void 0) {
+        return detectedPreset(presetName, `found ${file}`);
+      }
+    }
+  }
+  return { message: "No framework preset detected. Using the base config." };
+}
+function detectedPreset(name, reason) {
+  return {
+    config: presetConfigs[name],
+    message: `Detected preset: ${name}
+Reason: ${reason}`
+  };
+}
+async function readPackageJson(rootDir, dependencies) {
+  const content = await readOptionalText(dependencies.resolvePath(rootDir, "package.json"), dependencies);
+  if (content === void 0) return void 0;
+  try {
+    return JSON.parse(content);
+  } catch {
+    return void 0;
+  }
 }
 function mergeUnique(base, extra) {
   return [.../* @__PURE__ */ new Set([...base, ...extra])].sort();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configenvy",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Find missing, unused, undocumented, and risky environment variables before setup breaks.",
   "type": "module",
   "engines": {
@@ -35,7 +35,7 @@
     "build": "tsup src/index.ts --format esm --dts --clean"
   },
   "dependencies": {
-    "@configenvy/core": "0.1.6",
+    "@configenvy/core": "0.2.0",
     "commander": "^12.1.0"
   },
   "keywords": [

package/src/index.ts

@@ -77,8 +77,9 @@ export function createProgram(dependencies: CliDependencies = defaultDependencie
     .argument("[path]", "project directory", ".")
     .option("--ci", "fail on warnings and errors")
     .option("--format <format>", "output format: text, json, or sarif", "text")
+    .option("--strict", "treat documentation warnings as errors")
     .action(async (projectPath: string, options: DoctorOptions) => {
-      await runDoctor(projectPath, { ...options, strict: Boolean(options.ci), ci: Boolean(options.ci) }, dependencies);
+      await runDoctor(projectPath, { ...options, strict: Boolean(options.strict || options.ci), ci: Boolean(options.ci) }, dependencies);
     });
 
   program
@@ -142,6 +143,10 @@ const starterConfig: StarterConfig = {
 type PresetName = keyof typeof presetConfigs;
 
 const presetConfigs = {
+  astro: {
+    optional: ["PUBLIC_SITE_URL"],
+    ignore: ["BASE_URL", "DEV", "MODE", "PROD", "SSR"]
+  },
   docker: {
     optional: ["COMPOSE_PROJECT_NAME"],
     ignore: ["HOSTNAME"]
@@ -150,6 +155,12 @@ const presetConfigs = {
     optional: ["NEXT_PUBLIC_APP_URL"],
     ignore: ["NEXT_RUNTIME"]
   },
+  nuxt: {
+    optional: ["NUXT_PUBLIC_API_BASE"]
+  },
+  sveltekit: {
+    optional: ["PUBLIC_BASE_URL"]
+  },
   vercel: {
     ignore: ["VERCEL", "VERCEL_ENV", "VERCEL_URL", "VERCEL_BRANCH_URL", "VERCEL_PROJECT_PRODUCTION_URL", "VERCEL_REGION"]
   },
@@ -160,13 +171,18 @@ const presetConfigs = {
 } satisfies Record<string, Partial<StarterConfig>>;
 
 const availablePresetNames = Object.keys(presetConfigs).sort();
-const availablePresetList = availablePresetNames.join(", ");
+const availablePresetList = ["auto", ...availablePresetNames].join(", ");
 
 type InitFile = {
   content: string;
   path: string;
 };
 
+type PresetResolution = {
+  config?: Partial<StarterConfig>;
+  message?: string;
+};
+
 const require = createRequire(import.meta.url);
 const cliPackage = require("../package.json") as { version: string };
 export const cliVersion = cliPackage.version;
@@ -213,12 +229,13 @@ export async function runInit(
 ): Promise<void> {
   const rootDir = dependencies.resolvePath(projectPath);
   const result = await dependencies.scanProject({ rootDir });
-  const preset = resolvePreset(options.preset, dependencies);
-  if (options.preset && !preset) return;
+  const preset = await resolvePreset(rootDir, options.preset, dependencies);
+  if (options.preset && !preset.config && options.preset !== "auto") return;
+  if (preset.message) dependencies.log(preset.message);
   const existingEnvExample = options.envExample && options.force
     ? await readOptionalText(dependencies.resolvePath(rootDir, ".env.example"), dependencies)
     : undefined;
-  const files = buildInitFiles(rootDir, result, Boolean(options.envExample), dependencies.resolvePath, existingEnvExample, preset);
+  const files = buildInitFiles(rootDir, result, Boolean(options.envExample), dependencies.resolvePath, existingEnvExample, preset.config);
 
   if (options.dryRun) {
     for (const file of files) {
@@ -282,14 +299,78 @@ export function buildInitFiles(
   return files;
 }
 
-function resolvePreset(name: string | undefined, dependencies: CliDependencies): Partial<StarterConfig> | undefined {
-  if (!name) return undefined;
+async function resolvePreset(rootDir: string, name: string | undefined, dependencies: CliDependencies): Promise<PresetResolution> {
+  if (!name) return {};
+  if (name === "auto") {
+    return detectPreset(rootDir, dependencies);
+  }
   if (name in presetConfigs) {
-    return presetConfigs[name as PresetName];
+    return { config: presetConfigs[name as PresetName] };
   }
   dependencies.error(`Unknown preset "${name}". Available presets: ${availablePresetList}.`);
   dependencies.exit(1);
-  return undefined;
+  return {};
+}
+
+async function detectPreset(rootDir: string, dependencies: CliDependencies): Promise<PresetResolution> {
+  const packageJson = await readPackageJson(rootDir, dependencies);
+  const packages = new Set(Object.keys({
+    ...packageJson?.dependencies,
+    ...packageJson?.devDependencies
+  }));
+
+  const packageDetections: Array<[PresetName, string, string]> = [
+    ["nextjs", "next", "dependency \"next\""],
+    ["astro", "astro", "dependency \"astro\""],
+    ["nuxt", "nuxt", "dependency \"nuxt\""],
+    ["sveltekit", "@sveltejs/kit", "dependency \"@sveltejs/kit\""],
+    ["vite", "vite", "dependency \"vite\""]
+  ];
+  for (const [presetName, packageName, reason] of packageDetections) {
+    if (packages.has(packageName)) {
+      return detectedPreset(presetName, reason);
+    }
+  }
+
+  const configDetections: Array<[PresetName, string[]]> = [
+    ["nextjs", ["next.config.js", "next.config.mjs", "next.config.ts"]],
+    ["astro", ["astro.config.js", "astro.config.mjs", "astro.config.ts"]],
+    ["nuxt", ["nuxt.config.js", "nuxt.config.mjs", "nuxt.config.ts"]],
+    ["sveltekit", ["svelte.config.js", "svelte.config.ts"]],
+    ["vite", ["vite.config.js", "vite.config.mjs", "vite.config.ts"]]
+  ];
+  for (const [presetName, files] of configDetections) {
+    for (const file of files) {
+      if (await readOptionalText(dependencies.resolvePath(rootDir, file), dependencies) !== undefined) {
+        return detectedPreset(presetName, `found ${file}`);
+      }
+    }
+  }
+
+  return { message: "No framework preset detected. Using the base config." };
+}
+
+function detectedPreset(name: PresetName, reason: string): PresetResolution {
+  return {
+    config: presetConfigs[name],
+    message: `Detected preset: ${name}\nReason: ${reason}`
+  };
+}
+
+async function readPackageJson(rootDir: string, dependencies: CliDependencies): Promise<{
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+} | undefined> {
+  const content = await readOptionalText(dependencies.resolvePath(rootDir, "package.json"), dependencies);
+  if (content === undefined) return undefined;
+  try {
+    return JSON.parse(content) as {
+      dependencies?: Record<string, string>;
+      devDependencies?: Record<string, string>;
+    };
+  } catch {
+    return undefined;
+  }
 }
 
 function mergeUnique(base: string[], extra: readonly string[]): string[] {