@mtool/standardization
v1.0.5
Published
一款eslint和prettier的安装工具
Downloads
146
Maintainers
Readme
@mtool/move-module-dependencies
介绍
一款通过配置化,在项目中添加 eslint、husky、lint staged、proxy(npmrc|yarnrc) 的库。
安装
(npm|yarn|pnpm) install @mtool/standardization
使用说明
安装后,在项目根目录下新建 standardization.js 后,采用nodejs执行此文件即可,详见下方示例
贡献
- Fork 本仓库
- 新建 feat/xxx 分支
- Push代码,并提交 Merge Request, 作者欢迎各位为此开源工具贡献一份力量~
示例
// 1. 在项目根目录下新建 standardization.js 文件
// 2. standardization.js
const Standardization = require('@mtool/standardization');
// 3. 由于此库采用的是单例模式导出,因此直接调用 start 方法即可
Standardization.start({
needHuskyAndLintStaged: true, // 是否需要husky以及lint staged
needDependenciesProxy: true // 是否需要镜像源文件(npmrc|yarnrc)
});
// 4. 此库继承了@mtool/move-module-dependencies,因此适用 @mtool/move-module-dependencies 的参数,同样适用这里。详情请参考:https://www.npmjs.com/package/@mtool/move-module-dependencies
Standardization.start({
needHuskyAndLintStaged: true, // 是否需要husky以及lint staged
needDependenciesProxy: true // 是否需要镜像源文件(npmrc|yarnrc)
config: { // 非必要建议不要传递
coverIgnore: {
file: ['xxx'], // 设置当移动的文件存在冲突时,哪些文件忽略跳过,默认会覆盖。
version: ['xxx'] // 设置当安装的依赖存在冲突时,是否忽略跳过,默认会覆盖。
}
}
});