背景需求:在平常开发中,随着项目愈来愈多,能重复利用的代码就越多,急需一套基本的模板来初始化项目,把代码放到本身的gitlab或github上,每次又得找到地址从新clone一下,很麻烦
指望的结果:XXX init 。。。一行命令解决
步骤:
一、申请一个npm帐号,https://www.npmjs.com/
二、写一个npm项目
package.json:vue
{ "name": "windssr", "version": "1.0.8", "description": "a tool service for react-ssr", "main": "index.js", "bin": { "windssr": "index.js" }, "author": "windseek", "license": "ISC", "dependencies": { "chalk": "^2.4.2", "co": "^4.6.0", "co-prompt": "^1.0.0", "commander": "^2.20.0" }, "scripts": { "test": "test" }, "repository": { "type": "git", "url": "git+https://github.com/Windseek/react-ssr-cli.git" }, "keywords": [ "react", "react-ssr", "wind-ssr", "react-ssr-cli" ], "bugs": { "url": "https://github.com/Windseek/react-ssr-cli/issues" }, "homepage": "https://github.com/Windseek/react-ssr-cli#readme" }
init.jsnode
'use strict' const exec = require('child_process').exec const co = require('co') const prompt = require('co-prompt') const config = require('./template.json') const chalk = require('chalk') module.exports = () => { co(function *() { // 处理用户输入 let tplName = yield prompt('Template name (you can input one like react, vue, angular): ') let projectName = yield prompt('Project name: ') let gitUrl,branch; console.log(config.tpl); if (!config.tpl[tplName]) { console.log(chalk.red('\n × Template does not support!')) process.exit() } gitUrl = config.tpl[tplName].url branch = config.tpl[tplName].branch // git命令,远程拉取项目并自定义项目名 let cmdStr = `git clone ${gitUrl} ${projectName} && cd ${projectName} && git checkout ${branch}` exec(cmdStr, (error, stdout, stderr) => { if (error) { console.log(error) process.exit() } console.log(chalk.green('\n √ Generation completed!')) console.log(`\n cd ${projectName} && npm install \n`) process.exit() }) }) }
index.jsreact
#!/usr/bin/env node --harmony 'use strict' process.env.NODE_PATH = __dirname + '/../node_modules/' const program = require('commander') program .version(require('./package').version) program .usage('<command>') program .command('init') .description('Generate a new project') .alias('i') .action(() => { require('./init.js')() }) program.parse(process.argv)
template.json:git
{"tpl":{"react":{"url":"https://github.com/Windseek/reactssr.git","branch":"master"}}}
写好了须要发布一下喽:
一、npm login,填写用户名,密码
二、修改package.json里version
三、npm publish
四、去https://www.npmjs.com/ 上看当作功没有github
相关说明:
一、package.json里定义bin的位置
二、index里定义bin命令指定执行的代码
三、init里执行shell,去git上拿代码模板shell
安装和初始化:
一、npm install windssr -g
二、windssr init
三、选择要使用的模板,react,angular和vuenpm
若是觉的对你有用的话,支持一下哈json