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

Code​Formatter

by Avtandil Kikabidze aka LONGMAN ST2/ST3 Top 100

Code Formatter plugin for ST2/ST3

Details

  • 3 4.1.1
    3.8.0
  • github.​com
  • github.​com
  • 4 months ago
  • 3 hours ago
  • 7 years ago

Installs

  • Total 241K
  • Win 149K
  • OS X 57K
  • Linux 35K
Sep 19 Sep 18 Sep 17 Sep 16 Sep 15 Sep 14 Sep 13 Sep 12 Sep 11 Sep 10 Sep 9 Sep 8 Sep 7 Sep 6 Sep 5 Sep 4 Sep 3 Sep 2 Sep 1 Aug 31 Aug 30 Aug 29 Aug 28 Aug 27 Aug 26 Aug 25 Aug 24 Aug 23 Aug 22 Aug 21 Aug 20 Aug 19 Aug 18 Aug 17 Aug 16 Aug 15 Aug 14 Aug 13 Aug 12 Aug 11 Aug 10 Aug 9 Aug 8 Aug 7 Aug 6 Aug 5
Windows 58 87 91 57 47 49 51 100 77 90 73 48 44 80 90 111 95 94 50 45 73 88 110 77 88 41 67 78 78 75 97 83 33 46 90 77 81 84 85 42 39 87 104 97 94 85
OS X 19 25 8 22 11 0 16 22 18 26 27 13 14 23 19 22 15 20 10 7 24 25 15 20 20 17 12 24 22 19 17 26 7 8 26 19 24 28 14 9 8 25 28 19 25 22
Linux 13 17 16 18 5 10 19 12 22 15 23 7 12 10 15 13 24 9 4 5 12 21 14 23 18 12 7 17 15 13 15 13 10 6 14 9 20 23 15 9 7 18 17 18 16 13

Readme

Source
raw.​githubusercontent.​com

Build Status

CodeFormatter

CodeFormatter is a Sublime Text 2/3 plugin that supports format (beautify) source code.

CodeFormatter has support for the following languages:

  • PHP - By phpF
  • JavaScript/JSON - By JSBeautifier
  • HTML - By Custom fork of BeautifulSoup
  • CSS,LESS,SASS - By JSBeautifier
  • Python - By PythonTidy (only ST2)
  • Visual Basic/VBScript
  • Coldfusion/Railo/Lucee

Sponsors

