git-warning

v0.0.6

指定文件，在git commit提交的时候，将文件更改内容通知到微信、钉钉、飞书等聊天群或者发送到指定的邮箱 For more information about how to use this package see README

Latest version published 3 years ago

License: MIT

NPM

GitHub

Package Health Score

49 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Limited

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
0.0.6	\|	08/2021	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (0)

GitHub Stars: 49
Forks: 16
Contributors: 5

Direct Usage Popularity

The npm package git-warning receives a total of 0 downloads a week. As such, we scored git-warning popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package git-warning, we found that it has been starred 49 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Limited

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 5
Funding: No

This project has seen only 10 or less contributors.

We found a way for you to contribute to the project! Looks like git-warning is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

Commit Frequency

Open Issues: 2
Open PR: 1
Last Release: 3 years ago
Last Commit: 1 month ago

Further analysis of the maintenance status of git-warning based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for git-warning is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 3 Direct
Versions: 7
Install Size: 4.27 kB
Dist-tags: 1
# of Files: 3
Maintainers: 1
TS Typings: No

git-warning has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

git-warning

在git commit的时候，获取工作区和暂存区指定的文件与最后一次提交成功的对比的结果

实现通过微信、钉钉、飞书等聊天群机器人的webhooks，通知群内成员对比的结果
实现邮件发送，邮件通知到目标邮件对比结果

为什么需要

团队成员对项目关键的配置项或代码修改了，需要通知开发组成员修改内容，避免影响开发的规范性和统一性

安装

使用前你需要确认安装 husky

yarn add git-warning -D

配置

根目录配置antm.config.js
钉钉机器人配置的时候，安全设置需要设置为关键词“文件修改”，钉钉机器人的配置 emailReceivers、webhooks的配置支持数组和逗号隔开的字符串

module.exports = {
  warning: {
    monitorFiles: ['package.json'],
    branchs: ['master'],                    // 监听的分支，不设置的话所有的分支都监听
    webhooks: { 
      url: 'https://oapi.dingtalk.com/robot/send?access_token=xxx'  // webhooks地址，多个用数组
    },
    email: {
      sender: 'abcd@126.com',                // 发送人
      senderPass: 'ASDFGHJASD',              // 发送令牌，邮箱需要设置SMTP服务获取
      receivers: 'xxxxxx@qq.com',            // 接收人邮箱，多个用数组
    }
  }
}

命令行的使用

在husky的脚本中触发
命令行中可以配置相关配置

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

yarn lint-staged
git-warning webhooks
git-warning email

git-warning webhook的相关参数

git-warning webhooks:
  -u, --url,                             set webhooks api of dingding | wechart | Lark | others, separated by commas
  -mf, --monitor-files,         set monitor files

git-warning email的相关参数

git-warning email:
  -mf, --monitor-files,          set monitor files
  -sender, --sender,                   set the email sender
  -sender-pass, --sender-pass,     set the email sender pass
  -receivers, --receivers,          set the email receivers, separated by commas

git-warning dependencies

chalk commander nodemailer

FAQs

What is git-warning?

指定文件，在git commit提交的时候，将文件更改内容通知到微信、钉钉、飞书等聊天群或者发送到指定的邮箱. Visit Snyk Advisor to see a full health score report for git-warning, including popularity, security, maintenance & community analysis.

Is git-warning popular?

We’re still processing downloads data for the npm package git-warning. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is git-warning well maintained?

We found indications that git-warning is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is git-warning safe to use?

The npm package git-warning was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 24 April-2024, at 12:31 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (0)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

git-warning

为什么需要

安装

配置

命令行的使用

git-warning dependencies

FAQs

What is git-warning?

Is git-warning popular?

Is git-warning well maintained?

Is git-warning safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues