@batijs/core 0.0.630 → 0.0.631

package/dist/config.d.ts

@@ -9,6 +9,35 @@ interface VikeMeta {
   BATI_IS_CI?: boolean;
 }
 //#endregion
+//#region src/env-registry.d.ts
+/** Destinations a declared env var can be emitted to. */
+type EnvSink = "dotenv" | "compose" | "dockerfile" | "wrangler";
+/**
+ * What kind of value a var carries:
+ * - `secret`: no committed value; the host/CI supplies it at runtime.
+ * - `server-default`: a safe default committed to the repo.
+ * - `public`: a client/build-time var (e.g. `PUBLIC_ENV__*`), never part of the server runtime.
+ */
+type EnvScope = "secret" | "server-default" | "public";
+interface EnvVarDef {
+  /** Variable name, e.g. `DATABASE_URL`. */
+  key: string;
+  scope: EnvScope;
+  /** `.env` help text (may be multi-line). */
+  comment?: string;
+  /** Default value for `server-default` / `public` scopes. */
+  default?: string;
+  /** Value overrides per destination, e.g. a container path vs. a local one. */
+  perSink?: Partial<Record<EnvSink, string>>;
+  /** `secret` only: env var to read a dev/test value from. */
+  devValueFrom?: string;
+  /** Groups + comments vars in the compose/Dockerfile output, e.g. `"auth0"`. */
+  group?: string;
+}
+type EnvRegistry = EnvVarDef[];
+/** A feature's env-var producer; meta-gating (does the var apply?) lives here. */
+type EnvRegistryFactory = (meta: VikeMeta) => EnvRegistry;
+//#endregion
 //#region src/config.d.ts
 interface BatiConfigStep {
   order?: number;
@@ -26,6 +55,8 @@ interface BatiConfig {
   enforce?: "pre" | "post";
   nextSteps?: (meta: VikeMeta, packageManager: string, utils: typeof Colorette) => BatiConfigStep[];
   knip?: BatiKnipConfig;
+  /** Env vars this feature contributes, gated on `meta` (see {@link EnvRegistryFactory}). */
+  env?: EnvRegistryFactory;
 }
 declare function defineConfig<T extends BatiConfig>(config: T): T;
 //#endregion

package/dist/config.js

@@ -1 +1 @@
-function e(e,t){if(!e)throw Error(t)}function t(t){return`enforce`in t&&e(t.enforce===`pre`||t.enforce===`post`,`'enforce' must be 'pre' or 'post', was ${t.enforce}`),`if`in t&&e(typeof t.if==`function`,`'if' must be a function`),`nextSteps`in t&&e(typeof t.nextSteps==`function`,`'nextSteps' must be a function`),`knip`in t&&(e(typeof t.knip==`object`&&t.knip!==null,`'knip' must be an object`),`entry`in t.knip&&e(Array.isArray(t.knip.entry),`'knip.entry' must be an array`),`ignoreDependencies`in t.knip&&e(Array.isArray(t.knip.ignoreDependencies),`'knip.ignoreDependencies' must be an array`),`ignore`in t.knip&&e(Array.isArray(t.knip.ignore),`'knip.ignore' must be an array`),`vite`in t.knip&&e(typeof t.knip.vite==`boolean`,`'knip.vite' must be a boolean`)),t}export{t as defineConfig};
+function e(e,t){if(!e)throw Error(t)}function t(t){return`enforce`in t&&e(t.enforce===`pre`||t.enforce===`post`,`'enforce' must be 'pre' or 'post', was ${t.enforce}`),`if`in t&&e(typeof t.if==`function`,`'if' must be a function`),`nextSteps`in t&&e(typeof t.nextSteps==`function`,`'nextSteps' must be a function`),`knip`in t&&(e(typeof t.knip==`object`&&t.knip!==null,`'knip' must be an object`),`entry`in t.knip&&e(Array.isArray(t.knip.entry),`'knip.entry' must be an array`),`ignoreDependencies`in t.knip&&e(Array.isArray(t.knip.ignoreDependencies),`'knip.ignoreDependencies' must be an array`),`ignore`in t.knip&&e(Array.isArray(t.knip.ignore),`'knip.ignore' must be an array`),`vite`in t.knip&&e(typeof t.knip.vite==`boolean`,`'knip.vite' must be a boolean`)),`env`in t&&e(typeof t.env==`function`,`'env' must be a function of meta`),t}export{t as defineConfig};

package/dist/index.d.ts

@@ -64,6 +64,66 @@ declare function dockerPackageManager(name: string, {
   frozenLockfile: boolean;
 }): DockerPackageManager;
 //#endregion
+//#region src/types.d.ts
+type ContentGetter = () => string | Promise<string>;
+interface VikeMeta {
+  BATI: BatiSet;
+  BATI_TEST?: boolean;
+  BATI_SKIP_GIT?: boolean;
+  BATI_IS_CI?: boolean;
+}
+type TransformerProps = {
+  readfile?: ContentGetter;
+  target: string;
+  source: string;
+  meta: VikeMeta;
+  packageJson: PackageJson;
+  env: EnvRegistry;
+};
+type Transformer = (props: TransformerProps) => unknown;
+interface PackageJson {
+  dependencies?: Record<string, string>;
+  devDependencies?: Record<string, string>;
+}
+interface StringTransformer {
+  finalize(): string;
+}
+//#endregion
+//#region src/env-registry.d.ts
+/** Destinations a declared env var can be emitted to. */
+type EnvSink = "dotenv" | "compose" | "dockerfile" | "wrangler";
+/**
+ * What kind of value a var carries:
+ * - `secret`: no committed value; the host/CI supplies it at runtime.
+ * - `server-default`: a safe default committed to the repo.
+ * - `public`: a client/build-time var (e.g. `PUBLIC_ENV__*`), never part of the server runtime.
+ */
+type EnvScope = "secret" | "server-default" | "public";
+interface EnvVarDef {
+  /** Variable name, e.g. `DATABASE_URL`. */
+  key: string;
+  scope: EnvScope;
+  /** `.env` help text (may be multi-line). */
+  comment?: string;
+  /** Default value for `server-default` / `public` scopes. */
+  default?: string;
+  /** Value overrides per destination, e.g. a container path vs. a local one. */
+  perSink?: Partial<Record<EnvSink, string>>;
+  /** `secret` only: env var to read a dev/test value from. */
+  devValueFrom?: string;
+  /** Groups + comments vars in the compose/Dockerfile output, e.g. `"auth0"`. */
+  group?: string;
+}
+type EnvRegistry = EnvVarDef[];
+/** A feature's env-var producer; meta-gating (does the var apply?) lives here. */
+type EnvRegistryFactory = (meta: VikeMeta) => EnvRegistry;
+/** Server-runtime vars: everything but the client/build-time `public` ones. */
+declare function isServerVar(def: EnvVarDef): boolean;
+/** The committed value a non-secret var contributes to a sink. */
+declare function committedValue(def: EnvVarDef, sink: EnvSink): string;
+/** A secret's dev/test value, from its `devValueFrom` env var (empty if unset). */
+declare function secretDevValue(def: EnvVarDef): string;
+//#endregion
 //#region src/format.d.ts
 declare function formatCode(code: string, options: {
   filepath: string;
@@ -1131,30 +1191,6 @@ interface Yaml extends Literal {
  */
 interface YamlData extends Data {}
 //#endregion
-//#region src/types.d.ts
-type ContentGetter = () => string | Promise<string>;
-interface VikeMeta {
-  BATI: BatiSet;
-  BATI_TEST?: boolean;
-  BATI_SKIP_GIT?: boolean;
-  BATI_IS_CI?: boolean;
-}
-type TransformerProps = {
-  readfile?: ContentGetter;
-  target: string;
-  source: string;
-  meta: VikeMeta;
-  packageJson: PackageJson;
-};
-type Transformer = (props: TransformerProps) => unknown;
-interface PackageJson {
-  dependencies?: Record<string, string>;
-  devDependencies?: Record<string, string>;
-}
-interface StringTransformer {
-  finalize(): string;
-}
-//#endregion
 //#region src/markdown/utils.d.ts
 /**
  * Parse a comment marker.
@@ -1288,6 +1324,14 @@ declare function loadYaml({
   fallbackEmpty?: boolean;
 }): Promise<YAMLDocument.Parsed<_$yaml.Alias.Parsed, true> | YAMLDocument.Parsed<_$yaml.Scalar.Parsed, true> | YAMLDocument.Parsed<_$yaml.YAMLMap.Parsed<_$yaml.ParsedNode, _$yaml.ParsedNode | null>, true> | YAMLDocument.Parsed<_$yaml.YAMLSeq.Parsed<_$yaml.ParsedNode>, true>>;
 //#endregion
+//#region src/parse/yaml.d.ts
+/**
+ * Append `KEY=value` items to `services.<service>.environment` of a
+ * docker-compose document. Used to inject the env-registry-derived env block
+ * (see `composeEnvEntries`) without the compose boilerplate hardcoding vars.
+ */
+declare function setComposeEnvironment(code: string, entries: string[], service?: string): string;
+//#endregion
 //#region src/parse/linters/common.d.ts
 type AllowedContextFlags = "include-if-imported";
 interface FileContext {
@@ -1319,11 +1363,8 @@ declare function getVersion(): {
   version: string;
   semver: string[];
 };
-//#endregion
-//#region src/utils/env.d.ts
-declare function appendToEnv(envContent: string | undefined | null, key: string, value: unknown, comment?: string): string;
 declare namespace index_d_exports {
-  export { BaseOptions, ContentGetter, CopyOptions, DockerPackageManager, DockerfileBuilder, EnvRecord, FileContext, FromOptions, MarkdownV2, PackageJson, PackageManagerInfo, StringTransformer, Transformer, TransformerProps, VikeMeta, YAMLDocument, YAMLMap, YAMLSeq, addVitePlugin, appendToEnv, builders, deepMergeObject, dockerPackageManager, dockerfile, formatCode, generateCode, getArgs, getVersion, loadAsJson, loadAsMagicast, loadFile, loadMarkdown, loadPackageJson, loadRelativeFileAsMagicast, loadYaml, packageManager, parseMarkdown, parseModule, randomBytes, transformAndFormat, which, withIcon };
+  export { BaseOptions, ContentGetter, CopyOptions, DockerPackageManager, DockerfileBuilder, EnvRecord, EnvRegistry, EnvRegistryFactory, EnvScope, EnvSink, EnvVarDef, FileContext, FromOptions, MarkdownV2, PackageJson, PackageManagerInfo, StringTransformer, Transformer, TransformerProps, VikeMeta, YAMLDocument, YAMLMap, YAMLSeq, addVitePlugin, builders, committedValue, deepMergeObject, dockerPackageManager, dockerfile, formatCode, generateCode, getArgs, getVersion, isServerVar, loadAsJson, loadAsMagicast, loadFile, loadMarkdown, loadPackageJson, loadRelativeFileAsMagicast, loadYaml, packageManager, parseMarkdown, parseModule, randomBytes, secretDevValue, setComposeEnvironment, transformAndFormat, which, withIcon };
 }
 //#endregion
-export { BaseOptions, ContentGetter, CopyOptions, DockerPackageManager, DockerfileBuilder, EnvRecord, type FileContext, FromOptions, MarkdownV2, PackageJson, PackageManagerInfo, StringTransformer, Transformer, TransformerProps, VikeMeta, type YAMLDocument, YAMLMap, YAMLSeq, addVitePlugin, appendToEnv, builders, deepMergeObject, dockerPackageManager, dockerfile, formatCode, generateCode, getArgs, getVersion, loadAsJson, loadAsMagicast, loadFile, loadMarkdown, loadPackageJson, loadRelativeFileAsMagicast, loadYaml, packageManager, parseMarkdown, parseModule, randomBytes, transformAndFormat, which, withIcon };
+export { BaseOptions, ContentGetter, CopyOptions, DockerPackageManager, DockerfileBuilder, EnvRecord, EnvRegistry, EnvRegistryFactory, EnvScope, EnvSink, EnvVarDef, type FileContext, FromOptions, MarkdownV2, PackageJson, PackageManagerInfo, StringTransformer, Transformer, TransformerProps, VikeMeta, type YAMLDocument, YAMLMap, YAMLSeq, addVitePlugin, builders, committedValue, deepMergeObject, dockerPackageManager, dockerfile, formatCode, generateCode, getArgs, getVersion, isServerVar, loadAsJson, loadAsMagicast, loadFile, loadMarkdown, loadPackageJson, loadRelativeFileAsMagicast, loadYaml, packageManager, parseMarkdown, parseModule, randomBytes, secretDevValue, setComposeEnvironment, transformAndFormat, which, withIcon };