guid.nvim/README.md

# guid.nvim

This Neovim-exclusive plugin simplifies common operations when working with [Globally Unique
Identifiers](https://en.wikipedia.org/wiki/Universally_unique_identifier) (GUIDs). The produced values fully conform to
the [RFC 4122](https://www.rfc-editor.org/rfc/rfc4122) spec for for pseudo-random GUIDs.

![](img/guid.nvim.gif)

## GUID Styles

There are several ways to represent GUIDs as text. The format specifier syntax outlined by
[Guid.ToString](https://learn.microsoft.com/en-us/dotnet/api/system.guid.tostring?view=net-7.0) is borrowed for styling
text output. This convention is expanded to allow the casing of hexadecimal characters to be specified. The casing of
the format specifier determines whether lowercase or uppercase will be used.

*   `n` `00000000000000000000000000000000` \
    32 digits.

*   `d` `00000000-0000-0000-0000-000000000000` \
 	32 digits separated by hyphens.

*   `b` `{00000000-0000-0000-0000-000000000000}` \
 	32 digits separated by hyphens, enclosed in braces.

*   `p` `(00000000-0000-0000-0000-000000000000)` \
 	32 digits separated by hyphens, enclosed in parenthesis.

*   `x` `{0x00000000,0x0000,0x0000,{0x00,0x00,0x00,0x00,0x00,0x00,0x00,0x00}}` \
    Four hexadecimal values enclosed in braces, where the fourth value is a subset of eight hexadecimal values that is also enclosed in braces.

## GUID Commands

*   `GuidInsert [style]` \
    Inserts a GUID at the cursor position using the default or provided style.

*   `GuidFormat [style]` \
    Formats the GUID at the cursor position using the default or provided style.

*   `GuidObject` \
    Selects the GUID at the cursor position (useful for text objects).

## GUID Text Object

A custom text object for GUIDs is provided. By default it is bound to the `g` key. For example to yank a GUID you would
input `yig` in normal mode (the functionally identical `yag` can also be used). The GUID text object supports all of the
GUID formatting styles described above. Make sure to call `setup` if you wish to use GUID text objects (details in the
next section).

## Configuration

The plugin should be configured by calling the `setup` function. Options can be optionally provided if you wish to
override the default settings, which are shown below:

```lua
require('guid').setup({
    comma_space = false,
    default_style = 'd',
    object_char = 'g'
})
```

More specifically, these options are:

*   `comma_space` \
    Determines if commas should be followed by spaces in GUIDs formatted with the `x` specifier.

*   `default_style` \
    Determines what style to use if one is not provided for `GuidInsert` and `GuidFormat` commands.

*   `object-char` \
    Determines which character should be used for the GUID text object.