scaffolding-lgg: 一个较成熟的脚手架工具项目。在需要的目录下执行本脚手架命令(lgg create <yourProjectName>)，可接收用户输入，并根据用户输入生成项目模板文件，模板文件下载于远程 github 仓库。

# scaffolding-lgg - 未完待续

## 介绍
一个较成熟的脚手架工具项目。在需要的目录下执行本脚手架命令(lgg create <yourProjectName>)，可接收用户输入，并根据用户输入生成项目模板文件，模板文件下载于远程 github 仓库。

## 所用模块介绍(CLI必备要素)
1. ora - 添加等待效果
2. chalk - 控制终端字体样式
3. inquirer - 完成交互
4. commander - 自定义命令 处理命令中用户写入的参数等

## 步骤
1. 新建项目，在项目根目录下新建 bin/cli.js 和 lib/index.js 文件
2. cnpm init -y 生成一个 package.json 文件，并修改如下三个字段为：
```
  "name": "lgg",
  "main": "./lib/index.js",
  "bin": {
    "lgg": "./bin/cli.js"
  },
```
3. 添加 bin/cli.js 文件内容如下：
```
#! /usr/bin/env node

const { program } = require('commander') 
const { version } = require('../package.json')
const mainFn = require('..') // 在当前项目下 它就相当于执行了 lib 目录下的index.js

// 存储具体命令信息
const actionsMap = {  
  'create': {      
    alias: 'crt',      
    description: '创建本地项目',      
    examples: [          
      'lgg create <projectname>'      
    ]
  }
}

// 将上述信息渲染至命令行终端里
Reflect.ownKeys(actionsMap).forEach(aName => {    
  // 生成命令     
  program.command(aName) // 自定义命令名称      
  .alias(actionsMap[aName].alias) // 给一个别名      
  .description(actionsMap[aName].description) // --help 时可获取命令描述信息      
  .action(() => {
    // 执行 index.js 中的mainFn， 并传入参数
    let proName = process.argv.slice(3);
    mainFn(aName, proName)
  })
})

program.on('--help', () => {    
  console.log('Examples: ')    // 此时监听到 --help 事件的发生，则可将数组里的示例显示出来    
  Reflect.ownKeys(actionsMap).forEach(aName => {        
    actionsMap[aName].examples.forEach((item) => {            
      console.log("  " + item)        
    })    
  })
})

program.version(version).parse(process.argv)
```
4. 添加 lib/index.js 内容如下：
```
module.exports = function(aName, proName) {
  require('./' + aName)(...proName)
}
```
5. 新建 lib/create.js 内容如下：
```
const axios = require('axios')
const ora = require('ora')

module.exports = async function (proName) {
  // 1 在远端平台上查询文件是否存在
  /**
   * 01 此时在 github 上已经准备好了两个模板仓库
   * 02 在使用 lgg 生成项目的时候，就想用这两个模板
   * 03 先去 github 上看下这两个项目是否存在
   * 04 如何去看呢？
   *   发请求 --> github 提供相应的 API 支持
  */
 const myGithubDevelopToken = '348a21e49d414599a8fc660465e28206a246791d'
 const headers = {"Authorization": "token " + myGithubDevelopToken}
 const spinner = ora('正在拉取')
 spinner.start()
 let { data } = await axios({
   method: 'get',
   url: 'https://api.github.com/users/zcegg/repos',
   headers
 })
 spinner.succeed('拉取成功')
 let repos = data.map(item => item.name)
 console.log(repos)
}
```
6. 执行 npm link , 然后可以执行 lgg --help 命令查看帮助
7. 执行 lgg create myProject1 此时可以输出远程仓库的名称列表

大右右/scaffolding-lgg

简介

发行版

贡献者

近期动态

大右右/scaffolding-lgg .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

大右右/scaffolding-lgg