Skip to content
This repository

SublimeAStyleFormatter is a code formatter/beautifier for Sublime Text 2 & 3. It provides ability to format C/C++/C#/Java files.

Octocat-spinner-32 AStyleFormatterLib Support new options in astyle v2.04
Octocat-spinner-32 messages Update readme, split changelog separately
Octocat-spinner-32 pyastyle Update pyastyle binaries for win, astyle v2.04
Octocat-spinner-32 src Update astyle to v2.04
Octocat-spinner-32 .gitignore Add support for Mac OS X.
Octocat-spinner-32 .gitmodules Add build script for pyastyle
Octocat-spinner-32 .no-sublime-package No longer a zip through Package Control, fix #15
Octocat-spinner-32 AStyleFormat.py Fix non-functional setting: `user_defined_syntax_mode_mapping'
Octocat-spinner-32 AStyleFormatter.sublime-commands Give a proper name for sublime-commands file
Octocat-spinner-32 CHANGELOG.md Update readme, split changelog separately
Octocat-spinner-32 Context.sublime-menu set context menu id
Octocat-spinner-32 DONORS.md update readmes; update donors list
Octocat-spinner-32 Default (Linux).sublime-keymap add sidebar/context commands
Octocat-spinner-32 Default (OSX).sublime-keymap add sidebar/context commands
Octocat-spinner-32 Default (Windows).sublime-keymap add sidebar/context commands
Octocat-spinner-32 LICENSE Add license file
Octocat-spinner-32 Main.sublime-menu Fix wrong user keymap setting file location, fixes #27
Octocat-spinner-32 README.md Update readme, split changelog separately
Octocat-spinner-32 Side Bar.sublime-menu Fix license header from borrowed GoSublime source
Octocat-spinner-32 SublimeAStyleFormatter.sublime-settings Support new options in astyle v2.04
Octocat-spinner-32 dump_default_options Improved options overriding for error-prone 'options_default'
Octocat-spinner-32 messages.json Update readme, split changelog separately
Octocat-spinner-32 options_default.json Update readme
Octocat-spinner-32 package.json Handles Objective-C and Objective-C++ files
README.md

Sublime Text 2 & 3 AStyle Formatter Plugin

Description

SublimeAStyleFormatter is a simple code formatter plugin for Sublime Text. It provides ability to format C, C++, Cuda-C++, OpenCL, Arduino, C#, and Java files.

NOTE: Syntax files required to be installed separately for Cuda-C++ and OpenCL.

Donation

If you find my work useful, please consider buying me a cup of coffee, all donations are much appreciated :)

Donate via PayPal

Installation

With the Package Control plugin

The easiest way to install SublimeAStyleFormatter is through Package Control.

Once you have Package Control installed, restart Sublime Text.

  1. Bring up the Command Palette (Ctrl+Shift+P on Windows and Linux. ++P on OS X).
  2. Type "Install" and select "Package Control: Install Package".
  3. Select "SublimeAStyleFormatter" from list.

The advantage of using Package Control is that it will keep SublimeAStyleFormatter up to date.

Manual Install

Without Git:

Download the latest source code, and extract it to the Packages directory.

With Git:

Type the following command in your Sublime Text 2 or Sublime Text 3 Packages directory:

git clone git://github.com/timonwong/SublimeAStyleFormatter.git

The "Packages" directory is located at:

Sublime Text 2

  • Windows: %APPDATA%\Sublime Text 2\Packages
  • Linux: ~/.config/sublime-text-2/Packages/
  • OS X: ~/Library/Application Support/Sublime Text 2/Packages/

Sublime Text 3

  • Windows: %APPDATA%\Sublime Text 3\Packages
  • Linux: ~/.config/sublime-text-3/Packages/
  • OS X: ~/Library/Application Support/Sublime Text 3/Packages/

Usage

Key Bindings

The default key bindings for this plugin:

Windows, Linux:

  • Ctrl+Alt+F: Format current file.
  • Ctrl+K, Ctrl+F: Format current selection.

OSX:

  • Ctrl+Alt+F: Format current file.
  • +K, +F: Format current selection.

Command Palette

Open the command palette, it appears as SublimeAStyleFormatter: Format Current File and SublimeAStyleFormatter Format Current Selection.

Settings

Per-project Settings

Before starting, you may want to have a look at SublimeAStyleFormatter.sublime-settings.

To edit your project setting, select Project/Edit Project from main menu. A project setting contains per-project settings for SublimeAStyleFormatter should look like this:

{
    "settings":
    {
        "AStyleFormatter":
        {
        }
    }
}

For example, if you don't want to inherit the default settings, instead, use your own astylerc file for C and C++ individually, then your project setting might look like this:

{
    // project folders, etc
    // ...
    // project settings
    "settings":
    {
        "AStyleFormatter":
        {
            "options_default":
            {
                // Use 2 spaces for indentation
                "indent": "spaces",
                "indent-spaces": 2
            },
            "options_c":
            {
                "use_only_additional_options": true,
                "additional_options_file": "/path/to/your/astylerc/for/c"
            },
            "options_c++":
            {
                "use_only_additional_options": true,
                "additional_options_file": "/path/to/your/astylerc/for/c++"
            }
        }
    }
}

What's New

CHANGELOG.md

License

This plugin is using MIT License:

Copyright (c) 2012 Timon Wong

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Credits

Artistic Style - A Free, Fast and Small Automatic Formatter for C, C++, C#, and Java Source Code.

Licensed under GNU Lesser General Public License version 3.0

Donors

DONORS.md

Something went wrong with that request. Please try again.