发布于 4 个月前 ,更新于 4 个月前 git,node

使用git+typescript+eslint+husky+lint-staged搭建项目

现在前端项目或多或少会用到GitTypescriptEslintHuskyLint-staged。本文记录一下如何在项目中使用这些工具。 环境要求:

  • 已安装git
  • 已安装Node和Npm
  • npm全局安装typescript和eslint

注意:以下操作命令均在项目目录下执行

初始化npm项目
$ npm init -y
初始化git仓库
$ git init
配置typescript
$ tsc --init
$ npm i typescript -D

执行命令后,项目根目录下回多一个tsconfig.json的配置文件

配置eslint

参考Eslint文档

$ eslint --init

执行命令后,根据提示进行操作。如果自动 npm install 出错,可复制所有依赖重新安装

配置husky + lint-staged

参考husky文档

$ npm i lint-staged -D
$ npx husky-init && npm install

执行命令后,再在package.json中添加lint-staged,最后package.json文件内容大概如下

{
  "scripts": {
    "lint": "lint-staged",
    "prepare": "husky install"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^4.21.0",
    "@typescript-eslint/parser": "^4.21.0",
    "eslint": "^7.12.1",
    "eslint-config-standard": "^16.0.2",
    "eslint-plugin-import": "^2.22.1",
    "eslint-plugin-node": "^11.1.0",
    "eslint-plugin-promise": "^4.2.1",
    "husky": "^6.0.0",
    "lint-staged": "^10.5.4",
    "typescript": "^4.2.4"
  },
  "lint-staged": {
    "*.{js,jsx,vue}": [
      "eslint --fix"
    ]
  }
}

修改 .husky/pre-commit 文件,将 npm test 改成 npm run lint

© 2016 - 2021 BY 禾惠 粤ICP备20027042号