https://github.com/rclawlor/regex-railroad.nvim

regex-railroad.nvim
https://github.com/rclawlor/regex-railroad.nvim

Last synced: 29 days ago
JSON representation

regex-railroad.nvim

• Host: GitHub
• URL: https://github.com/rclawlor/regex-railroad.nvim
• Owner: rclawlor
• License: mit
• Created: 2024-03-30T10:23:48.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-05-22T18:50:13.000Z (about 1 month ago)
• Last Synced: 2024-05-22T19:56:50.472Z (about 1 month ago)
• Language: Rust
• Size: 59.6 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• my-neovim-pluginlist - rclawlor/regex-railroad.nvim - railroad.nvim)   (Coding / Regex)

README

        
# regex-railroad.nvim

![rust workflow](https://github.com/rclawlor/regex-railroad.nvim/actions/workflows/rust.yml/badge.svg)

![lua workflow](https://github.com/rclawlor/regex-railroad.nvim/actions/workflows/lua.yml/badge.svg)

`regex-railroad.nvim` generates useful text and diagrams1 to help explain regular expressions in your code.

1 It doesn't actually do this yet, but it will!

## Getting started

### Required dependencies

- [nvim-treesitter/nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter) to extract the regular expression text

### Installation

#### lazy.nvim

```lua

-- plugins/regex-railroad.lua:

return {

    "rclawlor/regex-railroad.nvim",

    tag = "0.0.1",

    dependencies = { "nvim-treesitter/nvim-treesitter" }

}

```

## Usage

Use `:RegexText` to generate a text description of the regular expression under your cursor, or `:RegexRailroad` to instead generate a railroad diagram!

To remap the functions to something more convenient, use the following:

```lua

vim.api.nvim_set_keymap("n", "", "RegexText", {noremap = true, silent = true})

vim.api.nvim_set_keymap("n", "", "RegexRailroad", {noremap = true, silent = true})

```

## Customisation

This section explains the available options for configuring `regex-railroad.nvim`

### Setup function

```lua

require("regex-railroad").setup({

    --- Github release of plugin

    tag = "v0.0.1",

    --- Highlight group used in :RegexText

    highlight = {

        bold = true,

        fg = "fg",

        bg = "bg"

    }})

```