ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Clang Format

by rosshemsley ST3

A C++ code formatter based on Clang Format, for beautiful code with minimal effort in Sublime Text 3

Details

  • 1.3.3
  • github.​com
  • github.​com
  • 12 months ago
  • 56 minutes ago
  • 3 years ago

Installs

  • Total 19K
  • Win 7K
  • OS X 5K
  • Linux 7K
May 24 May 23 May 22 May 21 May 20 May 19 May 18 May 17 May 16 May 15 May 14 May 13 May 12 May 11 May 10 May 9 May 8 May 7 May 6 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
Windows 5 4 13 6 8 6 16 18 14 6 4 5 10 14 12 5 8 5 8 8 18 10 8 8 6 9 13 14 13 1 8 6 7 13 12 8 25 11 13 11 6 9 23 18 12 6
OS X 1 5 2 3 5 6 5 3 6 8 5 2 8 8 8 4 14 2 6 6 6 9 7 7 3 5 8 2 4 12 8 5 10 9 11 7 7 5 7 4 8 7 7 6 10 2
Linux 7 13 11 11 8 11 15 24 12 11 7 7 11 10 9 17 24 5 7 16 13 17 12 13 8 7 15 16 17 14 9 11 15 16 20 10 15 12 10 8 13 12 16 16 11 10

Readme

Source
raw.​githubusercontent.​com

Clang Format

Package Control

What it does

Clang-format is a tool for formatting C++, built on LLVM. This is a package that allows you to run it easily from within Sublime Text.

demo

About

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 here, 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.

Installing

  • Download the entire LLVM toolchain and extract the clang-format binary. Just extract the .tar.xz file and copy bin/clang-format into your PATH (e.g. /usr/local/bin).
  • Install this package through Package Control in the usual way.
  • 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 [path/to/clang]/clang/bin/clang-format. If clang-format is in your system path, you shouldn't need to do anything.

Use

  • Default shortcut is super+option+a on OSX and ctrl+option+a otherwise. 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 Allmen style 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 run the formatter on every save to a file, change settings to "format_on_save": true.
  • To change settings on a per-package basis, add them under ClangFormat key, example project.sublime-settings:
{
  "folders": [],
  "settings": {
    "ClangFormat": {
      "format_on_save": true
    }
  }
}

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?

Credits

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.

Also thanks to y0ssar1an, Bendtherules and other contributors for their improvements!

Finally

Why not go and watch the video that got me interested in clang-format in the first place?

The Care and Feeding of C++'s Dragons