Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syu-fu/regm

An interactive command-line tool for matching regular expressions.
https://github.com/syu-fu/regm

cli deno denoland interactive regex regexp-match

Last synced: 10 days ago
JSON representation

An interactive command-line tool for matching regular expressions.

Host: GitHub
URL: https://github.com/syu-fu/regm
Owner: Syu-fu
License: mit
Created: 2024-04-30T12:47:33.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-05-01T14:22:06.000Z (7 months ago)
Last Synced: 2024-10-11T18:16:14.000Z (about 1 month ago)
Topics: cli, deno, denoland, interactive, regex, regexp-match
Language: TypeScript
Homepage: https://deno.land/x/regm
Size: 25.4 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # regm

[![ci](https://github.com/Syu-fu/regm/actions/workflows/test.yml/badge.svg)](https://github.com/Syu-fu/regm/actions/workflows/test.yml)

[![build](https://github.com/Syu-fu/regm/actions/workflows/build.yml/badge.svg)](https://github.com/Syu-fu/regm/actions/workflows/build.yml)

[![GitHub License](https://img.shields.io/github/license/Syu-fu/regm)](LICENSE)

[![deno version](https://img.shields.io/badge/deno-%5E1.40.0-green?logo=deno)](https://deno.land)

`regm` is an interactive command-line tool for matching regular expressions.  

It provides a simple interface for testing regular expressions against input text,

supporting various flavors of regular expressions such as ECMA, Basic (BRE), Extended (ERE), PCRE, Vim, and RE2.

## Install

```bash

# Deno

$ deno install --allow-env --allow-read --import-map https://deno.land/x/regm/import_map.json https://deno.land/x/regm/regm.ts --name regm --force

# Homebrew

$ brew install Syu-fu/tap/regm

```

## Example

![regm.gif](https://private-user-images.githubusercontent.com/61235023/326812632-51347b16-4308-478d-991b-00893f2d9262.gif?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTQ0ODE3MzEsIm5iZiI6MTcxNDQ4MTQzMSwicGF0aCI6Ii82MTIzNTAyMy8zMjY4MTI2MzItNTEzNDdiMTYtNDMwOC00NzhkLTk5MWItMDA4OTNmMmQ5MjYyLmdpZj9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDA0MzAlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwNDMwVDEyNTAzMVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTY0MmMxNmJjNWU2MzAwYTljZGUxN2U5ZjkxMjM0YTg5Nzg1NTAzZWM0ZjMzNDA2YjFiZTZhMDRjMjVmYWZkZmEmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.se-IJ1hxUvhpB_eyRkAfTjFH7MpmGrD9dz0-HmQ0GHA)

```bash

$ echo -e "apple\nbanana\norange\npear\ngrape\nkiwi" > match.txt

# stdout shows the input when the Enter key is pressed.

$ regm -f match.txt | pbcopy

```

## Usage

### Options

| Option            | Description                             |

| ----------------- | --------------------------------------- |

| -h, --help        | Display help information.               |

| -V, --version     | Display the version number.             |

| -f, --file  | Read input text from a file. (required) |

### Flavor options

Choose one of the following flavor options (defaults to ECMA flavor if not specified):

| Option         | Description                                                                                                          |

| -------------- | -------------------------------------------------------------------------------------------------------------------- |

| -e, --ecma     | [ECMA](https://262.ecma-international.org/12.0/#sec-regexp-regular-expression-objects) flavor. (JavaScript, Java)    |

| -b, --basic    | [Basic](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_03) flavor (BRE).(grep)      |

| -x, --extended | [Extended](https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap09.html#tag_09_04) flavor (ERE). (egrep) |

| -p, --pcre     | [PCRE](https://www.pcre.org/) flavor. (Perl, PHP)                                                                    |

| -v, --vim      | [Vim](https://vimhelp.org/pattern.txt.html) flavor. (Vim, Neovim)                                                    |

| -r, --re2      | [RE2](https://github.com/google/re2) flavor. (Go, Python)                                                            |

### Completion

#### Add .bashrc

```bash

source <(regm completions bash)

```

#### zsh

Add .zshrc

```zsh

source <(regm completions zsh)

```

#### fish

Add config.fish

```fish

source (regm completions fish | psub)

```