Skip to content

NPM version Downloads

@commerce-klaus/config

Shared project configuration for Commerce Klaus tools.

Installation

bash
vp install -D @commerce-klaus/config
bash
pnpm add -D @commerce-klaus/config
bash
yarn add -D @commerce-klaus/config
bash
npm install -D @commerce-klaus/config

Usage

commerce-klaus.config.ts
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

Released under the MIT License.