https://github.com/aosasona/stripr
Remove those nasty comments from your code.
https://github.com/aosasona/stripr
cli golang
Last synced: 4 months ago
JSON representation
Remove those nasty comments from your code.
- Host: GitHub
- URL: https://github.com/aosasona/stripr
- Owner: aosasona
- Created: 2022-09-01T13:20:36.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-29T14:04:29.000Z (over 3 years ago)
- Last Synced: 2024-05-01T13:39:11.462Z (about 2 years ago)
- Topics: cli, golang
- Language: Go
- Homepage:
- Size: 16.3 MB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Stripr CLI
Stripr can find and remove those nasty (debug) comments you left in your code, because why not?
### Current Limitations
- Only supports C-style comments
- Only supports flat directories (no subdirectories)
## Installation
### Using Homebrew
You can install stripr using Homebrew if you're on macOS or Linux. You can install Homebrew [here](https://brew.sh/).
```bash
brew tap aosasona/stripr
```
This will add the tap to your Homebrew installation so you can install the latest version of Stripr using the following command:
```bash
brew install stripr
```
### Manual Installation
Stripr has been written in Golang which is a compiled language, so you will need to install the Golang compiler to build the binary or you can get a pre-built binary for your machine from [this link](https://github.com/aosasona/stripr/releases) (Linux, Windows, macOS) and [extract them to your PATH](https://zwbetz.com/how-to-add-a-binary-to-your-path-on-macos-linux-windows/).
If you would like to build the binary yourself, you can do so by running the following command:
```bash
make build-release
```
OR
```bash
make build-auto
```
The `build-release` will build the binary for your current OS and architecture and place it in the `release` directory and `build-auto` will do the same but place it in the build directory with a sub-folder named after your OS and architecture. By default, the `build` folder is set to ignored by git for this project but you can build for **ALL** platforms locally by running the following command:
```bash
make build-all
```
You could tinker with the Makefile to build for other platforms, but I have not tested it outside Unix at the moment, let me know if you have any issues.
## Usage
```bash
stripr [options] [command]
```
Example:
```bash
stripr -target=./example -skip-check -show-stats strip
```
## Options
- `-target=string`
*The directory or file to read (default "." - current directory)*
- `-show-stats=true|false`
*Show the number of files and lines that will be affected*
- `-skip-check=true|false`
*Skip the confirmation prompt before stripping comments*
## Commands
- `init`
*Create a config file in the current directory*
- `scan`
*Scan the directory for comments*
- `strip` | `clean`
*Remove comments from the directory (-skip-check to prevent asking for confirmation; use with caution)*
`help`
*Show the help message*
## Contributing
You can contribute to this project by opening an issue or a pull request, I will try to respond as soon as possible. This was a fun little project to work on to learn Golang and I hope you find it useful at some point.