资讯专栏INFORMATION COLUMN

代码风格统一:commitlint & eslint & standard-vers

lieeps / 2854人阅读

摘要:配置添加包配置此处如果不使用需要将替换为效果代码提交的格式不符合标准就会直接被拒绝。

Commitlint 配置

添加包

yarn add @commitlint/cli @commitlint/config-conventional husky -D

配置package.json

"husky": {
    "hooks": {
      // 此处如果不使用husky 需要将HUSKY_GIT_PARAMS 替换为 GIT_PARAMS
      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
    }
  },
  "commitlint": {
    "extends": [
      "@commitlint/config-conventional"
    ]
  }

效果: 代码提交的格式不符合标准 就会直接被拒绝。在团队协作时提交历史的回溯需要有良好的提交历史

版本管理
yarn add standard-version -D

配置package.json

"scripts": {
    "release": "standard-version"
  }

执行 yarn release 生成CHANGELOG.md 类似

# Change Log

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.


## 1.0.3 (2018-12-05)


### Features

* **lint:** 添加commitlint配置 ([faee26d](http://url/commits/faee26d))
* **lint:** 简化commitlint配置 ([affeb7d](http://url/commits/affeb7d))
ESLint配置
yarn add lint-staged -D

配置package.json

"husky": {
    "hooks": {
      // 代码提交前 执行lint 也可以配合prettier将代码直接格式化后提交
      "pre-commit": "lint-staged"
    }
  },
"lint-staged": {
    "linters": {
      "/src/**/*.js": [
        "eslint --fix",
        "git add"
      ]
    },
    "ignore": [
      "/**/*.min.js"
    ]
  }

代码提交之前执行lint 保证代码格式统一

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

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

相关文章

  • 工程搭建---代码风格统一

    摘要:为此我们需要安装这个是用于提交代码的钩子函数安装完之后,我们就需要在增加运行钩子函数。等钩子函数这样就简单的成功对代码进行效验了,当然这边更进一步的可以使用这个可以将取得所有被提交的文件依次执行写好的任务。 一个项目是会有多个成员来开发的,因此统一开发规范是很有必要的,不然每个人都有自己的风格,同步之后代码都会报错。我这边是用Vscode编译器的。 首先用vue-cli3.0创建一个工...

    levius 评论0 收藏0
  • 前端代码风格自动化系列(五)之共同出击

    摘要:我们在前面的四篇中介绍了这些工具,可以完成以最小的代价在提交到远程仓库前,格式化为统一风格的代码,大家都很熟悉这里就不列举了。下面举一个配置。这里对于项目里分别做了提交前格式化操作,对于提交规范做了校验。 我们在前面的四篇中介绍了husky、commitlint、lint-staged、prettier这些工具,可以完成以最小的代价在Git提交到远程仓库前,格式化为统一风格的代码,es...

    pumpkin9 评论0 收藏0
  • Lint Your Code

    摘要:形成良好统一的代码规范,有利于提高代码的可读性,减少潜在的错误,便于团队协作开发。其中是可选的,如果没有则禁用所有规则,如果有则禁用所有规则。也可以定义一个命令同时运行这两个命令,我在这里使用了我们定义了在钩子触发时会执行命令。 形成良好统一的代码规范,有利于提高代码的可读性,减少潜在的错误,便于团队协作开发。本文简单介绍JS、CSS、 Git Commit 的规范工具及用法。 Lin...

    hidogs 评论0 收藏0
  • 关于package.json管理依赖包版本的详解

      我们先说下,npm版本号定义  版本格式:X.Y.Z[-string]其含义为:  X:主版本号  Y:次版本号  Z:修正版本号  string: 先行版本号或版本编译信息  举个例子:  6.3.2-alpha的含义为:  主版本号6,有6次不可向下兼容的更新迭代。  次版本号3,有3次小的功能迭代。6.*.* <=6.3.2的依赖声明,都可以安装此新包。  修正版本号2,有2次bu...

    3403771864 评论0 收藏0
  • 项目代码的格式化统一配置 Prettier &amp; ESLint

    摘要:以前没时间过,每次项目编辑器的插件就关掉,老项目都没注意过相关的代码规范,这次新项目加入进去实践下三个插件功自动有些规则是冲突的,需要确定优先顺序,其他插件进行自定义化的配置都可以自动保存格式化的功能用和写出高质量代码在中对两者进行配置使用 以前没时间过eslint,每次项目vscode 编辑器的eslint插件就关掉eslint,老项目都没注意过相关的代码规范,这次新项目加入进去实践...

    Yu_Huang 评论0 收藏0

发表评论

0条评论

lieeps

|高级讲师

TA的文章

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