Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
SublimeAStyleFormatter is a code formatter/beautifier for Sublime Text 2 & 3. It provides ability to format C/C++/C#/Java files.
Python JavaScript Shell
Failed to load latest commit information.
AStyleFormatterLib Fix `AttributeError` for RangeError class
messages Add messages for v3.1.2
pyastyle Update Windows binaries for pyastyle, thanks to appveyor
src Update bundling pyastyle source submodule
tests Fix unit tests, load defaults before run
.gitignore Fix build script
.gitmodules Add build script for pyastyle
.no-sublime-package No longer a zip through Package Control, fix #15
.travis.yml Add travis file for testing
AStyleFormat.py Strip invalid options before run. #39
AStyleFormatter.sublime-commands Give a proper name for sublime-commands file
CHANGELOG.md Add messages for v3.1.2
Context.sublime-menu set context menu id
DONORS.md Thanks for your support πŸ˜„
Default (Linux).sublime-keymap add sidebar/context commands
Default (OSX).sublime-keymap add sidebar/context commands
Default (Windows).sublime-keymap add sidebar/context commands
LICENSE Upgrade pyastyle module and build script, for astyle v2.05.1
Main.sublime-menu Fix wrong user keymap setting file location, fixes #27
README.md Update build badges to README file
Side Bar.sublime-menu Fix license header from borrowed GoSublime source
SublimeAStyleFormatter.sublime-settings Remove 'conver-tabs' options, use ST instead
appveyor.yml Add appveyor file for testing
dump_default_options Besides refactor, use tab settings from Sublime Text itself by default
messages.json Add messages for v3.1.1
options_default.json Remove 'conver-tabs' options, use ST instead
package.json Handles Objective-C and Objective-C++ files
unittesting.json Add test for `astyleformat' command

README.md

Sublime Text 2 & 3 AStyle Formatter Plugin

Travis-CI Build Status AppVeyor Build Status

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-2015 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.