https://github.com/moltinginstar/xsampa.nvim
An X-SAMPA ↔ IPA converter for Neovim.
https://github.com/moltinginstar/xsampa.nvim
conlanging ipa linguistics neovim nvim phonetics phonology vim xsampa
Last synced: 7 days ago
JSON representation
An X-SAMPA ↔ IPA converter for Neovim.
- Host: GitHub
- URL: https://github.com/moltinginstar/xsampa.nvim
- Owner: moltinginstar
- License: mit
- Created: 2026-03-22T11:30:09.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2026-03-22T19:15:40.000Z (3 months ago)
- Last Synced: 2026-03-23T10:54:14.461Z (3 months ago)
- Topics: conlanging, ipa, linguistics, neovim, nvim, phonetics, phonology, vim, xsampa
- Language: Lua
- Homepage:
- Size: 11.7 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# xsampa.nvim
An X-SAMPA ↔ IPA converter for Neovim.
## Installation
### `lazy.nvim`
```lua
{
"moltinginstar/xsampa.nvim",
opts = {},
}
```
### Manual
1. Clone the repository into your Neovim package directory, for example:
```sh
git clone https://github.com/moltinginstar/xsampa.nvim ~/.local/share/nvim/site/pack/moltinginstar/start/xsampa.nvim
```
2. Add the following line to your `init.lua`:
```lua
require("xsampa").setup()
```
## Example keybindings
```lua
local xsampa = require("xsampa")
vim.keymap.set("i", "", function()
xsampa.open_converter({ from = "xsampa" })
end, { desc = "Open X-SAMPA to IPA converter" })
vim.keymap.set("n", "xi", function()
xsampa.open_converter({
from = "xsampa",
})
end, { desc = "Open X-SAMPA to IPA converter" })
vim.keymap.set("x", "xi", function()
xsampa.open_converter({
from = "xsampa",
selection = true,
})
end, { desc = "Open X-SAMPA to IPA converter for selection" })
vim.keymap.set("x", "xy", function()
xsampa.copy_selection({ from = "xsampa" })
end, { desc = "Convert selection from X-SAMPA to IPA and copy" })
vim.keymap.set("x", "xr", function()
xsampa.replace_selection({ from = "xsampa" })
end, { desc = "Convert selection from X-SAMPA to IPA in place" })
vim.keymap.set("i", "", function()
xsampa.open_converter({ from = "ipa" })
end, { desc = "Open IPA to X-SAMPA converter" })
vim.keymap.set("n", "xI", function()
xsampa.open_converter({
from = "ipa",
})
end, { desc = "Open IPA to X-SAMPA converter" })
vim.keymap.set("x", "xI", function()
xsampa.open_converter({
from = "ipa",
selection = true,
})
end, { desc = "Open IPA to X-SAMPA converter for selection" })
vim.keymap.set("x", "xY", function()
xsampa.copy_selection({ from = "ipa" })
end, { desc = "Convert selection from IPA to X-SAMPA and copy" })
vim.keymap.set("x", "xR", function()
xsampa.replace_selection({ from = "ipa" })
end, { desc = "Convert selection from IPA to X-SAMPA in place" })
```
## Commands
- `:XSampa [xsampa|ipa]`: open interactive converter
- `:[range]XSampaConvert [xsampa|ipa]`: convert range and copy result
- `:[range]XSampaConvert! [xsampa|ipa]`: convert range in place
`xsampa` is used by default if not provided.
## Using the interactive converter
- `` and `` to switch fields
- `` to confirm
- `` to return to normal mode
- `` again or `q` to cancel
The focused field is the source of truth. Editing one side will normalize the other into the plugin's canonical form.
The interactive panel uses the `xsampa` filetype. If you want to disable plugin behavior (e.g., autocomplete) inside the panel, target that filetype in your config. For example, with `nvim-autopairs`:
```lua
require("nvim-autopairs").setup({
disable_filetype = { "TelescopePrompt", "spectre_panel", "snacks_picker_input", "xsampa" },
})
```
## License
This project is licensed under the [MIT License](LICENSE).