加入收藏 | 设为首页 | 会员中心 | 我要投稿 银川站长网 (https://www.0951zz.com/)- 云通信、基础存储、云上网络、机器学习、视觉智能!
当前位置: 首页 > 综合聚焦 > 编程要点 > 语言 > 正文

如何经过CLI方便生成的Eslint Prettier等配置文件

发布时间:2023-06-10 11:05:43 所属栏目:语言 来源:
导读:这篇文章主要介绍“如何通过CLI方便生成的Eslint、Prettier等配置文件”,有一些人在如何通过CLI方便生成的Eslint、Prettier等配置文件的问题上存在疑惑,接下来小编就给大家来介绍一下相关的内容,希望对

这篇文章主要介绍“如何通过CLI方便生成的Eslint、Prettier等配置文件”,有一些人在如何通过CLI方便生成的Eslint、Prettier等配置文件的问题上存在疑惑,接下来小编就给大家来介绍一下相关的内容,希望对大家解答有帮助,有这个方面学习需要的朋友就继续往下看吧。

写一个前端工程,要配置特别多的配置文件,大量的配置文件让我们很烦心,占用了大量写代码的时间。

每次要启动一个新的项目,都要从头配一遍。有人可能把这些文件当做模板保存下来,有需要的时候再复制粘贴。可是各个项目还是不尽相同,还是需要手动改动。

于是我决定写一个命令行工具来解决这件事。

create-lint-config

这个工具叫做 create-lint-config,一个一键创建所有的 lint 配置的 CLI 命令行工具。前端工程中特别多的配置文件例如 Eslint、Prettier 等让我们心烦意乱。我们的目标是快速而轻松地生成这些配置!

github 地址

npm 地址

使用

在你的项目根目录执行以下命令:

# npm

npm create lint-config@latest

# yarn

yarn create lint-config

# pnpm

pnpm create lint-config@latest

这个命令,一次执行,创建了 Eslint、StyleLint、prettier、commitlint、husy、lint-staged 等所有配置文件。

现有功能

生成 Eslint 配置。

生成 prettier 配置。

生成 stylelint 配置。

生成 husky 配置。

生成 commitlint 配置。

自动安装依赖。

期待更多。

源码解读

#!/usr/bin/env node

async function install({ pkgManager, cwd, _arguments }: { pkgManager: string; cwd: string; arguments: array }) {}

async function init() {

// 拷贝配置文件基础模板,包括 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 写入 commit-msg 校验指令,使用 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 写入 pre-commit校验指令,使用 lint-staged 执行 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)

})

更多源码请移步 GitHub 查看

TODO

支持通过--template标志来选择模板,创建更多的配置文件模板,包括 ts、vue、react、node 等等

支持更灵活的交互式选项。现在只能一键生成默认的模板,有些配置可能是一些人不需要的,后续计划可以更灵活。

(编辑:银川站长网)

【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容!