A C++ code formatter based on Clang Format, for beautiful code with minimal effort in Sublime Text 3
- Total 11K
- Win 4K
- OS X 3K
- Linux 4K
|May 5||May 4||May 3||May 2||May 1||Apr 30||Apr 29||Apr 28||Apr 27||Apr 26||Apr 25||Apr 24||Apr 23||Apr 22||Apr 21||Apr 20||Apr 19||Apr 18||Apr 17||Apr 16||Apr 15||Apr 14||Apr 13||Apr 12||Apr 11||Apr 10||Apr 9||Apr 8||Apr 7||Apr 6||Apr 5||Apr 4||Apr 3||Apr 2||Apr 1||Mar 31||Mar 30||Mar 29||Mar 28||Mar 27||Mar 26||Mar 25||Mar 24||Mar 23||Mar 22||Mar 21|
What it does
Clang-format is a tool for re-formatting C++, built on LLVM. This is a package that allows you to run it easily from within Sublime Text.
In this package, we provide an alternative wrapper around clang-format for use within Sublime Text 3. Whilst LLVM does provide a very simple plugin to work with Sublime Text already: https://llvm.org/svn/llvm-project/cfe/trunk/tools/clang-format/clang-format-sublime.py, it doesn't really exploit any of the Sublime Text package functionality. We add new features such as customising the style from a settings file, selecting styles using the Command Palette, and easier installation.
- Install this package through Package Control in the usual way.
- Get the clang-format binary for your platform. All binaries provided below are from the LLVM 3.6 release. They are for 64-bit platforms only:
If you prefer, you can download the entire LLVM toolchain
and extract the
clang-format binary yourself. Just extract the
file and copy
bin/clang-format into your PATH (e.g.
- Set the path to the clang-format binaries. You can do this from within Sublime
Text by choosing
Clang Format - Set Path from the command palette. Hint:
the path should look something like this
If clang-format is in your system path, you shouldn't need to do anything.
- Default shortcut is
super+option+aon OSX and
ctrl+option+aotherwise. This will apply clang-format to the selection.
- From the command palette, you can select the formatting type by using
Clang Format: Select Style. You will find the small number of defaults, and also a new 'Custom' entry. Selecting this entry allows you to customise the style through a settings file. You can access it from the main menu, under
Package Settings. In this file you can add custom rules, such as
Allmenstyle braces, and different indents. For examples see http://clang.llvm.org/docs/ClangFormatStyleOptions.html.
- Settings for the 'Custom' format and others are available through the Sublime Text preferences.
- It is possible to enable the formatter on every save to a C/C++ file. To change settings on a per-package basis, check out the package “Project-Specific”.
If You Liked This
… And want to contribute, PR's gladly accepted!
Maybe you'll like my other plugin, iOpener. It lets you open files by path, with completion, history, and other goodies.
Otherwise, why not pop on over and star this repo on GitHub?
Thanks to the LLVM project for doing the hard work, including writing clang format, and also the original Sublime Text plugin on which this package is based.
Why not go and watch the video that got me interested in clang-format in the first place?