Skip to content
Convert a TOML file in a certain format to a Visual Studio Code snippets file. Contains many useful snippets by default: https://gist.github.com/bgeron/1c0e1422890b2bbd899738b1c22ce3cc
Rust Shell PowerShell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
ci
src
.gitignore
.travis.yml
Cargo.lock
Cargo.toml
README.md
appveyor.yml
package-lock.json
package.json

README.md

Character-snippets

Commitizen friendly Travis Build Status AppVeyor Build status

A small program that generates a Visual Studio Code snippets file, with either builtin snippets (>1000 Unicode characters) or a custom TOML input file.

# Install with Rust. Alternatively, download a binary from the Releases page.
cargo install character-snippets

# Put a snippets file in a good location for Visual Studio Code on Linux. These
# snippets will be visible in all workspaces.
character-snippets --builtin > ~/.config/Code/User/snippets/chars.code-snippets

# Use a custom snippets file.
character-snippets my-custom-snippets.toml > ~/.config/Code/User/snippets/chars.code-snippets

# To find out where the snippets files are located on your operating system, run
# "Preferences: Configure User Snippets" and create a new global snippets file.

The format of the input file should be as follows:

[Snippets]
    xbrackets = "〚$1〛"
    xcheckbox = ""
    xchecked = ""
    xcheckmark = ""
    xch = ""

Visual Studio Code will interpret variables such as $1 as placeholders.

Output will be sent to standard output.

Installing

Download binaries:

→ from the GitHub releases page

Alternatively, compile from scratch on Unix:

# 1. Install Rust
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# 2. Add ~/.cargo/bin to PATH
source $HOME/.cargo/env # or log in again
# 3. We need a basic build environment (cc, ld) for a dependency
apt install build-essential
# 4. Install character-snippets
cargo install character-snippets
# 5. Profit!
character-snippets --builtin > ~/.config/Code/User/snippets/chars.code-snippets # for Linux
character-snippets src/builtin-snippets.toml > ~/.config/Code/User/snippets/chars.code-snippets

License

This project is licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

You can’t perform that action at this time.