命令行CLI一鍵生成各種煩人的lint配置實(shí)例

更新時(shí)間：2023年02月24日 08:59:01 作者：李瑞豐_liruifengv

這篇文章主要為大家介紹了命令行CLI一鍵生成各種煩人的lint配置實(shí)例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進(jìn)步，早日升職加薪

前言

寫(xiě)一個(gè)前端工程，要配置特別多的配置文件，大量的配置文件讓我們很煩心，占用了大量寫(xiě)代碼的時(shí)間。

就像上圖，看著就頭大。

每次要啟動(dòng)一個(gè)新的項(xiàng)目，都要從頭配一遍。有人可能把這些文件當(dāng)做模板保存下來(lái)，有需要的時(shí)候再?gòu)?fù)制粘貼。可是各個(gè)項(xiàng)目還是不盡相同，還是需要手動(dòng)改動(dòng)。

于是我決定寫(xiě)一個(gè)命令行工具來(lái)解決這件事。

create-lint-config

這個(gè)工具叫做 create-lint-config，一個(gè)一鍵創(chuàng)建所有的 lint 配置的 CLI 命令行工具。前端工程中特別多的配置文件例如 Eslint、Prettier 等讓我們心煩意亂。我們的目標(biāo)是快速而輕松地生成這些配置！

github 地址

npm 地址

使用

在你的項(xiàng)目根目錄執(zhí)行以下命令：

# npm
npm create lint-config@latest
# yarn
yarn create lint-config
# pnpm
pnpm create lint-config@latest

執(zhí)行結(jié)果如下：

這個(gè)命令，一次執(zhí)行，創(chuàng)建了 Eslint、StyleLint、prettier、commitlint、husy、lint-staged 等所有配置文件。

現(xiàn)有功能

生成 Eslint 配置。
生成 prettier 配置。
生成 stylelint 配置。
生成 husky 配置。
生成 commitlint 配置。
自動(dòng)安裝依賴。
期待更多。

源碼解讀

#!/usr/bin/env node
async function install({ pkgManager, cwd, _arguments }: { pkgManager: string; cwd: string; arguments: array }) {}
async function init() {
  // 拷貝配置文件基礎(chǔ)模板，包括 Eslint、StyleLint、prettier、commitlint、husy、lint-staged
  await spinner({
    start: `Base template copying...`,
    end: 'Template copied',
    while: () => {
      try {
        copy('base')
      } catch (e) {
        error('error', e)
        process.exit(1)
      }
    },
  })
  // 安裝 husky
  await spinner({
    start: `Husky installing...`,
    end: 'Husky installed',
    while: () =>
      install({
        cwd: process.cwd(),
        pkgManager: 'npx',
        _arguments: ['husky', 'install'],
      }).catch((e) => {
        error('error', e)
        process.exit(1)
      }),
  })
  // husky 寫(xiě)入 commit-msg 校驗(yàn)指令，使用 commitlint
  await spinner({
    start: `Adding commit-msg lint...`,
    end: 'Commit-msg lint added',
    while: () =>
      install({
        cwd: process.cwd(),
        pkgManager: 'npx',
        _arguments: ['husky', 'add', '.husky/commit-msg', 'npx --no-install commitlint --edit ""'],
      }).catch((e) => {
        error('error', e)
        process.exit(1)
      }),
  })
  // husky 寫(xiě)入 pre-commit校驗(yàn)指令，使用 lint-staged 執(zhí)行 elint 等
  await spinner({
    start: `Adding lint-staged...`,
    end: 'Lint-staged added',
    while: () =>
      install({
        cwd: process.cwd(),
        pkgManager: 'npx',
        _arguments: ['husky', 'add', '.husky/pre-commit', 'npx lint-staged'],
      }).catch((e) => {
        error('error', e)
        process.exit(1)
      }),
  })
  // 安裝依賴
  await spinner({
    start: `Dependencies installing with npm...`,
    end: 'Dependencies installed',
    while: () =>
      install({
        cwd: process.cwd(),
        pkgManager: 'npm',
        _arguments: ['install'],
      }).catch((e) => {
        error('error', e)
        process.exit(1)
      }),
  })
}
init().catch((e) => {
  console.error(e)
})

更多源碼請(qǐng)移步 GitHub 查看

TODO

支持通過(guò)--template標(biāo)志來(lái)選擇模板，創(chuàng)建更多的配置文件模板，包括 ts、vue、react、node 等等
支持更靈活的交互式選項(xiàng)?，F(xiàn)在只能一鍵生成默認(rèn)的模板，有些配置可能是一些人不需要的，后續(xù)計(jì)劃可以更靈活。