@catladder/cli 0.0.0-next-e9e5af68 → 0.0.0-next-1c65899f

package/dist/pipeline/src/types/config.d.ts

@@ -17,21 +17,21 @@ export type PipelineTrigger = (typeof ALL_PIPELINE_TRIGGERS)[number];
  * Each env type has a default env with the same name which is always included
  */
 export declare const ENV_TYPES: {
-  readonly dev: {
-    readonly triggers: readonly ["mainBranch"];
-  };
-  readonly review: {
-    readonly triggers: readonly ["mr"];
-  };
-  readonly stage: {
-    readonly triggers: readonly ["taggedRelease"];
-  };
-  readonly prod: {
-    readonly triggers: readonly ["taggedRelease"];
-  };
-  readonly local: {
-    readonly triggers: readonly [];
-  };
+    readonly dev: {
+        readonly triggers: readonly ["mainBranch"];
+    };
+    readonly review: {
+        readonly triggers: readonly ["mr"];
+    };
+    readonly stage: {
+        readonly triggers: readonly ["taggedRelease"];
+    };
+    readonly prod: {
+        readonly triggers: readonly ["taggedRelease"];
+    };
+    readonly local: {
+        readonly triggers: readonly [];
+    };
 };
 /**
  *
@@ -44,162 +44,164 @@ export declare const DEFAULT_ENV_TYPES: ("stage" | "dev" | "review" | "prod" | "
 export type EnvType = keyof typeof ENV_TYPES;
 export declare const isKnowEnvType: (env: string) => env is "stage" | "dev" | "review" | "prod" | "local";
 export type EnvVars = {
-  /**
-   * public env vars (means: they are checked in the repo).
-   *
-   * You can reuse env vars in other vars using ${OTHER_VAR}.
-   * You an reuse other public env vars, or secret env vars
-   *
-   * EXAMPLE: A_VAR: "the other var is ${OTHER_VAR}"
-   *
-   * You can reuse vars from other components in the same project using ${componentName:variableName}
-   * EXAMPLE: A_VAR: "the other var is ${api:OTHER_VAR}"
-   */
-  public?: Record<string, any>;
-  /**
-   * env vars whose values live in the vault (managed with catladder/cli).
-   *
-   * Preferred form is a record with the kind per key:
-   * - "secret": sensitive — masked where the platform supports it
-   * - "variable": vault-stored but not sensitive (ids, host suffixes) —
-   *   never masked, so log links stay clickable and environment urls work
-   * - an object for additional per-key config
-   *
-   * EXAMPLE: secret: { API_KEY: "secret", PROJECT_ID: "variable" }
-   *
-   * The plain string[] form (all keys secret) is deprecated.
-   */
-  secret?: string[] | Record<string, SecretVarKind | SecretVarConfig>;
+    /**
+     * public env vars (means: they are checked in the repo).
+     *
+     * You can reuse env vars in other vars using ${OTHER_VAR}.
+     * You an reuse other public env vars, or secret env vars
+     *
+     * EXAMPLE: A_VAR: "the other var is ${OTHER_VAR}"
+     *
+     * You can reuse vars from other components in the same project using ${componentName:variableName}
+     * EXAMPLE: A_VAR: "the other var is ${api:OTHER_VAR}"
+     */
+    public?: Record<string, any>;
+    /**
+     * env vars whose values live in the vault (managed with catladder/cli).
+     *
+     * Preferred form is a record with the kind per key:
+     * - "secret": sensitive — masked where the platform supports it
+     * - "variable": vault-stored but not sensitive (ids, host suffixes) —
+     *   never masked, so log links stay clickable and environment urls work
+     * - an object for additional per-key config
+     *
+     * EXAMPLE: secret: { API_KEY: "secret", PROJECT_ID: "variable" }
+     *
+     * The plain string[] form (all keys secret) is deprecated.
+     */
+    secret?: string[] | Record<string, SecretVarKind | SecretVarConfig>;
 };
 export type SecretVarKind = "secret" | "variable";
 export type SecretVarConfig = {
-  kind?: SecretVarKind;
-  /** hidden env vars are not shown in config-secrets */
-  hidden?: boolean;
+    kind?: SecretVarKind;
+    /** hidden env vars are not shown in config-secrets */
+    hidden?: boolean;
 };
 export type DefaultEnvConfig = {
-  /**
-   * how the app is deployed
-   */
-  deploy: DeployConfig | false;
-  /**
-   * how the app is built and its runtime
-   */
-  build: BuildConfig | false;
-  /**
-   * environment variables
-   */
-  vars?: EnvVars;
-  /**
-   * post-deploy verification: runs a job in the `verify` stage after the deploy,
-   * e.g. an e2e test suite against the freshly deployed environment.
-   *
-   * Runs in all deployed envs by default, disable per env with `verify: false`
-   */
-  verify?: VerifyConfig | false;
+    /**
+     * how the app is deployed
+     */
+    deploy: DeployConfig | false;
+    /**
+     * how the app is built and its runtime
+     */
+    build: BuildConfig | false;
+    /**
+     * environment variables
+     */
+    vars?: EnvVars;
+    /**
+     * post-deploy verification: runs a job in the `verify` stage after the deploy,
+     * e.g. an e2e test suite against the freshly deployed environment.
+     *
+     * Runs in all deployed envs by default, disable per env with `verify: false`
+     */
+    verify?: VerifyConfig | false;
 };
 export type DevLocalEnvConfig = {
-  vars?: EnvVars;
-  /**
-   * port that is used. If not set, 3000 is used.
-   * set false to not set a port at all
-   */
-  port?: number | false;
+    vars?: EnvVars;
+    /**
+     * port that is used. If not set, 3000 is used.
+     * set false to not set a port at all
+     */
+    port?: number | false;
+};
+type AddOverrideFunction<T> = {
+    [K in keyof T]: T[K] | ((defaultValue: T[K]) => T[K]) | (T[K] extends Record<string, unknown> | undefined ? AddOverrideFunction<T[K]> : never);
 };
