project-init-ethan
v0.0.8
Published
A CLI tool to package and extract project templates
Readme
project-init-ethan
这是一个CLI工具,用于打包和解压项目模板。
安装
npm install -g project-init-ethan使用方法
打包模板
在项目根目录下运行以下命令:
npm run build这将读取package.json中的template字段指定的文件夹,并将其打包成data.zip文件。打包时会自动排除.gitignore中指定的文件和文件夹。
当执行 npm publish 命令发布包时,会自动运行构建过程。
解压模板
使用以下命令将data.zip解压到指定目录:
project-init-ethan targetFolder配置
在package.json中可以配置以下字段:
template: 指定要打包的模板目录,默认为./template
工作原理
npm run build命令会读取 package.json 中的 template 字段指定的目录- 将该目录下的所有文件打包成 dist/data.zip 文件(排除 .gitignore 中指定的文件)
- 用户可以通过
project-init-ethan targetFolder命令将 dist/data.zip 解压到目标目录
注意事项
- data.zip 文件会生成在包的根目录下
- CLI 工具会从包的安装目录查找 dist/data.zip 文件,而不是当前工作目录
- 发布到 npm 时会自动运行构建过程
