个人整理的代码规范&提交规范

1. 统一使用AlibabaCode代码规范校验

以idea开发工具为准
在Prefercences -> Plugins -> marketPlace 路径下
安装AlibabaCoding Guidlines 。
在每次提交代码前,务必使用该工具进行代码检测。

安装完毕后 右键项目 => 代码规范检测 在下方可看到不符合规范的代码

2. git提交规范

下载:git clone https://github.com/blog-plat-dev/convention-git.git

安装方式:
将commit-msg 覆盖掉项目中 ./git/hooks/路径下的commit-msg.sample

主要的Type操作符:

  • Init 项目初始化
  • Feat 增加新功能
  • Remove
  • Delete
  • Move
  • New
  • Add
  • Patch 补丁
  • Fix 修复bug
  • Test 测试

案例 提交方式:[Add] message

Shell代码:

# !/bin/bash

filename=$1

# read commit message in file
content=$(cat $1)

COMMIT_MESSAGE_CONVENTION_REGEX='^(\[(Init|Update|Remove|Move|Delete|New|Add|Patch|Fix)\]) .+$';
COMMIT_MESSAGE_OPERATION_SYMBOL_REGEX='^\[.+\]'
COMMIT_MESSAGE_SPACE_REGEX='^\[.+\] '
COMMIT_MESSAGE_MESSAGE_REGEX='^\[.+\] .+$'
COMMIT_MESSAGE_OPERATION_REGEX='^\[.+\] .+'

print_red_msg(){
  echo -e "\033[31m${1}\033[0m"
}

print_error_msg(){
  print_red_msg "[CommitMessageError]$1"
  print_red_msg "\nExample: [Init] this is a commit message"
  exit 1
}

if [[ ! $content =~ $COMMIT_MESSAGE_CONVENTION_REGEX ]]
then
  # check []
  if [[ ! $content =~ $COMMIT_MESSAGE_OPERATION_SYMBOL_REGEX ]]
  then
    print_error_msg "Missing '['"
  fi

  # check space
  if [[ ! $content =~ $COMMIT_MESSAGE_SPACE_REGEX ]]
  then
    print_error_msg "Missing blank space"
  fi

  if [[ ! $content =~ $COMMIT_MESSAGE_MESSAGE_REGEX ]]
  then
    print_error_msg "Missing message of commit"
  else
    print_error_msg "Please make sure your operation is correct\nOperations: Init|Update|Remove|Delete|New|Add|Patch|Fix"
  fi
fi
阅读终点,创作起航,您可以撰写心得或摘录文章要点写篇博文。去创作
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值