@santana-org/config

Lightweight config file discovery and loading for Santana Org CLIs.

Walks up from cwd looking for config in the standard places, in order:

1. package.json — field matching the tool name
2. .toolrc — JSON or JSONC
3. .toolrc.json / .toolrc.jsonc
4. tool.config.json
5. tool.config.js / .mjs / .ts — default export

Install

npm install @santana-org/config

Usage

import { loadConfig, loadConfigOrThrow, defineConfig } from "@santana-org/config"

// finds config for "mytool" walking up from cwd
const result = await loadConfig({ name: "mytool" })
if (result) {
  console.log(result.config)   // the parsed config object
  console.log(result.filepath) // where it was found
  console.log(result.source)   // "package.json" | "rc" | "json" | "js" | "ts"
}

// throws if no config found
const { config } = await loadConfigOrThrow({
  name: "mytool",
  defaults: { port: 3000, debug: false },
})

TypeScript config files

Users can write mytool.config.ts:

import { defineConfig } from "@santana-org/config"

export default defineConfig({
  port: 4000,
  debug: true,
})

defineConfig is a no-op identity function that gives TypeScript autocompletion when paired with a generic type:

// mytool.config.ts
import { defineConfig } from "@santana-org/config"
import type { MyToolConfig } from "mytool"

export default defineConfig<MyToolConfig>({ port: 4000 })