Skip to content

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

DesignSystem-Pro-Max

设计系统 CLI 工具 / Design System CLI Tool

跨多个 UI 框架搜索设计规范、生成符合规范的代码并审计合规性
Search design specifications, generate compliant code, and audit compliance across multiple UI frameworks

Features • Installation • Usage • Stacks • Contributing • License


术语对照表 / Terminology

English 中文 说明 / Notes
Skill 技能 / Skill Claude Code 的技能单元
Workflow 工作流 Windsurf 的自动化流程
Tech Stack 技术栈 UI 框架技术栈
UI Style UI 风格 界面设计风格
Color Palette 配色方案 颜色系统
Font Pairing 字体组合 字体搭配规范
UX Guideline UX 准则 用户体验指导原则
Accessibility 无障碍 a11y 辅助功能
Responsive 响应式 移动端适配
CLI Tool 命令行工具 Command Line Interface
Manual Installation 手动安装 非自动化的安装方式
Slash Command 斜杠命令 Cursor 的快捷命令

Features / 功能

  • 🔍 Search / 搜索 - Search design specifications (components, colors, typography, tokens) / 搜索设计规范(组件、颜色、排版、令牌)
  • 🎨 Generate / 生成 - Generate compliant CSS code / 生成符合规范的 CSS 代码
  • ✅ Audit / 审计 - Audit code for compliance violations with fix suggestions / 审计代码合规性并提供修复建议
  • 🌐 Multi-Stack / 多技术栈 - Support for AntD, Material-UI, Figma, Bootstrap, Tailwind, Chakra, Elements / 支持多种 UI 框架
  • 🔌 AI Assistant Integration / AI 助手集成 - Claude Code, Cursor, Windsurf, GitHub Copilot

Installation / 安装

Via CLI / 通过命令行 (Recommended / 推荐)

npm install -g ds-pro-max
ds-pro-max init --ai claude

Manual / 手动安装

git clone https://github.com/kyirexy/DesignSystem-Pro-Max-skill.git
cd DesignSystem-Pro-Max-skill
pip install -r requirements.txt

Usage / 使用

CLI Commands / CLI 命令

# Search design specs / 搜索设计规范
ds-pro-max search "AntD primary button" --stack react-antd

# Generate compliant CSS / 生成符合规范的 CSS
ds-pro-max generate "Figma color tokens" --stack figma-tokens --output tokens.css

# Audit code / 审计代码
ds-pro-max audit styles.css --stack tailwind

Python API / Python 接口

from .claude.skills.ds-pro-max.scripts.core import search

result = search("primary button", domain="component", max_results=3)
print(result)

AI Assistant Integration / AI 助手集成

When using Claude Code, Cursor, or Windsurf, simply describe what you need:
使用 Claude Code、Cursor 或 Windsurf 时,只需描述您的需求:

"Create a primary button using Ant Design"
"使用 Ant Design 创建一个主按钮"

The AI will automatically search the design system specs and generate compliant code.
AI 会自动搜索设计系统规范并生成符合规范的代码。


Supported Stacks / 支持的技术栈

Stack / 技术栈 Framework / 框架 Docs / 文档
react-antd Ant Design https://ant.design
material-ui Material-UI https://mui.com
figma-tokens Figma Tokens https://figma.com
bootstrap Bootstrap https://getbootstrap.com
tailwind Tailwind CSS https://tailwindcss.com
chakra Chakra UI https://chakra-ui.com
elements Adobe Elements https://adobe.com

Available Domains / 可用领域

Domain / 领域 Use For / 用途 Example Keywords / 示例关键词
component UI component specs / UI 组件规范 button, input, modal, table
color Color tokens / 颜色令牌 primary, success, warning, error
typography Font specs / 字体规范 heading, body, font-size
spacing Spacing tokens / 间距令牌 padding, margin, gap
tokens Design tokens / 设计令牌 design token, CSS variable

Development / 开发

Setup / 设置

# Install dev dependencies / 安装开发依赖
pip install -r requirements-dev.txt

# Install CLI dependencies / 安装 CLI 依赖
cd cli
npm install

Running Tests / 运行测试

# Run all tests / 运行所有测试
pytest tests/ -v

# Run with coverage / 运行测试并生成覆盖率报告
pytest tests/ --cov=.claude/skills/ds-pro-max/scripts --cov-report=html

Building CLI / 构建 CLI

cd cli
npm run build

Architecture / 架构

DesignSystem-Pro-Max-skill/
├── .claude/skills/ds-pro-max/    # Claude Code skill / 技能
│   ├── scripts/
│   │   ├── core.py               # BM25 search engine / 搜索引擎
│   │   ├── search.py             # Search CLI / 搜索命令
│   │   ├── generate.py           # Generate CLI / 生成命令
│   │   └── audit.py              # Audit CLI / 审计命令
│   └── data/                     # CSV knowledge base / CSV 知识库
│       ├── components.csv
│       ├── colors.csv
│       └── stacks/               # Stack-specific guidelines / 技术栈规范
├── cli/                          # NPM CLI package / NPM CLI 包
└── tests/                        # Test suite / 测试套件

Star History / 星标历史

Star History Chart / 星标历史图表


Contributing / 贡献

Contributions are welcome! / 欢迎贡献!

We accept contributions via pull requests. Please follow these guidelines:
我们通过 Pull Request 接受贡献。请遵循以下准则:

How to Contribute / 如何贡献

  1. Fork the repository / Fork 本仓库
  2. Create a feature branch / 创建功能分支: git checkout -b feat/amazing-feature
  3. Commit your changes / 提交更改: git commit -m 'Add amazing feature'
  4. Push to the branch / 推送到分支: git push origin feat/amazing-feature
  5. Open a Pull Request / 开启 Pull Request

Guidelines / 准则

  • Write clear commit messages / 编写清晰的提交信息
  • Add tests for new features / 为新功能添加测试
  • Follow the existing code style / 遵循现有代码风格
  • Update documentation as needed / 根据需要更新文档

License / 许可证

MIT License

Copyright (c) 2025 DesignSystem-Pro-Max Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

本软件采用 MIT 许可证开源。
This software is open-sourced under the MIT License.


Acknowledgments / 致谢

  • Inspired by nextlevelbuilder/ui-ux-pro-max-skill
  • Built with pure Python BM25 search engine / 使用纯 Python BM25 搜索引擎构建
  • Design specifications from Ant Design 4.x / 设计规范来自 Ant Design 4.x

Made with ❤️ by the DesignSystem-Pro-Max team

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages