hotoo / .gitblacklist

Check and Reject certain words commit into git repository.

GIT blacklist checker

---

GIT - pre-commit check and reject certain words/phrases/functions commit into git repository.

Install

$ npm install gitblacklist -g

Usage

$ gitblacklist init

Configuration

gitblacklist use following blacklist files to definition blacklist for certain words/phrases/functions.

• REPO_ROOT/.gitblacklist.[ext]
• REPO_ROOT/.gitblacklist
• ~/.gitblacklist.[ext]
• ~/.gitblacklist

description:

• REPO_ROOT/.gitblacklist.[ext] and ~/.gitblacklist.[ext] is for specifically filetype.
• .gitblacklist and ~/.gitblacklist is for all of files.
• REPO_ROOT/.gitblacklist.[ext] and REPO_ROOT/.gitblacklist is for current repository.
• ~/.gitblacklist.[ext] and ~/.gitblacklist is for all of current user's repository.

Pre-line a certain words/phrases/functions.

Example

To check for "TODO" or "FIXME" in a java file, create the file {REPO_ROOT}/.gitblacklist.java containing the two lines:

TODO
FIXME

Bugs

For any bugs, please visit issues

.gitblacklist's Issues

更好的检查 add 的内容，而不是检查文件最后的内容

$ git add .
文件有敏感内容，但添加成功。
$ git commit
文件有敏感内容， commit 失败
$ vi somefile
清理敏感内容。
$ git commit -m ""
提交了带有敏感内容的文件，虽然这个敏感内容被修复。
$ git status
M somefile
$ git add .
$ git commit -m ""
虽然重复提交修复了敏感内容，但是并未解决之前提交的敏感内容。

需要一个类似 pre-add 的 hooks。

文件名中存在空格时，被当作两个文件处理

File: wki/The World Browser.md

$ git ci
grep: "wiki/The: No such file or directory
grep: "wiki/The: No such file or directory
grep: "wiki/The: No such file or directory
grep: "wiki/The: No such file or directory
grep: "wiki/The: No such file or directory
grep: "wiki/The: No such file or directory
grep: "wiki/The: No such file or directory
grep: World: No such file or directory
grep: World: No such file or directory
grep: World: No such file or directory
grep: World: No such file or directory
grep: World: No such file or directory
grep: World: No such file or directory
grep: World: No such file or directory
grep: Browser.md": No such file or directory
grep: Browser.md": No such file or directory
grep: Browser.md": No such file or directory
grep: Browser.md": No such file or directory
grep: Browser.md": No such file or directory
grep: Browser.md": No such file or directory
grep: Browser.md": No such file or directory

支持全局的 ~/.gitblacklist

~/.gitblacklist
~/.gitblacklist.[ext]

性能优化，预装载 blacklist

当文件名中有 A 或 M 字符时，可能误判为 git status 类型