@cat-cli/init-spec v1.1.0

目录

• 使用指南
  • NODE环境
  • 工具安装使用
  • 集成后功能说明
  • 编辑器开启代码检测
  • 编辑器开启保存后格式化功能
  • CRA项目webpack集成
• 接口说明
  • 命令行
  • 函数调用

使用指南

此工具供前端项目集成eslint、prettier、commit、单元测试等一系列规范用。 eslint相关说明请查看@cat-com/eslint-config 。

NODE环境

nodejs 12+

工具安装使用

旧项目强烈建议新开Git分支进行初始化！！！

统一脚手架方式(推荐)

安装

npm i @cat-cli/init-spec -g

使用

cat-init-spec

函数方式

安装

npm i @cat-cli/init-spec

使用

const {init} = require("@cat-cli/init-spec");
init();

集成后功能说明

功能概述

刚集成完建议执行npm run lint:fix和npm run prettier:fix进行代码批量检查和格式化。

命令行说明

文件&目录说明

编辑器开启代码检测

vscode

• 安装ESLint插件。

webstorm

• 打开配置搜索eslint，在ESLint配置内选择Automatic ESLint configuration。

编辑器开启保存后格式化功能

vscode

• 安装ESLint和Prettier插件。
• 打开setting，点击右上角按钮打开setting.json文件。
• 写入如下配置:

{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "editor.codeActionsOnSave": {
    "source.fixAll.eslint": true
  }
}

webstorm

• 打开配置搜索eslint，在ESLint配置内勾选Run eslint --fix on save开启eslint自动修复检测。
• 搜索prettier，在Prettier配置内勾选on Save开启prettier自动格式化。

CRA项目webpack集成

使用create-react-app创建的项目，如需要webpack的eslint配置保持一致可参考文档 CRA使用自定义eslint 。

接口说明

命令行

spec

初始化规范命令

命令

cat init spec

参数

函数调用

init

初始化规范，带命令行交互

方法

init

参数

initSpec

初始化规范，不带命令行交互

方法

initSpec

参数