# Regex Night

>🎶 Regex night, we come together when the code ain't right
>
>🎶 Regex night, and we'll be debuggin' 'til the morning light

Regex Night is a command-line tool to print syntax-highlighted versions of regular expressions and spot errors in them.

## Usage

Regex Night main commands are:

- `print`: print a syntax-highlighted version of the regular expression. As a tree if `--tree` is set.
- `lint`: report errors found in a regular expression.

### Examples

Let's have a look at this regex used to match phone numbers:

```
^\+?(\d[\d-. ]+)?(\([\d-. ]+\))?[\d-. ]+\d$
```

(Source: <https://www.variables.sh/complex-regular-expression-examples/>)

`regexnight print` can produce a colored version of it:

![regexnight print running](docs/print.png)

That's nice but still cryptic. We can get a more readable result with the `--tree` option:

![regexnight tree running](docs/tree.png)

Regex Night can also be used to lint regular expressions. Here is a regular expression with an unnecessary extra group:

```
Hello (?P<name>(?:\w+))!
```

Running this expression through `regexnight lint` gives us:

![regexnight lint pointing to the extra group](docs/lint.png)

### Passing regular expressions to Regex Night

Each command lets you pass a regular expression either on the command-line, via a file or by reading it from stdin:

```
regexnight print '(foo|bar)'

echo '(foo|bar)' | regexnight print

echo '(foo|bar)' > a_file
regexnight print -f a_file
```

Passing a regular expression from the command-line is handy for simple regular expressions, but can get complicated when it includes quotes or backslashes as those have to be properly escaped for the shell to pass them unaltered. In these situations it's less error-prone to write the regular expression in a file or just run the command without argument and type in the regular expression.

## Installation

### Build it yourself

If you have [Rust][] installed, run:

[Rust]: https://www.rust-lang.org/

```
cargo install regexnight
```

### Get the binary

Install with [Clyde](https://github.com/agateau/clyde):

```
clyde install regexnight
```

Or download the binary from the [release page][] and put it in your PATH.

There are only x86-64 Linux binaries for now.

[release page]: https://gitlab.com/agateau/regexnight/-/releases

## Error codes

- 0: success
- 1: IO error
- 2: Error parsing the regular expression
- 3: `regexnight lint` found some problems

## Known limitations

- Regex Night currently only supports Python regular expression syntax, because this is what I work with every day. Other syntaxes could be added.
- Some aspects of the syntax are not properly supported.