摘要：其實(shí)有點(diǎn)耗時(shí)間，所以我們做了一下自動(dòng)化初步自動(dòng)化修改中的初始化將部分腳本寫入到中詢問(wèn)是否全部使用是否默認(rèn)使用開始安裝依賴正在安裝正在安裝清除掉以前配置的只要兩部安裝即可提交代碼的時(shí)候直接執(zhí)行即可更智能摸索中

#!/usr/bin/env node
"use strict";
const path = require("path");
const editJsonFile = require("edit-json-file");
const arg = process.argv
// 初始化my-commit ,將部分腳本寫入到package.json中
if (arg[2] && arg[2] === "init") {
  // If the file doesn"t exist, the content will be an empty object by default.
  let file = editJsonFile(`${process.cwd()}/package.json`);
  // Set a couple of fields
  file.set("husky", {"hooks": {
    "pre-commit": "lint-staged"
  }});
  file.set("lint-staged", {
    "src/*.js": "["eslint --fix"]"
  });
  // 詢問(wèn)是否全部使用git add .
  var List = require("prompt-list");
  var list = new List({
    name: "order",
    message: "是否默認(rèn)使用git add .",
    // choices may be defined as an array or a function that returns an array
    choices: [
      "yes",
      "no"
    ]
  })
  // async
  list.ask(function(answer) {
    file.set("scripts", {
      "my-ci": answer === "yes" ? "git add . && cross-env ./node_modules/.bin/my-commit" : "cross-env ./node_modules/.bin/my-commit"
    });
    // Output the content
    file.save();
    var shell = require("shelljs");
    console.log("開始安裝依賴");
    shell.exec("npm i husky --save-dev", {async: true})
    console.log("正在安裝 husky---- ");
    shell.exec("npm i cross-env --save-dev", {async: true})
    console.log("正在安裝cross-env ---- ");
    shell.exec("npm i lint-staged --save-dev", {async: true})
  })
} else {
  const bootstrap = require("commitizen/dist/cli/git-cz").bootstrap;
  bootstrap({
    cliPath: path.join(__dirname, "../../node_modules/commitizen"),
    // this is new
    config: {
      "path": "cz-conventional-changelog",
      "path": "cz-emoji"
    }
  });
}

1.使用git/gitlab創(chuàng)建一個(gè)空的倉(cāng)庫(kù)

2.在空倉(cāng)庫(kù)中添加index.js 內(nèi)容如下

// index.js

#!/usr/bin/env node
"use strict";
const bootstrap = require("commitizen/dist/cli/git-cz").bootstrap;
  bootstrap({
    cliPath: path.join(__dirname, "../../node_modules/commitizen"),
    // this is new
    config: {
      "path": "cz-conventional-changelog"
    }
  });

1.先發(fā)布你的工具項(xiàng)目到npm，相當(dāng)于創(chuàng)建一個(gè)npm包、具體怎么發(fā)布 這里不做贅述，網(wǎng)上很多教程

2.安裝工具（假設(shè)插件名稱my-commit）

npm install my-commit --save-dev

3.配置

需要在package.json的script中添加如下

// my-ci 是自己定義的寫成什么都可以

"my-ci": "./node_modules/.bin/my-commit"

4.配置之后 執(zhí)行了git add .之后 執(zhí)行npm run my-ci 將會(huì)出現(xiàn)選填補(bǔ)充信息的選項(xiàng)

如果覺(jué)得git add.之后再執(zhí)行 npm run my-ci 有點(diǎn)麻煩，可以直接改成

// my-ci 是自己定義的寫成什么都可以

"my-ci": "git add. && ./node_modules/.bin/my-commit"

5 因?yàn)橐陨厦畲嬖诓煌到y(tǒng)路徑不兼容問(wèn)題 需要加入 cross-env

npm install cross-env --save-dev 

6 再次修改package.json

// my-ci 是自己定義的寫成什么都可以

"my-ci": "git add. && cross-env ./node_modules/.bin/my-commit"

當(dāng)需要提交代碼的時(shí)候，不用執(zhí)行git add . 直接執(zhí)行npm run my-ci即可

