Generator-mint NPM

generator-mint 薄荷糖脚手架 En Doc

Installation

First, install Yeoman and generator-mint using npm (we assume you have pre-installed node.js).

[sudo] npm install -g yo
[sudo] npm install -g generator-mint

Then generate your new project:

yo mint

目录生成成功后，请阅读：README.md

项目架子初始化完成（注意：这时只有welcome示例页面）,目录结构如下：

mint
├── .gitignore  // 忽略git提交文件
├── README.md  // 项目说明文件
├── .browserslistrc  // .browserslistrc配置
├── .editorconfig  // .editorconfig配置
├── .env.*  // env.*编译配置
├── .babelrc  // babel编译配置
├── .editorconfig // 编辑器规范配置
├── .eslintignore // eslint代码检查忽略文件配置
├── .eslintrc.js  // eslint代码检查配置
├── .prettierignore  // prettier 忽略文件配置
├── .prettierrc // prettierrc配置
├── .stylelintignore // stylelinti 配置
├── .stylelintignore // stylelinti 忽略文件配置
├── .babel.config.js // babel配置
├── Makefile // Makefile配置
├── package.json // 项目依赖配置
├── vue.config.js // vue配置
├── LICENSE    // 许可证 MIT
├── config  // 通用配置等
├── mock  // mock
├── public  // 项目静态文件
├── src
├── ├── assets // 静态公用资源
├── ├── components // 公用组件
├── ├── install // vue install
├── ├── libs // 工具箱
├── ├── router // 路由配置
├── ├── store // store配置
└── └── views // 业务代码处

generator-mint 支持功能

yo mint:h 显示帮助

            _       _
  _ __ ___ (_)_ __ | |_
 | '_ ` _ \| | '_ \| __|
 | | | | | | | | | | |_
 |_| |_| |_|_|_| |_|\__|

需要帮助?  ===>  yo mint:h
CMD: generator-mint

mint@v1.1.0
node@v14.13.1
os@Windows_NT 10.0.18363

Yeoman 命令
   yo mint         在根目录执行，初始化Project
   yo mint:h       显示帮助
   yo mint:lang    设置脚手架语言
   yo mint:tc      克隆远端模板配置文件到脚手架
   yo mint:sc      设置远端模板配置文件下载路径
项目   命令
   npm run dev     本地开发启动命令
   npm run build   本地build
   npm run lint    本地eslint检测
 
 Tool documentation： https://github.com/sweet-shop/generator-mint
 author by @花夏 liubiao@itoxs.com

npm.io

注意!!!

如果在使用这些命令: yo mint:lang yo mint:tc yo mint:sc
出现权限问题，比如: Error: EACCES: permission denied, open '/usr/local/lib/node_modules/generator-mint/generators/tc/config.json'
请执行命令: sudo chown -R $USER /usr/local/lib/node_modules/generator-mint
其中: $USER 代表你当前电脑名. (此条只有mac会出现，Windows请使用管理员运行终端则不会出现)

yo mint:lang 设置脚手架语言,执行此命令可以设置mint的交互显示语言

🌺 欢迎使用 薄荷糖 脚手架!
            _       _
  _ __ ___ (_)_ __ | |_
 | '_ ` _ \| | '_ \| __|
 | | | | | | | | | | |_
 |_| |_| |_|_|_| |_|\__|

需要帮助?  ===>  yo mint:h
CMD: generator-mint

? ️‍🌈 请选择您想设置的语言!  (Use arrow keys)
> 默认(中文)
  en
  zh-CN

npm.io

yo mint:tc 克隆远端模板配置文件到脚手架
默认连接：https://raw.githubusercontent.com/sweet-shop/generator-mint/master/generators/app/templateConfig.js

npm.io

yo mint:sc 设置远端模板配置文件下载路径

? 请选择执行方式:  (Use arrow keys)
> custom # 自定义远端模板配置文件下载路径 确认后会要求你输入一个正确的 templateConfig.js 下载路径
  default # 使用默认，选择此选项可以恢复脚手架默认下载链接

templateConfig.js 示例：

module.exports = [
    {
        name: 'template-vue', // 名称，后续脚手架交互显示
        url: 'https://github.com/sweet-shop/template-vue.git' // 远端维护的模板，必须git [github | gitlab]
    }
];

npm.io