Skip to content

Static code analysis that looks for swear words in your codebase

License

Notifications You must be signed in to change notification settings

cesarferreira/swearjar

Repository files navigation

SwearJar

⚡ Static analysis tool that scans your code for swear words

Features

  • Recursive directory scanning
  • Case-insensitive swear word matching
  • Highlighting of swear words within the text
  • Ability to command+click the offending line
  • Summary of findings with counts per file and total
  • Ability to ignore certain directories and file types

Usage

After installation, you can use the tool by simply typing swearjar in the terminal, within any directory you want to scan:

swearjar

Install

To install this tool on your system, follow these steps:

  1. Ensure you have Python 3.x installed on your system.
  2. Clone the repository to your local machine.
  3. Navigate to the root directory of the project.
  4. Run the install.sh script with the following command:
./install.sh

Requirements

  • Python 3.x
  • Terminal that supports ANSI escape sequences for colored output

Created by

Cesar Ferreira

License

MIT © Cesar Ferreira

About

Static code analysis that looks for swear words in your codebase

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published