-type AddOverrideFunction<T> = { [K in keyof T]: T[K] | ((defaultValue: T[K]) => T[K]) | (T[K] extends Record<string, unknown> | undefined ? AddOverrideFunction<T[K]> : never) };
 type EnvConfigWithOverride<E extends EnvType = EnvType> = AddOverrideFunction<EnvConfig<E>>;
 export type EnvConfig<E extends EnvType = EnvType> = {
-  /**
-   * type of the env (stage, prod, review, dev)
-   */
-  type?: E;
-  /**
-   * host that is used. If not set, a "canonical" url is created
-   */
-  host?: string;
+    /**
+     * type of the env (stage, prod, review, dev)
+     */
+    type?: E;
+    /**
+     * host that is used. If not set, a "canonical" url is created
+     */
+    host?: string;
 } & PartialDeep<DefaultEnvConfig>;
 export type EnvConfigWithComponent = EnvConfig<EnvType> & ComponentConfig;
 export type CustomEnv = EnvConfigWithOverride & {
-  type: EnvType;
+    type: EnvType;
 };
 export type Env<C extends ConfigProps = never> = {
-  /**
-   * local is a special env that is only used in local development
-   */
-  local?: AddOverrideFunction<DevLocalEnvConfig>;
-  dev?: EnvConfigWithOverride<"dev"> | false;
-  stage?: EnvConfigWithOverride<"stage"> | false;
-  review?: EnvConfigWithOverride<"review"> | false;
-  prod?: EnvConfigWithOverride<"prod"> | false;
+    /**
+     * local is a special env that is only used in local development
+     */
+    local?: AddOverrideFunction<DevLocalEnvConfig>;
+    dev?: EnvConfigWithOverride<"dev"> | false;
+    stage?: EnvConfigWithOverride<"stage"> | false;
+    review?: EnvConfigWithOverride<"review"> | false;
+    prod?: EnvConfigWithOverride<"prod"> | false;
 } & Record<C["CustomEnvs"], CustomEnv> & Record<string, any>;
 export type ComponentConfig<C extends ConfigProps = never> = {
-  /**
-   * specify environment configurations
-   */
-  env?: Env<C>;
-  /**
-   * the directory of the component (e.g. where the package.json or similar is located). You can set "." if you only have one app.
-   */
-  dir: string;
-  /**
-   * add custom jobs. Can be an array or a function that receives the context and returns an array of jobs.
-   * For convenience, all env vars are injectd as variables
-   *
-   * Please raise an issue on https://git.panter.ch/catladder/catladder
-   * to let us know about why you need to use custom jobs.
-   * This feedback will help us to generalize use cases
-   */
-  customJobs?: CatladderJobSpec[] | ((context: Omit<ComponentContext, "customJobs">) => CatladderJobSpec[]);
-  /**
-   * whether to create a .env
-   *
-   * Be careful, this will overwrite any existing .env file!
-   *
-   * if set to true it will create .env locally and during build.
-   * Be careful: the .env file usually ends up in the build artifacts.
-   * Use this for apps and clients where env does not contain any secrets
-   *
-   *
-   * if set to "local" it will only create .env file locally.
-   * Use this in combination with @dotenvx/dotenvx or node 20 to start apps locally with .env files
-   * During build and runtime, it relies on the env vars set in the environment
-   *
-   * @defaultValue true
-   *
-   */
-  dotEnv?: boolean | "local";
-  /**
-   * whether to create a env.d.ts localy and during build jobs
-   *
-   * @defaultValue true
-   */
-  envDTs?: boolean;
+    /**
+     * specify environment configurations
+     */
+    env?: Env<C>;
+    /**
+     * the directory of the component (e.g. where the package.json or similar is located). You can set "." if you only have one app.
+     */
+    dir: string;
+    /**
+     * add custom jobs. Can be an array or a function that receives the context and returns an array of jobs.
+     * For convenience, all env vars are injectd as variables
+     *
+     * Please raise an issue on https://git.panter.ch/catladder/catladder
+     * to let us know about why you need to use custom jobs.
+     * This feedback will help us to generalize use cases
+     */
+    customJobs?: CatladderJobSpec[] | ((context: Omit<ComponentContext, "customJobs">) => CatladderJobSpec[]);
+    /**
+     * whether to create a .env
+     *
+     * Be careful, this will overwrite any existing .env file!
+     *
+     * if set to true it will create .env locally and during build.
+     * Be careful: the .env file usually ends up in the build artifacts.
+     * Use this for apps and clients where env does not contain any secrets
+     *
+     *
+     * if set to "local" it will only create .env file locally.
+     * Use this in combination with @dotenvx/dotenvx or node 20 to start apps locally with .env files
+     * During build and runtime, it relies on the env vars set in the environment
+     *
+     * @defaultValue true
+     *
+     */
+    dotEnv?: boolean | "local";
+    /**
+     * whether to create a env.d.ts localy and during build jobs
+     *
+     * @defaultValue true
+     */
+    envDTs?: boolean;
 } & DefaultEnvConfig;
 export type ConfigProps = {
-  CustomEnvs: string;
+    CustomEnvs: string;
 };
 /**
  * per-pipeline-type options
  */
 export type PipelineOutputOptions = {
-  /**
-   * the git remote that points to this CI system's repository.
-   * Relevant during migrations, where e.g. gitlab is `origin` and
-   * github is a second remote.
-   *
-   * defaults to "origin"
-   */
-  gitRemote?: string;
-  /**
-   * variables applied to every job of THIS pipeline type only —
-   * lowered to gitlab's pipeline-level `variables:` / github's
-   * workflow-level `env:`, so job-level `runnerVariables` take
-   * precedence.
-   *
-   * Useful when the CI systems need different values, e.g. a lower
-   * `TURBO_CONCURRENCY` for github's small hosted runners.
-   */
-  runnerVariables?: Record<string, string>;
+    /**
+     * the git remote that points to this CI system's repository.
+     * Relevant during migrations, where e.g. gitlab is `origin` and
+     * github is a second remote.
+     *
+     * defaults to "origin"
+     */
+    gitRemote?: string;
+    /**
+     * variables applied to every job of THIS pipeline type only —
+     * lowered to gitlab's pipeline-level `variables:` / github's
+     * workflow-level `env:`, so job-level `runnerVariables` take
+     * precedence.
+     *
+     * Useful when the CI systems need different values, e.g. a lower
+     * `TURBO_CONCURRENCY` for github's small hosted runners.
+     */
+    runnerVariables?: Record<string, string>;
 };
 /**
  * where secret values are stored and edited (the readable source of
@@ -211,110 +213,104 @@ export type PipelineOutputOptions = {
  *   env/component (`<customer>/<app>/<env>/<component>/secrets.yml`)
  */
 export type SecretsVaultConfig = "gitlab" | {
-  type: "gitlab";
+    type: "gitlab";
 } | {
-  type: "bitwarden";
-  /**
-   * the bitwarden collection holding the secret notes
-   * @default "catladder"
-   */
-  collection?: string;
+    type: "bitwarden";
+    /**
+     * the bitwarden collection holding the secret notes
+     * @default "catladder"
+     */
+    collection?: string;
 };
 export type SecretsConfig = {
-  vault?: SecretsVaultConfig;
+    vault?: SecretsVaultConfig;
 };
 export type Config<C extends ConfigProps = never> = {
-  /**
-   * the pipeline type to generate, defaults to gitlab
-   *
-   * @deprecated use `pipelines` instead
-   */
-  pipelineType?: PipelineType;
-  /**
-   * which pipelines to generate. Multiple pipeline types can be enabled
-   * at the same time (e.g. during a step-by-step migration from one CI
-   * system to another); each generates its own set of files.
-   *
-   * Defaults to `{ gitlab: true }` (or the deprecated `pipelineType`).
-   *
-   * @example
-   * pipelines: {
-   *   gitlab: true,
-   * }
-   */
-  pipelines?: { [T in PipelineType]?: boolean | PipelineOutputOptions };
-  /**
-   * how secrets are stored and shared (see {@link SecretsConfig})
-   */
-  secrets?: SecretsConfig;
-  /**
-   * where the catladder job images come from:
-   * - central: catladder's central registry (default on gitlab)
-   * - repo: built in the repository's own registry from the image
-   *   definitions shipped with catladder (default and required on
-   *   github, where the central registry is not reachable)
-   */
-  jobImages?: "central" | "repo";
-  /**
-   * materialize the agent skills shipped with catladder (usage guides
-   * for AI coding agents like Claude Code) into the repository, so
-   * agents working in the project use knowledge matching the installed
-   * catladder version. The skills are written on every generation into
-   * `catladder-*` directories under the agent skill folders (e.g.
-   * `.claude/skills/`) — that namespace is owned by catladder and must
-   * not be edited manually.
-   *
-   * - `true` (default): write to all known agent skill directories
-   * - `false`: opt out (previously generated skills are removed)
-   * - `{ targets: [...] }`: only write to the given targets
-   */
-  agentSkills?: AgentSkillsConfig;
-  /**
-   * name of the customer or group
-   */
-  customerName: string;
-  /**
-   * name of the app / project
-   */
-  appName: string;
-  /**
-   * if a env does not define a host, it will generate a canonical one (e.g. for review, dev and stage).
-   * This prop specifies the domain that is used for these urls.
-   *
-   */
-  domainCanonical?: string;
-  agents?: Record<string, AgentConfig>;
-  builds?: Record<string, WorkspaceBuildConfig>;
-  /**
-   * components (sub apps)
-   */
-  components: Record<string, ComponentConfig<C>>;
-  /**
-   * additional meta data (only for organisational purposes)
-   */
-  meta?: {
-    labels?: Record<string, string>;
-  };
-  /**
-   * additional vars only for the runner in all jobs.
-   */
-  runnerVariables?: Record<string, string>;
-  /**
-   * hook into catladder generation
-   */
-  hooks?: Hooks;
-  /**
-   * configure tagged releases
-   */
-  releases?: ReleaseConfig;
-  /**
-   * contents of `.catladder-store/store.yml` — non-secret, machine-fetched
-   * values written by `catladder project setup` (e.g. gcloud project
-   * numbers).
-   *
-   * Attached automatically when the config is read from disk; do not set
-   * this manually in catladder.ts.
-   */
-  store?: CatladderStore;
+    /**
+     * the pipeline type to generate, defaults to gitlab
+     *
+     * @deprecated use `pipelines` instead
+     */
+    pipelineType?: PipelineType;
+    /**
+     * which pipelines to generate. Multiple pipeline types can be enabled
+     * at the same time (e.g. during a step-by-step migration from one CI
+     * system to another); each generates its own set of files.
+     *
+     * Defaults to `{ gitlab: true }` (or the deprecated `pipelineType`).
+     *
+     * @example
+     * pipelines: {
+     *   gitlab: true,
+     * }
+     */
+    pipelines?: {
+        [T in PipelineType]?: boolean | PipelineOutputOptions;
+    };
+    /**
+     * how secrets are stored and shared (see {@link SecretsConfig})
+     */
+    secrets?: SecretsConfig;
+    /**
+     * materialize the agent skills shipped with catladder (usage guides
+     * for AI coding agents like Claude Code) into the repository, so
+     * agents working in the project use knowledge matching the installed
+     * catladder version. The skills are written on every generation into
+     * `catladder-*` directories under the agent skill folders (e.g.
+     * `.claude/skills/`) — that namespace is owned by catladder and must
+     * not be edited manually.
+     *
+     * - `true` (default): write to all known agent skill directories
+     * - `false`: opt out (previously generated skills are removed)
+     * - `{ targets: [...] }`: only write to the given targets
+     */
+    agentSkills?: AgentSkillsConfig;
+    /**
+     * name of the customer or group
+     */
+    customerName: string;
+    /**
+     * name of the app / project
+     */
+    appName: string;
+    /**
+     * if a env does not define a host, it will generate a canonical one (e.g. for review, dev and stage).
+     * This prop specifies the domain that is used for these urls.
+     *
+     */
+    domainCanonical?: string;
+    agents?: Record<string, AgentConfig>;
+    builds?: Record<string, WorkspaceBuildConfig>;
+    /**
+     * components (sub apps)
+     */
+    components: Record<string, ComponentConfig<C>>;
+    /**
+     * additional meta data (only for organisational purposes)
+     */
+    meta?: {
+        labels?: Record<string, string>;
+    };
+    /**
+     * additional vars only for the runner in all jobs.
+     */
+    runnerVariables?: Record<string, string>;
+    /**
+     * hook into catladder generation
+     */
+    hooks?: Hooks;
+    /**
+     * configure tagged releases
+     */
+    releases?: ReleaseConfig;
+    /**
+     * contents of `.catladder-store/store.yml` — non-secret, machine-fetched
+     * values written by `catladder project setup` (e.g. gcloud project
+     * numbers).
+     *
+     * Attached automatically when the config is read from disk; do not set
+     * this manually in catladder.ts.
+     */
+    store?: CatladderStore;
 };
