跳到正文
cccskills
免费在 GitHub 公开

config-scaffolding

Scaffolds the config component for centralized configuration management, driven by component settings.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(10)

  • SKILL.md7.7 KB
  • schemas/input.schema.json1.1 KB
  • schemas/output.schema.json1.4 KB
  • templates/envs/default/config.yaml294 B
  • templates/envs/local/config.yaml155 B
  • templates/package.json235 B
  • templates/schemas/config.schema.json456 B
  • templates/tsconfig.json325 B
  • templates/types/index.ts377 B
  • templates/types/server.ts401 B

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Config Scaffolding Skill

Scaffolds the mandatory config component for centralized configuration management. Config sections are generated based on component settings from sdd/sdd-settings.yaml. Delegate to the techpack-settings skill for the authoritative config schema — it accepts a component type (config) and returns the settings object including referenced components and environment variable mappings.

When to Use

Use during project initialization to create the config component. The config component is mandatory — every SDD project has exactly one.

What It Creates

components/config/
├── package.json                # Minimal package for workspace imports
├── tsconfig.json               # TypeScript config for type exports
├── envs/
│   ├── default/
│   │   └── config.yaml         # Base config (sections per component)
│   └── local/
│       └── config.yaml         # Local overrides (empty)
├── schemas/
│   └── config.schema.json      # Main schema (minimal)
└── types/
    └── index.ts                # Re-exports config types

Settings-Driven Config Generation

Config sections are generated based on component settings in sdd/sdd-settings.yaml:

Server Config Sections

API Server with database:

# Settings:
- name: main-server
  type: server
  settings:
    server_type: api
    databases: [primary-db]
    provides_contracts: [public-api]

# Generated config:
main-server:
  port: 3000                    # Business API port (has provides_contracts)
  probesPort: 9090              # Health/metrics port (always)
  logLevel: info                # Logging level (always)
  databases:
    primary-db:                 # Section per database
      host: localhost
      port: 5432
      name: myapp
      ssl: false

Worker without database:

# Settings:
- name: background-worker
  type: server
  settings:
    server_type: worker
    databases: []
    consumes_contracts: [public-api]

# Generated config:
background-worker:
  probesPort: 9090              # Health/metrics port (always)
  logLevel: info                # Logging level (always)
  queue:                        # Queue config for worker
    url: amqp://localhost:5672
  apis:
    public-api:                 # Section per consumed contract
      base_url: http://main-server:3000

Hybrid server (api + worker):

# Settings:
- name: main-server
  type: server
  settings:
    server_type: hybrid
    modes: [api, worker]
    databases: [primary-db]
    provides_contracts: [public-api]

# Generated config:
main-server:
  port: 3000                    # Business API port (has provides_contracts)
  probesPort: 9090              # Health/metrics port (always)
  logLevel: info                # Logging level (always)
  databases:
    primary-db:
      host: localhost
      port: 5432
      name: myapp
      ssl: false
  queue:                        # Queue config (has worker mode)
    url: amqp://localhost:5672

Webapp Config Sections

# Settings:
- name: admin-dashboard
  type: webapp
  settings:
    contracts: [public-api]

# Generated config:
admin-dashboard:
  apis:
    public-api:                 # Section per consumed contract
      base_url: http://localhost:3000

Config Section Rules

SettingConfig Impact
server_type: apiAdds port: 3000 (business API)
server_type: workerAdds queue: { url: ... }
server_type: cronAdds schedule: {} placeholder
provides_contracts: [...]Adds port: 3000 (business API)
consumes_contracts: [...]Adds apis: { <name>: { base_url: ... } } per contract
databases: [...]Adds databases: { <name>: { host, port, name, ssl } } per database
contracts: [...] (webapp)Adds apis: { <name>: { base_url: ... } } per contract

All Servers Get

  • probesPort: 9090 - Health check and metrics endpoint
  • logLevel: info - Logging level

Config Component Purpose

