xizhi-cli
v1.0.2
Published
悉之(xizhi)前端脚手架, 搭建有前后台常用模板, 以前mathjax,markdown等常用组件, 方便快速启动项目, 或者添加组件
Downloads
12
Maintainers
Readme
🌟 xizhi-cli
悉之 (xizhi) 前端脚手架,提供前后台常用模板,集成 MathJax、Markdown、Husky、ESLint 等组件,助力快速启动项目和添加组件。欢迎贡献优质模板,共同提升开发效率!
🚀 快速开始
要在项目中使用脚手架,请全局安装:
npm i xizhi-cli -g
安装完成后,执行以下命令并根据提示选择模板:
xizhi-cli
🛠 本地维护方法
若需本地调试:
切换到分支:
git checkout feature-xizhi-cli
安装依赖并构建项目:
pnpm install pnpm build
本地链接 CLI 工具:
npm link xizhi-cli
使用 CLI:
xizhi-cli
即可在本地运行 xizhi-cli
命令来创建新项目。
📚 已有模板
🏠 项目模板
xizhi-cli
仓库中每个分支代表一个模板,目前包含:
vue3-arcoDesign
- Arco Design Pro 的 Vue 3 后台模板react-tailwind-zustand
- 优香农 React 模板,使用 Tailwind CSS 和 Zustandvue3-simple
- 使用 Vue CLI 创建的简单 Vue 3 模板react-simple
- 使用 Create React App 创建的简单 React 模板
🔧 组件模板
组件模板全部在xizhi-cli
的components
分支下
husky + lintStage
- 代码提交钩子与代码风格检查eslint
- JavaScript 代码质量和风格检查工具vscode
- Visual Studio Code 用户配置markdown
- Markdown 文档支持mathjax
- 在网页中显示数学公式
组件旨在为已有仓库添加新功能,CLI 可直接将组件复制进仓库,省去重复配置。
注意: React 的 Markdown 模板需要 React 18 以上版本,Vue 的需要自行添加复制按钮。
📝 项目模板添加方法
如需添加模板,请按以下步骤操作:
- 创建一个新分支,分支名即为模板名称。
- 清空分支后放入模板代码。
- 在
feature-xizhi-cli
分支下的templates
文件夹中添加模板的name
、value
和branch
。
⚠️ 注意
- 权限问题:如拉取代码时报错 403,可能是代码托管在公司的 Gitee 仓库上,需要权限。请先配置 Gitee 的 SSH 公钥。
🚧 想做而未完成的功能
计划实现动态获取仓库分支的功能,但需使用 Gitee 的 API 并添加个人令牌访问私有仓库。由于硬编码不安全,目前尚未找到好的解决方案。