warrah 0.1.0

Warrah: A command-line utility and Rust library that sloppily removes code comments from a text file, supporting 60+ programming languages.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

[![Crates.io](https://img.shields.io/crates/v/warrah.svg)](https://crates.io/crates/warrah)
[![CI](https://github.com/evgenyneu/warrah/actions/workflows/release.yml/badge.svg)](https://github.com/evgenyneu/warrah/actions/workflows/release.yml)
[![Tests](https://github.com/evgenyneu/warrah/actions/workflows/tests.yml/badge.svg)](https://github.com/evgenyneu/warrah/actions/workflows/tests.yml)
[![License: Unlicense](https://img.shields.io/badge/license-Unlicense-blue.svg)](UNLICENSE)

# Warrah

`warrah` is a command-line utility and a Rust library that **sloppily** removes code comments from a text file and outputs the result to stdout:

```sh
> warrah code.py
```

It's a sloppy program because it doesn't fully parse the code. It uses simple and fast logic to detect single- and multi-line comments. Consequently, it will remove comments inside strings and may result in invalid code.

The main use of this utility is to strip comments from code in order to feed it to an LLM, where occasionally incorrect code is fine. Thus the main focus here is on speed, low resource usage, language coverage and simplicity, not correctness.


## Supported languages

Warrah supports single and multi-line comments in over 60 programming and markup languages, including popular ones like:

* Python
* JavaScript/TypeScript
* Rust
* Java
* C/C++
* Go
* Ruby
* HTML/CSS
* Shell scripts
* and many more...

For a complete list of supported languages and their comment syntax, please see [docs/languages.md](docs/languages.md).

## Installation

There are three ways to install Warrah.

### Install using Cargo

First [install Rust](https://www.rust-lang.org/tools/install), then run:

```bash
cargo install warrah
```

### Homebrew

Install with [Homebrew](https://brew.sh/):

```bash
brew tap evgenyneu/warrah
brew install warrah
```

### Pre-built binaries

Download a pre-built binary from the [GitHub Releases page](https://github.com/evgenyneu/warrah/releases).

1. Download the appropriate version for your platform.
2. Move the binary to a location in your PATH.


## Usage

```bash
warrah [PATH]
```

*PATH*: The path to the code file to strip comments from. The language is auto-detected from the file name or extension.

Output goes to stdout, use `>` to save it:

```bash
warrah code.py > code_no_comments.py
```

## Rust library

See [https://crates.io/crates/warrah](https://crates.io/crates/warrah) if you want to use Warrah as a Rust library.

## Development

See [docs/development.md](docs/development.md) for instructions on how to set up the development environment.

## Contributing

See contributing guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).

## What's Warrah?

The warrah, or Falkland Islands wolf (Dusicyon australis), also known as the "Antarctic wolf," was the only native land mammal of the Falkland Islands. It was hunted by settlers for its fur and perceived threat to livestock, leading to its extinction in 1876.

<img src='./images/FalklandIslandFox2.jpg' alt='Picture of Falkland Island Fox'>

*Falkland Island fox or "Antarctic Wolf" by John Gerrard Keulemans, from St. George Mivart's Dogs, Jackals, Wolves, and Foxes: A Monograph of the Canidae, published by R. H. Porter, London, 1890. Lithography by Mintern Brothers. Source: [Wikimedia Commons](https://commons.wikimedia.org/wiki/File:FalklandIslandFox2.jpg).*

## Feedback is welcome

If you need help or notice a bug, feel free to create an issue ticket. We will be happy to help. :D

## The unlicense

This work is in [public domain](UNLICENSE).