1.0.0 • Published 5 years ago

@yokots/tslint-config-react v1.0.0

Weekly downloads
1
License
MIT
Repository
-
Last release
5 years ago

Style Guide

Usage:

  • npm install tslint typescript @yoko/tslint-config-react -D

  • 在项目目录下新建 tslint.json

      {
        "extends": ["@yoko/tslint-config-react"],
        "rules": {
          // 覆盖默认规则
        },
        "linterOptions": {
          "exclude": [
            "src/**/*.spec.ts",
            "**/test/**.ts",
            "**/*.d.ts"
          ]
        }
      }
  • npx tslint src/**/*.ts src/**/*/tsx -p . -t stylish (适用于 npm v5.2 以上, 错误较少可使用 -t codeFrame)

强烈建议

每个人在自己的工程中配置 pre-commit 钩子,在提交代码之前进行检查

  • husky 用 node 配置钩子
  • lint-staged 只检查将要提交的代码
  • commitlint 检查 commit 规范

    配置完后类似于以下这个样子

"husky": {
  "hooks": {
    "pre-commit": "lint-staged",
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }
},
"commitlint": {
  "extends": ["@commitlint/config-conventional"]
},
"lint-staged": {
  "*.{ts,tsx}": [
    "tslint -p . --fix",
    "git add"
  ]
},