defineConfig

Defines configuration for Rempts CLI projects. Used in dler.config.ts files.

Syntax

function defineConfig(config: RemptsConfig): RemptsConfig

Parameters

config

The configuration object for your CLI project.

interface RemptsConfig {
  // Basic metadata
  name?: string
  version?: string
  description?: string
  
  // Command configuration
  commands?: {
    manifest?: string
    directory?: string
  }
  
  // Build configuration
  build?: {
    entry?: string | string[]
    outdir?: string
    targets?: string[]
    compress?: boolean
    external?: string[]
    minify?: boolean
    sourcemap?: boolean
  }
  
  // Development configuration
  dev?: {
    watch?: boolean
    inspect?: boolean
    port?: number
  }
  
  // Code generation configuration
  codegen?: {
    enabled?: boolean
    cmdsDir?: string
    output?: string
    watch?: boolean
  }
  
  // Test configuration
  test?: {
    pattern?: string | string[]
    coverage?: boolean
    watch?: boolean
  }
  
  // Release configuration
  release?: {
    npm?: boolean
    github?: boolean
    tagFormat?: string
    conventionalCommits?: boolean
  }
  
  // Workspace configuration
  workspace?: {
    packages?: string[]
    shared?: any
    versionStrategy?: 'fixed' | 'independent'
  }
}

Examples

Basic Configuration

// dler.config.ts
import { defineConfig } from '@reliverse/rempts-core'

export default defineConfig({
  name: 'my-cli',
  version: '1.0.0',
  description: 'My awesome CLI tool'
})

With Build Settings

export default defineConfig({
  name: 'my-cli',
  version: '1.0.0',
  build: {
    entry: './src/cli.ts',
    outdir: './dist',
    minify: true,
    compress: true,
    targets: ['darwin-arm64', 'linux-x64', 'windows-x64']
  }
})

With Command Manifest

export default defineConfig({
  name: 'my-cli',
  version: '1.0.0',
  commands: {
    manifest: './src/commands/index.ts'
  }
})

Development Configuration

export default defineConfig({
  name: 'my-cli',
  version: '1.0.0',
  dev: {
    watch: true,
    inspect: true,
    port: 9229
  },
  test: {
    pattern: ['**/*.test.ts', '**/*.spec.ts'],
    coverage: true
  }
})

With Code Generation

export default defineConfig({
  name: 'my-cli',
  version: '1.0.0',
  build: {
    entry: './src/cli.ts',
    outdir: './dist'
  }
})

Workspace Configuration

export default defineConfig({
  name: 'my-monorepo',
  workspace: {
    packages: ['packages/*'],
    versionStrategy: 'independent',
    shared: {
      // Shared config for all packages
      build: {
        minify: true,
        sourcemap: false
      }
    }
  }
})

Configuration Options

Basic Metadata

name - CLI name (defaults to package.json name)
version - CLI version (defaults to package.json version)
description - CLI description

commands

Configure command loading:

manifest - Path to command manifest file for lazy loading
directory - Directory to auto-discover commands (not recommended for production)

Example manifest:

// src/commands/index.ts
export default {
  build: () => import('./build.js'),
  test: () => import('./test.js'),
  deploy: () => import('./deploy.js')
}

build

Configure production builds:

entry - Entry file(s) to build
outdir - Output directory (default: ./dist)
targets - Platform targets for multi-platform builds
compress - Compress builds with tar.gz
external - Packages to exclude from bundle
minify - Minify output (default: true)
sourcemap - Generate sourcemaps

dev

Configure development mode:

watch - Enable file watching (default: true)
inspect - Enable debugger
port - Debugger port (default: 9229)

test

Configure testing:

pattern - Test file patterns
coverage - Generate coverage reports
watch - Watch mode for tests

release

Configure releases (planned feature):

npm - Publish to npm
github - Create GitHub releases
tagFormat - Git tag format
conventionalCommits - Use conventional commits

workspace

Configure monorepo workspaces:

packages - Glob patterns for workspace packages
shared - Configuration shared by all packages
versionStrategy - How to version packages

Usage with Rempts CLI

The configuration is automatically loaded by the rempts CLI:

# Uses build.entry from config
rempts build

# Uses dev settings from config
rempts dev

# Uses test.pattern from config
rempts test

Command-line flags override config values:

# Overrides build.minify
rempts build --no-minify

# Overrides dev.port
rempts dev --port 3000

Loading Config

The rempts CLI looks for config files in this order:

dler.config.ts
dler.config.js
dler.config.mjs

You can also load config programmatically:

import { loadConfig } from '@reliverse/rempts-core'

const config = await loadConfig()

Automatic Loading: In most cases, you don't need to manually load config. createCLI() automatically loads from dler.config.ts when called without arguments.

Use defineConfig for better TypeScript support. It provides type checking and autocompletion for all configuration options.

Best Practices

Keep config minimal - Only configure what differs from defaults
Use TypeScript - dler.config.ts provides best type safety
Share workspace config - Use workspace.shared for common settings
Externalize native deps - Add binary dependencies to build.external
Enable compression - Use compress: true for distribution builds

defineConfig

defineConfig

Syntax

Parameters

config

Examples

Basic Configuration

With Build Settings

With Command Manifest

Development Configuration

With Code Generation

Workspace Configuration

Configuration Options

Basic Metadata

commands

build

dev

test

release

workspace

Usage with Rempts CLI

Loading Config

Best Practices

See Also

On this page