69 lines
2.6 KiB
Markdown
69 lines
2.6 KiB
Markdown
# guid.nvim
|
|
|
|
This Neovim 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 pseudo-random GUIDs. Classic Vim is not supported.
|
|
|
|
|
|
|
|
|
|
## Configuration
|
|
|
|
The plugin should be configured by calling the `setup` function. Options may be provided to override the default
|
|
settings which are shown below:
|
|
|
|
```lua
|
|
require('guid').setup({
|
|
comma_space = false,
|
|
default_style = 'd',
|
|
object_char = 'g'
|
|
})
|
|
```
|
|
|
|
These options are:
|
|
|
|
#### `comma_space`
|
|
Specifies if commas should be followed by spaces in GUIDs formatted with the `x` and `X` specifiers.
|
|
|
|
#### `default_style`
|
|
Specifies which format to use if one is not provided for `GuidInsert` and `GuidFormat` commands.
|
|
|
|
#### `object_char`
|
|
Specifies which character should be used for the GUID text object.
|
|
|
|
## GUID Formatting
|
|
|
|
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
|
|
GUID text representation. The case of the format specifier determines whether lowercase or uppercase will be used.
|
|
|
|
| Format | Example |
|
|
| - | - |
|
|
| <kbd>n</kbd> | `cbb297c014a940bc8d911d0ef9b42df9` |
|
|
| <kbd>N</kbd> | `CBB297C014A940BC8D911D0EF9B42DF9` |
|
|
| <kbd>d</kbd> | `cbb297c0-14a9-40bc-8d91-1d0ef9b42df9` |
|
|
| <kbd>D</kbd> | `CBB297C0-14A9-40BC-8D91-1D0EF9B42DF9` |
|
|
| <kbd>b</kbd> | `{cbb297c0-14a9-40bc-8d91-1d0ef9b42df9}` |
|
|
| <kbd>B</kbd> | `{CBB297C0-14A9-40BC-8D91-1D0EF9B42DF9}` |
|
|
| <kbd>p</kbd> | `(cbb297c0-14a9-40bc-8d91-1d0ef9b42df9)` |
|
|
| <kbd>P</kbd> | `(CBB297C0-14A9-40BC-8D91-1D0EF9B42DF9)` |
|
|
| <kbd>x</kbd> | `{0xcbb297c0,0x14a9,0x40bc,{0x8d,0x91,0x1d,0x0e,0xf9,0xb4,0x2d,0xf9}}` |
|
|
| <kbd>X</kbd> | `{0xCBB297C0,0x14A9,0x40BC,{0x8D,0x91,0x1D,0x0E,0xF9,0xB4,0x2D,0xF9}}` |
|
|
|
|
## GUID Commands
|
|
|
|
#### `GuidInsert [format]`
|
|
Inserts a GUID at the cursor position using the default or provided format.
|
|
|
|
#### `GuidFormat [format]`
|
|
Formats the GUID at the cursor position using the default or provided format.
|
|
|
|
#### `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 text representations described above. Be sure to call `setup` if you wish to use GUID text objects.
|