ne-build

🎩运营活动组项目构建工具

命令

# node版本大于5.2
# 参数可在命令行输入，也可以输入命令后按交互提示输入

# 使用杭研npm时，请加上scope，如
$ npx @ne-web/ne-build h5 projectName

# 可在命令后直接输入项目名，如
$ npx @ne-web/ne-build h5 projectName
# 使用 NyPhile/h5_template 作为模板，创建projectName文件夹，并在projectName文件夹内创建项目。
# 不用重复输入项目名了。post、init命令同样增加该参数。
# 不填写projectName时与之前一样，在当前文件夹下创建项目

$ npx @ne-web/ne-build h5 projectName
# h5 zepto模板
# 使用 NyPhile/h5_template 作为模板创建项目，等同于 npx ne-build init -t NyPhile/h5_template

$ npx @ne-web/ne-build h5-scroll projectName
# h5-scroll 边滑边动模板

$ npx @ne-web/ne-build post projectName
# node渲染项目前端模板（以文章页为例）

$ npx @ne-web/ne-build pc projectName
# cms pc项目jQuery模板

$ npx @ne-web/ne-build pc-jq-multi projectName
# cms pc项目jQuery多页面模板

$ npx @ne-web/ne-build pc-vue projectName
# cms pc项目vue2框架模板

$ npx @ne-web/ne-build pc-vue3 projectName
# cms pc项目vue3框架模板

$ npx @ne-web/ne-build component-vue projectName
# 发布vue组件库npm包模板

$ npx @ne-web/ne-build init
# 创建项目，可同时输入参数，如 npx ne-build init -t NyPhile/h5_template

参数

以下参数均可交互式输入

-n or --projectName
# 项目名称，必须
# 用于替换模板项目中package.json的{name}

-c or --projectChannel
# 频道名称，必须
# 用于替换模板项目内上传路径中的频道路径

-d or --projectDesc
# 项目描述，可选
# 用于替换模板项目中package.json的{description}

-t or --templatePath
# 模板地址，必选
# 使用download-git-repo下载模板
# H5模板地址 NyPhile/h5_template
# 文章页模板地址 NyPhile/post_template

--username
# 上传工具账号，必须，即邮箱前缀

--password
# 上传工具密码，必须，即邮箱密码

工作流程

1. 使用 npx 执行包命令
2. 输入相应参数（projectName、projectChannel、projectDesc、templatePath、username、password）
3. 使用 download-git-repo 在当前目录下载对应git仓库地址内容
4. 替换 package.json 中的内容，{projectName} -> name，{projectChannel} -> channel，{projectDesc} -> description
5. 替换 .ftppass 中的内容，{username} -> username，{password} -> password(不包括pc模版)
6. 替换 README.md 中的内容，# {projectName} -> # temp