7 提示信息加上可愛(ài)的表情

需要在index.js文件中添加 cz-emoji 如下

// index.js

#!/usr/bin/env node
"use strict";

const bootstrap = require("commitizen/dist/cli/git-cz").bootstrap;
  bootstrap({
    cliPath: path.join(__dirname, "../../node_modules/commitizen"),
    // this is new
    config: {
      "path": "cz-conventional-changelog",
      "path": "cz-emoji"
    }
  });

這個(gè)時(shí)候 重新發(fā)npm包之后再安裝到自己的項(xiàng)目下，執(zhí)行提交的時(shí)候

8 為了增強(qiáng)校驗(yàn)功能，加入eslint對(duì)文件進(jìn)行

這個(gè)有點(diǎn)復(fù)雜，需要通過(guò)lint-staged來(lái)判斷

所以先安裝以下依賴

npm i husky --save-dev
npm i lint-stage --save-dev

配置package.json

// 增加屬性
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "src/*.js": [
      "eslint --fix"
    ]
  },
// 其中src的具體路徑是可以自己配置
// 校驗(yàn)規(guī)則是基于當(dāng)前目錄的.eslintrc.js 文件，如果有些規(guī)則不想要，就配置這個(gè)文件

這個(gè)時(shí)候我們提交代碼的時(shí)候再輸入基本的信息之后會(huì)執(zhí)行一個(gè)eslint的代碼規(guī)則

總結(jié)以上配置文件 我們需要

安裝的庫(kù)有

npm i my-commit --save-dev
npm i cross --save-dev
npm i husky --save-dev
npm i lint-stage --save-dev

需要配置package.json屬性有

  "script": {
      ...
      "my-ci": "git add. && cross-env ./node_modules/.bin/my-commit"
    },

  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "src/*.js": [
      "eslint --fix"
    ]
  },

如果每個(gè)項(xiàng)目都這么玩。其實(shí)有點(diǎn)耗時(shí)間，所以我們做了一下自動(dòng)化

10 初步自動(dòng)化

修改my-commit中的 index.js

#!/usr/bin/env node
"use strict";
const path = require("path");
const editJsonFile = require("edit-json-file");
const arg = process.argv
// 初始化my-commit ,將部分腳本寫入到package.json中
if (arg[2] && arg[2] === "init") {
  // If the file doesn"t exist, the content will be an empty object by default.
  let file = editJsonFile(`${process.cwd()}/package.json`);
  // Set a couple of fields
  file.set("husky", {"hooks": {
    "pre-commit": "lint-staged"
  }});
  file.set("lint-staged", {
    "src/*.js": "["eslint --fix"]"
  });
  // 詢問(wèn)是否全部使用git add .
  var List = require("prompt-list");
  var list = new List({
    name: "order",
    message: "是否默認(rèn)使用git add .",
    // choices may be defined as an array or a function that returns an array
    choices: [
      "yes",
      "no"
    ]
  })
  // async
  list.ask(function(answer) {
    file.set("scripts", {
      "my-ci": answer === "yes" ? "git add . && cross-env ./node_modules/.bin/my-commit" : "cross-env ./node_modules/.bin/my-commit"
    });
    // Output the content
    file.save();
    var shell = require("shelljs");
    console.log("開始安裝依賴");
    shell.exec("npm i husky --save-dev", {async: true})
    console.log("正在安裝 husky---- ");
    shell.exec("npm i cross-env --save-dev", {async: true})
    console.log("正在安裝cross-env ---- ");
    shell.exec("npm i lint-staged --save-dev", {async: true})
  })
} else {
  const bootstrap = require("commitizen/dist/cli/git-cz").bootstrap;
  bootstrap({
    cliPath: path.join(__dirname, "../../node_modules/commitizen"),
    // this is new
    config: {
      "path": "cz-conventional-changelog",
      "path": "cz-emoji"
    }
  });
}
 

清除掉以前配置的package.json

只要兩部安裝即可

npm i my-commit
npx my-commit init

提交代碼的時(shí)候直接執(zhí)行 npm run my-ci 即可

11 更智能（摸索中）