资讯专栏INFORMATION COLUMN

tslint pre-commit 配置教程

bang590 / 1448人阅读

摘要:而解决的需求既是拒绝向仓库提交错误代码。的配置就在项目文件夹下面的文件夹中。而存在报错的话,会终止提交。而只是多带带钩子,因此还需要在这个钩子下去做相同的配置。

tslint 配合pre-commit的意义

为什么用pre-commit 加 tslint(jshint,eslint原理都类似),因为在项目中我们会经常忘记主动的去做代码检查,虽然结合webpack各种构建工具下,存在*slint报错,项目会跑不起来。但在某些情况下,可能会因为着急,或者其他原因,没有去观察项目运行的情况就仓促提交。团队开发的情景下,可能会成为别人的麻烦。而pre-commit tslint解决的需求既是:拒绝向仓库提交错误代码。

git hooks

在配置tslint pre commit之前,首先需要了解git hooks,正如它的名字所示,这是一个关于git 操作的钩子,比如我们想要在做远程仓库推送时,那就会触发pre-push这个钩子,然后在这个钩子中写下自己想做的事。git hooks的配置就在项目.git文件夹下面的hooks文件夹中。

在写相关的钩子函数时,需要注意的是,将钩子后面的sample后缀去掉,代码才会生效。

比如,本文中用到的pre-commit这个钩子。

更多关于git hooks的介绍,请参考:https://git-scm.com/book/en/v...

开始配置

1.打开项目中的.git/hooks文件夹,找到pre-commit.sample文件,将以下代码替换到文件中。

#!/bin/bash
TSLINT="$(git rev-parse --show-toplevel)/node_modules/.bin/tslint"
for file in $(git diff --cached --name-only | grep -E ".ts$")
do
        git show ":$file" | "$TSLINT" "$file"
        if [ $? -ne 0 ]; then
                exit 1
        fi
done

2.将pre-commit.sample文件名修改为pre-commit

此时再打开项目运行git commit -m"xx"命令时,tslint会做自动的检查,如果没有错误的话,才会提交成功。而存在tslint报错的话,会终止提交。

日常开发中,有时为了方便会直接使用git commit -am"xxx"(即add+commit)的指令。而pre-commit 只是多带带commit 钩子,因此还需要在pre-applypatch这个钩子下去做相同的配置。

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/89229.html

相关文章

  • 在2018年如何优雅的开发一个typescript语言的npm包?

    摘要:实际开发中,如果每个包都去走一遍这些步骤,步骤好像确实有点多。 欢迎大家前往腾讯云+社区,获取更多腾讯海量技术实践干货哦~ 本文由小明plus发表 很多时候,我们可能想要用 typescript 语言来创建一些模块,并提交到 npm 供别人使用, 那么在 2018 年,如果我想要初始化这样的一个模块,我需要做哪些步骤呢?: 答案是:创建一个优雅的,对开发者友好的模块,至少需要以下 15...

    Karuru 评论0 收藏0
  • 在Typescript项目中,如何优雅的使用ESLint和Prettier

    摘要:对于项目的编码规范而言,主要有两种选择和。此外由于性能问题,官方决定全面采用,甚至把仓库作为测试平台,而的解析器也成为独立项目,专注解决双方兼容性问题。最近在我的项目的编码规范中全量的用代替了针对其中遇到的问题做一个记录。   对于Typescript项目的编码规范而言,主要有两种选择ESLint和TSLint。ESLint不仅能规范js代码,通过配置解析器,也能规范TS代码。此外由...

    chemzqm 评论0 收藏0
  • 在Typescript项目中,如何优雅的使用ESLint和Prettier

    摘要:对于项目的编码规范而言,主要有两种选择和。此外由于性能问题,官方决定全面采用,甚至把仓库作为测试平台,而的解析器也成为独立项目,专注解决双方兼容性问题。最近在我的项目的编码规范中全量的用代替了针对其中遇到的问题做一个记录。   对于Typescript项目的编码规范而言,主要有两种选择ESLint和TSLint。ESLint不仅能规范js代码,通过配置解析器,也能规范TS代码。此外由...

    WilsonLiu95 评论0 收藏0
  • 在Typescript项目中,如何优雅的使用ESLint和Prettier

    摘要:对于项目的编码规范而言,主要有两种选择和。此外由于性能问题,官方决定全面采用,甚至把仓库作为测试平台,而的解析器也成为独立项目,专注解决双方兼容性问题。最近在我的项目的编码规范中全量的用代替了针对其中遇到的问题做一个记录。   对于Typescript项目的编码规范而言,主要有两种选择ESLint和TSLint。ESLint不仅能规范js代码,通过配置解析器,也能规范TS代码。此外由...

    琛h。 评论0 收藏0
  • 打造个人or团队适用的开源项目规范

    摘要:打造个人团队适用的开源项目规范是一个用来优化托管在上的多代码库的工作流的一个管理工具可以让你在主项目下管理多个子项目,从而解决了多个包互相依赖,且发布时需要手动维护多个包的问题。 打造个人or团队适用的开源项目规范 lerna Lerna 是一个用来优化托管在gitnpm上的多package代码库的工作流的一个管理工具,可以让你在主项目下管理多个子项目,从而解决了多个包互相依赖,且发布...

    huangjinnan 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<