@snailicid3/build-config
v0.2.0
Published
Typed tsdown, Vite and Vitest config factories with a shared build-plan model
Maintainers
Readme
@snailicid3/build-config 🐌
Provides reusable build plans and config factories for tsdown, Vite, and Vitest.
Repository
- GitHub:
@snailicid3/build-config•snailicid3 - Documentation: ARCHITECTURE.md
Author
👤 Gillian Tunney
Recommended package manager: pnpm
@snailicid3/build-config 🐌
This package is a small config factory. You describe a package or its entry points once, and the factories return ordinary tsdown, Vite and Vitest configuration objects that each tool accepts directly. Native options remain available as overrides, so the wrappers add typing and shared defaults rather than hiding the tools behind an exhaustive schema.
The factories return configuration and nothing else. They do not run builds, start servers, rewrite
package.json, or make network calls — tool CLIs and Nx targets perform execution.
Building does not validate the package. Publint, ATTW and unused-dependency scanning are package validation and belong to Doctor, which runs them explicitly against source or packed artifacts. A build that emits correct artifacts should not fail for a reason the build did not cause.
See ARCHITECTURE.md for the full design specification.
Focused subpaths
Import one adapter without loading the others:
import { defineTsdownConfig, toTsdownConfigs } from '@snailicid3/build-config/tsdown'
import { toViteConfig } from '@snailicid3/build-config/vite'
import { vitest } from '@snailicid3/build-config/vitest'
import { defineBuildPlan } from '@snailicid3/build-config/plan'
import { createBanner } from '@snailicid3/build-config/banner'The root entry still re-exports the common factories for existing consumers.
vitest is an optional peer dependency: it is only needed when you import the Vitest subpath.
@snailicid3/build-config contains:
Build Adapters
- tsdown • Primary bundler for TypeScript libraries (ESM + CJS)
- vite • Web app and browser library bundler
Vitest Configuration
- vitest • Shared vitest configuration with coverage
Banner and plan helpers
- Banner generation from
packageIdentitySchema, and pure build-plan/export-plan derivation
Installation
pnpm add --save-dev @snailicid3/build-configExamples
tsdown Config
/* @file tsdown.config.ts */
import { defineBuildPlan, toTsdownConfigs } from '@snailicid3/build-config'
import { defineConfig } from 'tsdown'
import pkg from './package.json' with { type: 'json' }
const plan = defineBuildPlan(pkg, {
entries: [
{
banner: true,
exports: true,
key: '*',
output_formats: ['esm', 'cjs', 'ts'],
runtime: 'node',
},
],
root: {
outputDir: './dist',
sourceDir: './src',
},
})
export default defineConfig(toTsdownConfigs(plan))Vitest Config
/* @file vitest.config.ts */
import { vitest } from '@snailicid3/build-config/vitest'
export default vitest.config()Deriving package.json exports from a build plan
import { defineBuildPlan, toPackageExportsPlan } from '@snailicid3/build-config'
import pkg from './package.json' with { type: 'json' }
const plan = defineBuildPlan(pkg, {
entries: [
{
exports: true,
key: '*',
output_formats: ['esm', 'cjs', 'ts'],
},
],
})
console.log(toPackageExportsPlan(plan))
// {
// '.': {
// types: './dist/index.d.ts',
// import: './dist/index.js',
// require: './dist/index.cjs',
// default: './dist/index.js'
// }
// }Vite Config
Todo
