nex_design_system/config/project-profile.example.yaml

99 lines
3.1 KiB
YAML
Raw Blame History

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

# NEX 0.1.2 中性项目配置模板
# 复制到项目根目录为 nex.config.yaml,并根据真实代码/锁文件填写。
# 不要保留 SET_ME 占位值;不要从 reference-nexdocus-profile.example.yaml 盲目复制项目参数。
nex:
system: NEX Design System
version: 0.1.2
compliance: required
profile_mode: project-adaptive
project:
name: SET_ME
type: SET_ME
language: zh-CN
design_spec:
path: SET_ME # 例如 docs/UI规范.md;没有时写 none,并先审计现状
authority: project-level
status: needs-audit
frontend:
framework: SET_ME
framework_version: SET_ME
language: SET_ME # javascript-jsx / typescript 等,以项目事实为准
build_tool: SET_ME
ui_library: SET_ME # 没有则 none
ui_library_version: SET_ME
styling: SET_ME
router: SET_ME
state_management: SET_ME
theme:
modes: [] # 例如 [light, dark];按项目实际填写
switching: SET_ME
tokens:
source_of_truth: SET_ME # 具体文件/对象/平台;不能只写“统一管理”
naming_convention: existing-project-convention
derived_outputs: [] # CSS vars、组件库主题、Tailwind @theme 等
mapping_document: SET_ME
components:
shared_component_paths: []
form_component_paths: []
layout_component_paths: []
inventory_document: SET_ME
layout:
shell: SET_ME
header_height: project-defined
navigation_model: SET_ME
navigation_width: project-defined
breakpoints_source: SET_ME
page_patterns: [] # 只列项目真实存在的模式
backend:
framework: SET_ME
language: SET_ME
modification_scope: follow-task-authorization
database:
engine: SET_ME
modification_scope: follow-task-authorization
requirements:
# 优先复用项目已有、能力等价且经过验证的共享组件;不要求新建 NEX 同名组件。
use_shared_components: true
# 视觉值从项目既有权威 Token/主题来源读取;允许单一来源向多个消费层单向派生。
use_design_tokens: true
# UI 改造保留既有业务操作意图和用户路径;修复明确缺陷时做最小改动并回归。
maintain_existing_interactions: true
# 已验证的视觉/布局/交互模式优先保留,除非存在明确缺陷或用户批准改变。
preserve_verified_patterns: true
# 不因引入 NEX 而增加重复的 Token、主题或 UI 组件系统。
avoid_duplicate_design_system_layers: true
rules:
project_spec_precedence: true
reference_profiles_are_non_normative: true
no_forced_nex_token_prefix: true
preserve_existing_stack: true
no_unapproved_business_flow_changes: true
require_audit_before_broad_refactor: true
require_scope_approval_for_cross_page_changes: true
require_theme_review_when_supported: true
require_responsive_review: true
require_keyboard_review: true
require_drag_alternative_when_applicable: true
do_not_invent_quality_commands: true
quality:
commands: [] # 填写项目真实存在的命令,例如 dev/build/typecheck/preview
route_inventory: SET_ME
visual_baseline: SET_ME # 没有则写 none
regression_process: SET_ME