devconfig-gen 1.0.0__tar.gz

devconfig_gen-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!) The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 henryliu443
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

devconfig_gen-1.0.0/PKG-INFO

@@ -0,0 +1,456 @@
+Metadata-Version: 2.4
+Name: devconfig-gen
+Version: 1.0.0
+Summary: Provider-based developer configuration generation engine and CLI
+Author-email: henryliu443 <henryliu443@gmail.com>
+License-Expression: Apache-2.0
+Keywords: configuration,json,yaml,code-generation,cli
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: yaml
+Requires-Dist: PyYAML>=5.1; extra == "yaml"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: PyYAML>=5.1; extra == "dev"
+Dynamic: license-file
+
+# DevConfig-Gen
+
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+![Python 3.8+](https://img.shields.io/badge/python-3.8%2B-blue.svg)
+![Tests](https://img.shields.io/badge/tests-134%20passing-brightgreen.svg)
+![Platform](https://img.shields.io/badge/platform-Linux%20%7C%20macOS-lightgrey.svg)
+
+DevConfig-Gen 是一个开发者工具，用于从结构化输入数据和映射关系生成和校验结构化配置。它围绕一个轻量的 Provider 契约构建，使生成流水线独立于任何特定的配置格式或目标系统。多个输入文档可以在生成前进行合并和覆盖。
+
+A developer tool for generating and validating structured configuration from structured input data and mappings. Built around a small provider contract so the generation pipeline is independent of any particular configuration format or target system. Multiple input documents can be merged and overridden before generation.
+
+内置三个 Provider / Ships with three providers:
+
+- `custom` — 无 schema 的通用文档，任意 JSON/YAML 层级可增删清空 / schema-free generic document with arbitrary nesting you can add, remove, or clear;
+- `json` — 无依赖的透传/重新序列化 / dependency-free pass-through/re-serialization;
+- `env` — 将嵌套数据扁平化为 `UPPER_SNAKE_CASE` 的 `.env` 文件 / flattens nested data into an `UPPER_SNAKE_CASE` `.env` file.
+
+## 它是什么 / What it is
+
+DevConfig-Gen：
+
+- 加载结构化文档（JSON 或 YAML）/ loads a structured document (JSON or YAML);
+- 将其规范化为可预测的结构 / normalizes it into a predictable shape;
+- 校验并报告每个问题的精确字段路径 / validates and reports every problem with a precise field path;
+- 通过 Provider 生成结构化配置文档 / generates a structured configuration document through a provider;
+- 将结果写为 JSON 或 YAML / writes the result as JSON or YAML.
+
+刻意保持本地化且无副作用 / Deliberately local and side-effect free. 不会访问远程服务、安装包、管理系统状态 / Does not contact remote services, install packages, or manage system state.
+
+## 快速开始 / Quick start (3 minutes)
+
+```bash
+pip install devconfig-gen
+devconfig-gen generate \
+  --provider custom --input examples/custom.yaml --output-dir generated --format yaml
+devconfig-gen validate --provider custom --input examples/custom.yaml
+```
+
+想要引导式流程？运行终端向导或打开本地 Web 工作台 / Prefer a guided flow?
+
+```bash
+devconfig-gen init --provider custom   # 终端向导 / terminal wizard
+devconfig-gen ui                         # Web 工作台 / web studio
+```
+
+## 安装 / Installation
+
+从 PyPI 安装 / Install from PyPI:
+
+```bash
+pip install devconfig-gen
+```
+
+YAML 支持无需外部依赖 / YAML support works with **no external dependencies**.
+
+```bash
+pip install devconfig-gen[yaml]   # 可选：安装 PyYAML / optional: use PyYAML
+```
+
+开发模式 / Development (editable):
+
+```bash
+pip install -e ".[yaml]"
+```
+
+## 命令行 / CLI
+
+列出可用 Provider / List available providers:
+
+```bash
+devconfig-gen providers
+# custom / env / json
+```
+
+生成配置 / Generate configuration:
+
+```bash
+devconfig-gen generate \
+  --provider custom \
+  --input examples/custom.yaml \
+  --output-dir generated \
+  --format yaml
+```
+
+仅校验不写入 / Validate without writing:
+
+```bash
+devconfig-gen validate --provider custom --input examples/custom.yaml
+```
+
+校验失败时报告字段路径 / Validation failure reports field paths:
+
+```bash
+$ devconfig-gen validate --provider env --input broken.yaml
+invalid: variables must not be empty
+```
+
+结构化诊断输出 / Structured diagnostics:
+
+```bash
+devconfig-gen validate --provider env --input broken.yaml --json
+```
+
+查看 Provider Schema / Inspect provider schema:
+
+```bash
+devconfig-gen schema --provider custom
+```
+
+### 交互式终端向导 / Interactive Terminal Wizard
+
+适用于无头环境、SSH 会话 / For headless servers, SSH sessions:
+
+```bash
+devconfig-gen init --provider custom
+```
+
+向导按 `ProviderField.type` 提示每个字段，含默认值、类型校验、选项、边界检查 / Prompts every field by type with defaults, type validation, choices, bounds checking.
+
+```text
+========================================================
+  DevConfig-Gen Interactive Wizard: 'custom'
+  Answer the prompts below. Press Enter to use defaults.
+========================================================
+
+--- [1/1] Custom document ---
+  自由构建任意嵌套的 JSON/YAML 结构；任意层级都可增删或清空。
+? document (load document file or enter entries):
+    Path to JSON/YAML file (or press enter for key=value input): examples/custom.yaml
+    [✓] Loaded document from examples/custom.yaml
+
+Validating configuration...
+[✓] All validations passed!
+
+Select output format (1: YAML [default], 2: JSON): 1
+Writing configuration to '.'...
+[✓] Generated artifact: .../custom.yaml
+```
+
+### Web 可视化工作台 / Configuration Studio WebUI
+
+启动本地 Web 工作台 / Launch local web studio:
+
+```bash
+devconfig-gen ui
+devconfig-gen ui --workspace ~/projects/my-app   # 绑定项目目录 / bind to project dir
+```
+
+浏览器打开 `http://127.0.0.1:8848` / Opens at `http://127.0.0.1:8848`.
+
+特性 / Features:
+- 中英双语界面，一键切换，偏好本地保存 / Bilingual UI (中文/English) with one-click toggle and saved preference;
+- Apple 原生排版，亮色/暗色主题 / Apple-native typography, light/dark theme;
+- 分步表单向导，内联校验 / Step-by-step wizard with inline validation;
+- `custom` Provider 递归树编辑器：任意层级增删字段/项、切换类型、逐层清空 / recursive tree editor for the `custom` provider: add/remove fields or items at any depth, switch types, clear per node;
+- `json` Provider 文档上传与内联编辑器（拖拽 `.json`/`.yaml` 反向解析）/ document drop-zone and inline editor for the `json` provider (drag `.json`/`.yaml` to backfill);
+- 顶部「全部清空」一键重置当前 Provider 内容 / header "Clear All" resets the current provider;
+- 双栏实时预览 / Dual-pane live preview;
+- 模板预设、文件上传、草稿保存、磁盘导出 / Template presets, file upload, auto-save, disk export;
+- 输出格式开关（YAML/JSON，XML 及未来格式已预留）/ output format switch (YAML/JSON; XML and future formats reserved);
+- 零外部依赖 / Zero external build dependencies.
+
+Provider 的步骤与字段元数据自带 `i18n` 翻译（内置 Provider 已提供中文）/ Provider step and field metadata carry optional `i18n` translations (the built-in providers ship Chinese).
+
+仅绑定本地回环 / Binds to loopback only. 磁盘导出沙箱限制在工作空间内 / Disk export sandboxed to workspace root.
+
+退出码 / Exit codes: `0` 成功/success, `1` 校验失败/validation failure, `2` 输入错误/input error.
+
+### 多源合并与覆盖 / Multi-source input and overrides
+
+`--input` 可重复，文档从左到右深度合并 / `--input` may be repeated, deep-merged left to right:
+
+```bash
+devconfig-gen generate \
+  --provider custom \
+  --input configs/base.yaml \
+  --input configs/prod.json \
+  --set app.port=9090 \
+  --set app.environment=production \
+  --output-dir dist --format yaml
+```
+
+`--set` 值自动解析 JSON 类型 / `--set` values parsed as JSON when possible (`true`→bool, `42`→int, `null`→null).
+
+### 生成任意结构的自定义文档 / Generating an arbitrary custom document
+
+`custom` Provider 不限定 schema，任意 JSON/YAML 层级都能生成 / The `custom` provider imposes no schema; any JSON/YAML nesting is generated as-is:
+
+```bash
+devconfig-gen generate --provider custom --input configs/anything.yaml --output-dir dist --format yaml
+```
+
+```python
+from devconfig_gen import GenerationRequest, generate
+
+result = generate(
+    "custom",
+    GenerationRequest(
+        context={"document": {"app": {"name": "web", "limits": {"cpu": "500m"}}}},
+        options={"format": "yaml"},
+    ),
+)
+```
+
+在 Web 工作台中选择 `custom`，它提供两种编辑模式 / In the studio, `custom` offers two editing modes:
+
+- **结构模式**：递归树编辑器，任意层级增删字段/项、切换类型（string/number/boolean/object/array/null）、逐层清空 / **Tree mode**: a recursive editor to add/remove fields or items at any depth, switch types, and clear per node;
+- **文本模式**：直接输入 JSON/YAML，支持列表 `[1,2,3,4,5]`、嵌套 `{"1":{"2":{}}}`、YAML 缩进与 `0: [1,2,3,4,5]` 等任意混合 / **Text mode**: type JSON/YAML directly — lists `[1,2,3,4,5]`, nesting `{"1":{"2":{}}}`, YAML indentation, and `0: [1,2,3,4,5]`, freely mixed.
+
+顶层可以是映射、列表或标量 / The root may be a mapping, a list, or a scalar.
+
+顶部「全部清空」一键重置 / The header "Clear All" resets the current provider.
+
+### 生成 .env 文件 / Generating a .env file
+
+```bash
+devconfig-gen generate --provider env --input examples/vars.yaml --output-dir dist
+# generated dist/.env
+```
+
+```env
+DATABASE_HOST=localhost
+DATABASE_PORT=5432
+DATABASE_NAME=appdb
+DEBUG=true
+LOG_LEVEL=info
+```
+
+## Python API
+
+```python
+from devconfig_gen import GenerationRequest, generate, generate_from_file
+
+# 内存上下文 / In-memory context
+result = generate(
+    "custom",
+    GenerationRequest(
+        context={"document": {"app": {"name": "checkout-api", "port": 8080}}},
+        options={"format": "yaml"},
+    ),
+)
+artifact = result.artifacts[0]
+print(artifact.name, artifact.media_type)   # custom.yaml application/yaml
+
+# 文件到文件，与 CLI 相同流水线 / File to file, same pipeline as CLI
+generate_from_file(
+    "custom",
+    "examples/custom.yaml",
+    output_dir="generated",
+    output_format="yaml",
+)
+```
+
+直接加载和序列化 / Load and serialize directly:
+
+```python
+from devconfig_gen import load_file, loads, dumps
+
+data = load_file("examples/custom.yaml")
+text = dumps(data, "json")
+```
+
+结构化诊断与 Schema 元数据 / Diagnostics and schema metadata:
+
+```python
+from devconfig_gen import diagnose_request, describe_provider
+
+for d in diagnose_request("env", context={}):
+    print(d.field, "->", d.message, f"({d.severity})")
+
+for step in describe_provider("custom"):
+    print(step.id, step.title, [f.name for f in step.fields])
+```
+
+## 示例输入 / Example input
+
+`examples/custom.yaml`:
+
+```yaml
+app:
+  name: checkout-api
+  version: "2.4.0"
+  port: 8080
+  environment: production
+  replicas: 3
+  labels:
+    team: payments
+    tier: backend
+  health_check:
+    path: /healthz
+    interval_seconds: 15
+    timeout_seconds: 5
+```
+
+`examples/custom.json` 是等效 JSON 文档 / is the equivalent JSON document.
+
+## JSON/YAML 支持与限制 / Support and limitations
+
+JSON 由标准库处理 / JSON handled by standard library. YAML 在安装 PyYAML 时使用，否则用内置解析器 / YAML uses PyYAML when available, otherwise bundled parser.
+
+支持 / Supported:
+- 缩进嵌套的映射和序列 / mappings and sequences by indentation;
+- 标量：字符串、整数、浮点、布尔、`null` / scalars: strings, integers, floats, booleans, `null`;
+- 引号字符串和裸字符串 / quoted and plain strings;
+- 流式集合 `[a, b]` `{x: 1}` / flow collections;
+- 注释和空行 / comments and blank lines;
+- 块标量 `|` `>` 及 `-`/`+` 修剪 / block scalars with chomping.
+
+不支持 / Not supported:
+- 锚点别名 `&`/`*`、自定义标签 `!tag`、合并键 `<<` / anchors, aliases, tags, merge keys;
+- 多文档 `---` / multiple documents;
+- 块标 scalar 内注释可能丢失 / comments inside block scalars may be dropped.
+
+需要完整 YAML 行为请安装 PyYAML / For full YAML, install PyYAML.
+
+`env` Provider 渲染纯文本 `.env`（`media_type: text/plain`）/ renders plain-text `.env`.
+
+## 架构与数据流 / Architecture and data flow
+
+```text
+输入文件 / 上下文 (input file / context)
+        |
+        v
+  formats.load_*        JSON/YAML 解析 + 格式检测
+        |
+        v
+  Provider.diagnose     规范化 + 结构化诊断
+        |
+        v
+  Provider.generate     结构化配置文档
+        |
+        v
+  engine.generate       产物序列化 + 可选持久化
+        |
+        v
+   JSON / YAML 输出
+```
+
+CLI、Python API、向导、工作台调用相同的 engine 函数 / CLI, API, wizard, and studio all call the same engine functions. CLI 本身不含生成逻辑 / CLI contains no generation logic of its own.
+
+核心模块 / Key modules:
+
+| 模块 / Module | 职责 / Responsibility |
+| --- | --- |
+| `formats` | JSON/YAML 加载导出、格式检测、媒体类型 |
+| `validation` | 路径感知校验辅助工具 / path-aware validation helpers |
+| `models` | 请求、产物、诊断、字段、步骤、Provider 协议 |
+| `registry` | ProviderRegistry 及内置 Provider |
+| `engine` | 编排、诊断、Schema、持久化 / orchestration, diagnostics, persistence |
+| `providers` | `custom`、`json`、`env` Provider |
+| `interactive` | `init` 终端向导（延迟加载）/ terminal wizard (lazy-loaded) |
+| `web_ui` | `ui` 本地工作台（延迟加载）/ local studio (lazy-loaded) |
+| `cli` | 仅参数解析 / argument parsing only |
+
+## 编写自定义 Provider / Writing a custom provider (5 minutes)
+
+实现 `ConfigProvider` 协议 / Implement the `ConfigProvider` protocol. 只需 `name`、`validate`、`generate` 必需 / Only `name`, `validate`, `generate` required.
+
+```python
+from devconfig_gen import (
+    Diagnostic, GeneratedArtifact, GenerationResult,
+    ProviderField, ProviderStep, ValidationError,
+)
+
+class GreetingProvider:
+    name = "greeting"
+    steps = (
+        ProviderStep(
+            id="input",
+            title="Greeting input",
+            i18n={"zh": {"title": "问候输入", "description": "输入要问候的对象。"}},
+            fields=(
+                ProviderField(
+                    "who",
+                    type="string",
+                    required=True,
+                    title="Who",
+                    description="Who to greet.",
+                    i18n={"zh": {"title": "对象", "description": "要问候的对象。"}},
+                ),
+            ),
+        ),
+    )
+
+    def describe_schema(self):
+        return self.steps
+
+    def diagnose(self, request):
+        if not request.context.get("who"):
+            return (Diagnostic("who", "missing required field: 'who'"),)
+        return ()
+
+    def validate(self, request):
+        return tuple(item.message for item in self.diagnose(request))
+
+    def generate(self, request):
+        diagnostics = self.diagnose(request)
+        if diagnostics:
+            raise ValidationError(diagnostics)
+        return GenerationResult(
+            provider=self.name,
+            artifacts=(
+                GeneratedArtifact(
+                    name="greeting.json",
+                    content={"message": f"hello {request.context['who']}"},
+                    media_type="application/json",
+                ),
+            ),
+        )
+```
+
+注册并运行 / Register and run:
+
+```python
+from devconfig_gen import GenerationRequest, ProviderRegistry, generate
+from devconfig_gen.providers import CustomProvider, JsonProvider
+
+registry = ProviderRegistry((CustomProvider(), JsonProvider(), GreetingProvider()))
+result = generate("greeting", GenerationRequest(context={"who": "world"}), registry=registry)
+```
+
+`GeneratedArtifact.content` 可以是数据结构或预渲染字符串 / may be a data structure or pre-rendered string.
+
+## 开发与测试 / Development and testing
+
+```bash
+python -m unittest discover -s tests -v
+# 或无需安装 / or without installing:
+PYTHONPATH=src python3 -m unittest discover -s tests -v
+```
+
+测试覆盖格式解析、校验、Provider、多源合并、CLI/API 等价性、向导、WebUI / Covers format parsing, validation, providers, merging, CLI/API parity, wizard, WebUI.
+
+## 许可证 / License
+
+Apache-2.0. 详见 `LICENSE` / See `LICENSE`.