snip-cli
| Crates.io | snip-cli |
| lib.rs | snip-cli |
| version | |
| source | src |
| created_at | 2023-12-19 09:58:37.491624 |
| updated_at | 2024-12-09 04:45:31.057156 |
| description | A CLI tool (snip-cli) for managing Neovim and VSCode snippets |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1074150 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
Uriah Galang (codeitlikemiley)
documentation
README
A CLI (snip-cli) Tool for Managing Neovim and VSCode Snippets
Note: This is an additional tools to be used with my Neovide Neovim rust setup.
VSCode Snippet Compatible
Installation
- You can Download and Install snip-cli on Releases Page Note: on MacOS you might need to go to System Preferences > Security & Privacy > General and click Open Anyway to install it
Note: on Windows you might need to Add the command to ENV PATH
- Install it using Cargo
cargo install snip-cli --bin snip
Managing Multiple Snippets File for Different Languages
You can use the command snip config <path> to change the Snippets File on Runtime.
Note: This is quite useful when you want to manage different Snippets File for different languages.
Location of Config Path
The DEFAULT_CONFIG_PATH is ~/.config/nvim/snippets/rust/rust.json as set on src/constants.rs and is used during the build process,
but you can change it by setting the SNIP_CONFIG_PATH environment variable.
Usage:
- Help
snip
# or
snip --help
Output
snip
/Users/uriah/.config/nvim/snippets/rust/rust.json
A CLI tool for managing Neovim LuaSnip Rust snippets
Usage: snip <COMMAND>
Commands:
add Adds entry to Snippet Collection file
rm Removes entry from Snippet Collection file
edit Edits entry in Snippet Collection file
ls Lists all entries in Snippet Collection file
show Gets entry from Snippet Collection file
search Searches for entries in Snippet Collection file
config Configures the Snippet Collection file
update-key
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
-V, --version Print version
- Add new snippet
# help
snip add --help
# Add Snippet
snip add --key <key> --value <value> --description <description> -- "<snippet>"
- Remove snippet
# help
snip remove --help
# Remove Snippet
snip remove --key <key>
- List all snippets
# help
snip ls --help
# Usage
snip ls <LIST_OPTION | (key or prefix)>
# List all Keys
snip ls key
# List all Prefixes
snip ls prefix
Output
snip ls key
/Users/uriah/.config/nvim/snippets/rust/rust.json
[src/main.rs:468] list_option = Key
impl_iterator
serialize_to_json_string
impl_add_trait
impl_vec_iterator
unwrap_or_else
impl_deref
impl_debug_single_field
deserialize_json_string
impl_display_single_field
import_serde_traits
impl_clone_single_field
- Update Key
# help
snip update-key --help
# Update Key
snip update-key --old-key <old-key> --new-key <new-key>
Output
snip update-key --old-key "Fuzz match String" --new-key "fuzzy-match-string"
/Users/uriah/.config/nvim/snippets/rust/rust.json
[src/main.rs:499] &old_key = "Fuzz match String"
[src/main.rs:499] &new_key = "fuzzy-match-string"
- Update Snippet
# help
snip edit --help
# Update snippet Value
snip edit --key <key> --prefix <prefix> --description <description> -- "<snippet>"
- Search Snippet
# help
snip search --help
# Search Snippet
snip search <ID | (key or prefix)> -- "<search_term>"
Output
snip search key -- impl
/Users/uriah/.config/nvim/snippets/rust/rust.json
[src/main.rs:490] id = Some(
Key,
)
[src/main.rs:490] &name = "impl"
impl_deref
impl_clone_single_field
impl_iter_range
impl_partialeq_single_field
- Show Snippet
# help
snip show --help
# Show Snippet
snip show <key_id>
Output
snip show impl_deref
/Users/uriah/.config/nvim/snippets/rust/rust.json
[src/main.rs:484] &key = "impl_deref"
+-------------+-------------------------------------------------------------+
| Key | impl_deref |
+-------------+-------------------------------------------------------------+
| Prefix | impl_deref |
+-------------+-------------------------------------------------------------+
| Description | Impl Deref and DerefMut traits for a custom type |
+-------------+-------------------------------------------------------------+
| Body | use std::ops::{Deref, DerefMut}; |
| | |
| | impl<${1:T}> Deref for ${2:YourConcreteStruct}<${1:T}> { |
| | type Target = ${1:T}; |
| | fn deref(&self) -> &Self::Target { |
| | &self.${3:your_field} |
| | } |
| | } |
| | |
| | impl<${1:T}> DerefMut for ${2:YourConcreteStruct}<${1:T}> { |
| | fn deref_mut(&mut self) -> &mut Self::Target { |
| | &mut self.${3:your_field} |
| | } |
| | } |
+-------------+-------------------------------------------------------------+
- Config Snippet Note: This can be used to switch Configuration e.g. you wanna manage Python Snippet , you can do just pass in the PATH to that configuration file.
# help
snip config --help
# Config Snippet
snip config <path>
- Edit Config
snip open
# or we can pass in the editor command e.g. code
snip open --editor code
This will open the configuration file in the default editor, or the editor specified with the --editor flag.