No sponsors yet.. :(

If you like the software, don't forget to donate to further development of it!

PayPal donate button

Installing

With the Package Control plugin: The easiest way to install CodeFormatter is through Package Control, which can be found at this site: http://wbond.net/sublime_packages/package_control

Once you install Package Control, restart Sublime Text and bring up the Command Palette (Command+Shift+P on OS X, Control+Shift+P on Linux/Windows). Select “Package Control: Install Package”, wait while Package Control fetches the latest package list, then select CodeFormatter when the list appears. The advantage of using this method is that Package Control will automatically keep CodeFormatter up to date with the latest version.

Without Git: Download the latest source from GitHub and copy the CodeFormatter folder to your Sublime Text “Packages” directory.

With Git: Clone the repository in your Sublime Text “Packages” directory:

git clone https://github.com/akalongman/sublimetext-codeformatter.git CodeFormatter

The “Packages” directory is located at:

  • OS X:

    ST2: ~/Library/Application Support/Sublime Text 2/Packages/
    ST3: ~/Library/Application Support/Sublime Text 3/Packages/
    
  • Linux:

    ST2: ~/.config/sublime-text-2/Packages/
    ST3: ~/.config/sublime-text-3/Packages/
    
  • Windows:

    ST2: %APPDATA%/Sublime Text 2/Packages/
    ST3: %APPDATA%/Sublime Text 3/Packages/
    

Configuration

To change the default configurations you have to update the CodeFormatter - User Preferences file. You can find this file in the Sublime Text menu bar under: Sublime Text > Package Settings > CodeFormatter > Settings - User.

Make sure that you wrap all the configurations into a single root object.

{
   "codeformatter_php_options": {...},
   "codeformatter_js_options": {...},
   ..
}

Formatter-specific notes

Following are notes specific to individual formatters that you should be aware of:

PHP

PHP - Used phpF by @subins2000

Getting and installing PHP - http://www.php.net/manual/en/install.general.php

You must install 5.6 or above (https://github.com/subins2000/phpF#requirements)

On Linux/OSx after installation of package, you must set chmod +x to file fmt.phar in folder %PACKAGESDIR%/CodeFormatter/codeformatter/lib/phpbeautifier

You can list all available transformations from Command Palette: CodeFormatter: Show PHP Transformations Examples of many transformations can be found here: PHP Transformation Examples

Language specific options: “js "codeformatter_php_options”: { “syntaxes”: “php”, // Syntax names which must process PHP formatter “php_path”: “”, // Path for PHP executable, e.g. “/usr/lib/php” or “C:/Program Files/PHP/php.exe”. If empty, uses command “php” from system environments “format_on_save”: false, // Format on save. Either a boolean (true/false) or a string regexp tested on filename. Example : “(?!.min.|vendor.)*$” “psr1”: false, // Activate PSR1 style “psr1_naming”: false, // Activate PSR1 style - Section 3 and 4.3 - Class and method names case “psr2”: true, // Activate PSR2 style “indent_with_space”: 4, // Use spaces instead of tabs for indentation “enable_auto_align”: true, // Enable auto align of = and => “visibility_order”: true, // Fixes visibility order for method in classes - PSR-2 4.2 “smart_linebreak_after_curly”: true, // Convert multistatement blocks into multiline blocks

// Enable specific transformations. Example: ["ConvertOpenTagWithEcho", "PrettyPrintDocBlocks"]
    // You can list all available transformations from command palette: CodeFormatter: Show PHP Transformations
    // You can also see examples of many transformations at https://github.com/akalongman/sublimetext-codeformatter/blob/master/PHP-Transformations.md
    "passes": [],

    // Disable specific transformations
    "excludes": []
}
### Javascript/JSON
Javascript/JSON - used [JSBeautifier] (http://jsbeautifier.org/) by Einar Lielmanis

Language specific options:
```js
    "codeformatter_js_options":
    {
        "syntaxes": "javascript,json", // Syntax names which must process JS formatter
        "format_on_save": false, // Format on save. Either a boolean (true/false) or a string regexp tested on filename. Example : "^((?!.min.|vendor).)*$"
        "indent_size": 4, // indentation size
        "indent_char": " ", // Indent character
        "indent_with_tabs": false, // Indent with one tab (overrides indent_size and indent_char options)
        "eol": "\n", // EOL symbol
        "preserve_newlines": false, // whether existing line breaks should be preserved,
        "max_preserve_newlines": 10, // maximum number of line breaks to be preserved in one chunk
        "space_in_paren": false, // Add padding spaces within paren, ie. f( a, b )
        "space_in_empty_paren": false, // Add padding spaces within paren if parent empty, ie. f(  )
        "e4x": false, // Pass E4X xml literals through untouched
        "jslint_happy": false, // if true, then jslint-stricter mode is enforced. Example function () vs function()
        "brace_style": "collapse", // "collapse" | "expand" | "end-expand". put braces on the same line as control statements (default), or put braces on own line (Allman / ANSI style), or just put end braces on own line.
        "keep_array_indentation": false, // keep array indentation.
        "keep_function_indentation": false, // keep function indentation.
        "eval_code": false, // eval code
        "unescape_strings": false, // Decode printable characters encoded in xNN notation
        "wrap_line_length": 0, // Wrap lines at next opportunity after N characters
        "break_chained_methods": false, // Break chained method calls across subsequent lines
        "end_with_newline": false, // Add new line at end of file
        "comma_first": false // Add comma first
    }

HTML

HTML - used custom python port, please use it with caution, feature in early beta

Language specific options: “js "codeformatter_html_options”: { “syntaxes”: “html,asp,xml”, // Syntax names which must process HTML formatter “format_on_save”: false, // Format on save. Either a boolean (true/false) or a string regexp tested on filename. Example : “(?!.min.|vendor.)*$” “indent_size”: 4, // indentation size “indent_char”: “ ”, // Indentation character “indent_with_tabs”: false, // Indent with one tab (overrides indent_size and indent_char options) “exception_on_tag_mismatch”: false, // If the last closing tag is not at the same indentation level as the first opening tag, there's probably a tag mismatch in the file “expand_javascript”: false, // Expand JavaScript inside of