Configuration

Example

The following is the full example of kosko.toml. Config files must be written in TOML. All properties are optional.

# Global configs
require = ["a"]
components = ["b"]
extensions = ["js", "json"]
baseEnvironment = "c"

# Environment configs
[environments.dev]
require = ["c"]
components = ["d"]

[environments.prod]
require = ["e"]
components = ["f"]

[paths.environment]
global = "environments/#{environment}"
component = "environments/#{environment}/#{component}"

Global Configs

Global configs are always applied.

require

Require external modules.

# Using TypeScript
require = ["ts-node/register"]

components

Components to generate. It can be either a component's name or a glob pattern.

# Generate all components in components folder
components = ["*"]

# Generate components with specified names
components = ["foo", "bar"]

# Generate components matched to the glob pattern
components = ["nginx_*"]

# Ignore components
components = ["!foo", "!bar"]

extensions

Extension names of components. You don't have to set this option. It's detected automatically from require.extensions.

baseEnvironment

Specify the base environment. You may define default or common variables in the base environment. The base environment can be used with or without --env/e option. When --env/-e option is set, variables in the base environment are overridden by the specified environment.

Environment Configs

Environment configs are applied when you run kosko generate with --env/-e option. Environment configs are merged with global configs.

# Applied when env = "dev"
[environments.dev]
require = ["c"]
components = ["d"]

# Applied when env = "prod"
[environments.prod]
require = ["e"]
components = ["f"]

Paths

paths.environment.global

Specify path to global environment files.

paths.environment.component

Specify path to component environment files.