@commerce-klaus/config

Shared project configuration for Commerce Klaus tools.

Installation

pnpm

pnpm add -D @commerce-klaus/config

npm

npm install -D @commerce-klaus/config

Yarn

yarn add -D @commerce-klaus/config

Vite+

vp install -D @commerce-klaus/config

Usage

commerce-klaus.config.ts

import { defineConfig } from "@commerce-klaus/config"

export default defineConfig({
  cartridgesDir: "cartridges",
  solutionConfigPath: "cartridges/jsconfig.json",
  siteTemplatePath: "sites/site_template",
  site: "RefArch",
})

See the project configuration guide for option precedence and all supported fields.

API

• defineConfig(config): CommerceKlausConfig
• findCommerceKlausConfig(startDirectory?): string | undefined
• loadCommerceKlausConfig(options?): LoadedCommerceKlausConfig
• resolveCommerceKlausConfig(options?): CommerceKlausConfig
• normalizeCartridgeArchitectureAssignments(assignments)
  • Normalizes names and rejects unknown roles or cartridges assigned to multiple roles.
• filterCartridgePathByArchitecture(cartridgePath, assignments, selection): string[]
  • Selects architecture-assigned, explicitly included, or optionally unassigned cartridges.
  • Preserves the original cartridge-path order exactly.