@cyph/username-blacklist
v1.0.0
Published
Username blacklist
Downloads
3
Readme
The-Big-Username-Blacklist
This is a opinionated blacklist of words that you might not like to see used as usernames in your service (think username.domain.com, domain.com/username or username@domain.com).
The editable blacklist can be found in list_raw.txt and is categorized into six sections:
- Privileges User privilege terms to prevent faked authority. Example: root, super
- Code: Programming terms that you might want to avoid in a url. Example: void, null
- Terms: Various technical terms. Example: request, system
- Financial: This is for the spammers/scammers. Example: payment, invoice
- Sections: Common website pages and sections. Example: faq, help
- Actions: User actions. Example: delete, create
You can try the blacklist using the tool Username checker.
Please note that this list does not contain any curse words, there are other lists for that.
How it works
This repro contains standard data files, just pick the format of your choosing.
- newline: list.txt
- json: list.json
- python: list.py
- javascript (es6): list.js
- javascript (commonjs): list-commonjs.js
- php: list.php
- yaml: list.yaml
Packages
The blacklist has both a python and node library available.
Contributing
Want to contribute? Awesome.
- Checkout the origin/develop branch
- First edit
list_raw.txt
- When you are done, run
python scripts/generate.py
. - ... This script will update the various list files.
- Done? Send a pull request.
Release start
These hooks will automatically bump the application version when using git flow release ...
chmod +x $PWD/git-hooks/bump-version.sh
ln -nfs $PWD/git-hooks/bump-version.sh .git/hooks/post-flow-release-start
ln -nfs $PWD/git-hooks/bump-version.sh .git/hooks/post-flow-hotfix-start
Git workflow and release management
This project uses gitflow and semantic versioning.
License
The-Big-Username-Blacklist is released under the MIT License.