Skip to content

Latest commit

 

History

History

examples

README.md

Examples

This directory contains examples and templates for various configuration files. Using these typically involves copying the files to a project, possibly renaming them, and customizing their contents as needed.

Example name Destination name Destination folder Use with
_clang-format .clang-format Project clang-format
_clangd .clangd Project clangd
_gutctags .gutctags Project vim-gutentags
_projections.json .projections.json Project vim-projectionist
c.snippets Same ~/.config/nvim/UltiSnips/specific ultisnips
compile_flags.txt Same Project clangd
projects.vim Same ~/.config/nvim vim-project
pyrightconfig.json Same Project pyright

Additional notes:

  • .gutctags: See g:gutentags_project_root
  • projects.vim: See vim-project Neovim config
  • c.snippets: See g:UltiSnipsSnippetDirectories
  • pyrightconfig.json: pyright can read type stubs placed in the typings directory. See also the stubPath option and Generating Type Stubs.

Windows Terminal JSON fragment extensions

Windows Terminal allows profiles to be added or modified outside of the main settings file through JSON fragment extensions. Some examples of these extensions are available here, with their names ending -fragment.json. These files must be placed in the proper directories.

Summarizing from the docs, extensions for the current user would be added as:

$Env:LocalAppData/Microsoft/Windows Terminal/Fragments/{app-name}/{file-name}.json

The {app-name} must match the corresponding source field of the profile in the main Windows Terminal settings.json.

For this case, the MSYS2 fragment would be added as:

$Env:LocalAppData/Microsoft/Windows Terminal/Fragments/MinGW/MSYS2.json

Recall from the docs that the actual file name of the JSON does not matter.

See also the Dynamic profiles page for additional examples of JSON contents.