The config component is a minimal TypeScript project with no runtime code. It exists so:

  1. Other components can import types via workspace package @{project}/config/types
  2. YAML files are the source of truth for configuration values
  3. The system CLI (via /sdd I want to generate config) generates merged configs for each environment

Environment Structure

Each environment has its own directory under envs/:

DirectoryPurpose
envs/default/Base configuration - all environments inherit from this
envs/local/Local development overrides (always present)
envs/{env}/Other environments added as needed (staging, production, etc.)

Merge order: envs/default/ → envs/{env}/

Template Variables

VariableDescription
{{PROJECT_NAME}}Project name (lowercase, hyphens)

Templates Location

All templates are colocated in this skill's templates/ directory:

skills/components/config/config-scaffolding/templates/
├── package.json
├── tsconfig.json
├── envs/
│   ├── default/
│   │   └── config.yaml
│   └── local/
│       └── config.yaml
├── schemas/
│   └── config.schema.json
└── types/
    └── index.ts

Sync Behavior

When settings change (via /sdd with natural language about settings), the config component is automatically synced:

  1. New component added → Config section added with defaults
  2. Database added to server → Database subsection added
  3. Contract added to consumes_contracts → API subsection added
  4. Existing sections → Never modified or deleted (preserves user changes)

Scaffold Spec

The config component uses the engine for base template structure, but config section generation is dynamic (computed from component settings by the skill).

Base structure via engine

<plugin-root>/fullstack-typescript/system/system-run.sh scaffolding apply --spec spec.json
{
  "target_dir": "<project-root>",
  "base_dir": "<plugin-root>/skills",
  "variables": { "PROJECT_NAME": "<project-name>" },
  "operations": [
    {
      "type": "template_dir",
      "source": "components/config/config-scaffolding/templates",
      "dest": "components/config"
    }
  ]
}

Dynamic config sections (skill computes content)

For each component, the skill computes the YAML config section content and writes it via write_file with if_exists: "skip" (additive only — never clobber existing sections). The skill builds the YAML content itself, then passes it to the engine.

{
  "type": "write_file",
  "path": "components/config/envs/default/config.yaml",
  "content": "<computed-yaml-content>",
  "if_exists": "overwrite"
}

Split: Use the engine for the component directory structure. Compute config sections yourself (from component settings) and write them via write_file.

Input

Schema: schemas/input.schema.json

Accepts the full list of project components whose settings drive dynamic config section generation.

Output

Schema: schemas/output.schema.json

Returns the scaffolding engine result: created files, directories, and scripts; skipped paths; errors; and a human-readable summary.

Related Skills

  • config-standards — Generated config files must follow these standards. Defines naming conventions, validation patterns, environment-specific overrides, and TypeScript type generation rules.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Standards for authoring SDD plugin agents — frontmatter, self-containment, skill references, and no-user-interaction rules.

中文简介正在准备中。当前显示原文说明。

LiorCohen/sdd432026年2月24日 更新

Scaffolds Node.js/TypeScript backend components with CMDO architecture, driven by component settings.

中文简介正在准备中。当前显示原文说明。

LiorCohen/sdd432026年2月24日 更新

CMDO architecture standards for Node.js/TypeScript backends with strict layer separation.

中文简介正在准备中。当前显示原文说明。

LiorCohen/sdd432026年2月24日 更新

Intent-to-command mappings for fullstack-typescript tech pack features.

中文简介正在准备中。当前显示原文说明。

LiorCohen/sdd432026年2月24日 更新

Create change specification and implementation plan with dynamic phase generation. Supports feature, bugfix, refactor, and epic types.

中文简介正在准备中。当前显示原文说明。

LiorCohen/sdd432026年2月24日 更新

Orchestrates the full change lifecycle — routes actions to phase-specific sub-files.

中文简介正在准备中。当前显示原文说明。

LiorCohen/sdd432026年2月24日 更新

查看 LiorCohen 的全部技能

报告此技能的问题