-export {};
+export {};

package/dist/pipeline/src/types/config.js

@@ -1,41 +1,45 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.isKnowEnvType = exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS = exports.getEnvTypesByTrigger = exports.ENV_TYPES = exports.ALL_PIPELINE_TRIGGERS = void 0;
-exports.ALL_PIPELINE_TRIGGERS = ["mainBranch", "mr", "taggedRelease"];
+exports.ALL_PIPELINE_TRIGGERS = [
+    "mainBranch",
+    "mr",
+    "taggedRelease",
+];
 /**
  * all env types with their trigger.
  * Each env type has a default env with the same name which is always included
  */
 exports.ENV_TYPES = {
-  dev: {
-    triggers: ["mainBranch"]
-  },
-  review: {
-    triggers: ["mr"]
-  },
-  stage: {
-    triggers: ["taggedRelease"]
-  },
-  prod: {
-    triggers: ["taggedRelease"]
-  },
-  local: {
-    triggers: []
-  }
+    dev: {
+        triggers: ["mainBranch"],
+    },
+    review: {
+        triggers: ["mr"],
+    },
+    stage: {
+        triggers: ["taggedRelease"],
+    },
+    prod: {
+        triggers: ["taggedRelease"],
+    },
+    local: {
+        triggers: [],
+    },
 };
 /**
  *
  * @param trigger a trigger
  * @returns array of env types for that trigger. this is also the list of default envs
  */
-const getEnvTypesByTrigger = trigger => Object.entries(exports.ENV_TYPES).filter(([, e]) => e.triggers.includes(trigger)).map(([e]) => e);
+const getEnvTypesByTrigger = (trigger) => Object.entries(exports.ENV_TYPES)
+    .filter(([, e]) => e.triggers.includes(trigger))
+    .map(([e]) => e);
 exports.getEnvTypesByTrigger = getEnvTypesByTrigger;
 exports.DEFAULT_ENVS = Object.keys(exports.ENV_TYPES);
 exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS;
-const isKnowEnvType = env => {
-  return env in exports.ENV_TYPES;
+const isKnowEnvType = (env) => {
+    return env in exports.ENV_TYPES;
 };
-exports.isKnowEnvType = isKnowEnvType;
+exports.isKnowEnvType = isKnowEnvType;
+//# sourceMappingURL=config.js.map