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

HTMLBeautify

by rareyman ST2/ST3 Top 100

A plugin for Sublime Text that formats (indents) HTML source code. It makes code easier for humans to read.

Details

  • 2017.07.05.22.02.06
  • github.​com
  • github.​com
  • 2 weeks ago
  • 22 minutes ago
  • 5 years ago

Installs

  • Total 341K
  • Win 191K
  • OS X 98K
  • Linux 52K
Jul 21 Jul 20 Jul 19 Jul 18 Jul 17 Jul 16 Jul 15 Jul 14 Jul 13 Jul 12 Jul 11 Jul 10 Jul 9 Jul 8 Jul 7 Jul 6 Jul 5 Jul 4 Jul 3 Jul 2 Jul 1 Jun 30 Jun 29 Jun 28 Jun 27 Jun 26 Jun 25 Jun 24 Jun 23 Jun 22 Jun 21 Jun 20 Jun 19 Jun 18 Jun 17 Jun 16 Jun 15 Jun 14 Jun 13 Jun 12 Jun 11 Jun 10 Jun 9 Jun 8 Jun 7 Jun 6
Windows 214 287 299 272 321 154 192 245 293 302 258 286 144 148 271 242 254 274 242 122 151 221 260 253 236 219 126 141 222 253 275 251 269 145 163 260 252 245 299 261 142 161 223 261 237 262
OS X 76 104 108 102 91 55 40 85 93 116 85 86 46 46 100 117 87 85 92 43 43 87 102 81 80 101 56 57 83 99 79 113 89 40 40 85 114 112 92 91 42 57 87 75 137 89
Linux 39 68 52 69 63 33 37 53 57 48 62 67 33 36 66 59 43 51 65 31 29 46 60 65 56 43 33 41 58 64 57 54 49 37 30 55 58 45 56 49 26 46 49 67 59 59

Readme

Source
raw.​githubusercontent.​com

HTMLBeautify v0.85

SublimeText (version 2 & 3)

  • (Inspired by fhtml.pl by John Watson)
  • by Ross A. Reyman
  • 20 February 2015
  • url: http://reyman.name/
  • e-mail: ross[at]reyman[dot]name

A plugin for Sublime Text , that formats (indents) HTML source code. It makes code easier for humans to read.


Key Commands Reverted Back to Original

Due to a conflict with other keymaps in Sublime Text, I am reverting the keymap back to the original setting:

  • Mac OS X: Command-Option-Shift-F
  • Windows: Control-Alt-Shift-F
  • Linux: Control-Alt-Shift-F

(To change this, see instructions later in this README…)

Notes

  • This script assumes an effort has been made by the user to expand tags to different lines. This script will not automatically expand minimized/compressed code—it will only try to “clean-up” code that needs to be re-indented
    • However, you can use multiple cursors (Find All) or use Replace on the beginning of a tag < to put every tag on a new line before applying beautify, which will help in this case.
  • Currently, this script chokes a bit with inline comments.

    • For example:

      <div class="something">

    • So, a workaround is to keep comments on their own lines:

      <div class="something">

    • (TODO: Fix this!)

  • This script uses \t characters to create indentation levels and spacing—ST appears to honor whether the user prefers spaces or tabs in ST settings and adjusts accordingly.

  • Use tag_pos_inline setting to define tags that might appear on one line.

  • Windows Users: You must restart Sublime Text to complete the installation.

Installation (Package Control)

If you have Package Control installed in Sublime Text:

  • Open the Command Palette (Tools > Command Palette…)
  • Search for and choose “Package Control: Install Package” (give it a few seconds to return a list of available packages)
  • Search for “HTMLBeautify” and install.
  • Windows users will need to restart Sublime Text to finish the installation.

Installation (Manual)

  • Download the zip, re-name resulting folder to: HTMLBeautify, then put the folder into your Sublime Text Packages folder.

Usage

  • Open a file containing HTML.
  • Select HTML code you want to beautify. (If no selection is made the plugin will run on the whole file.)
  • Use the appropriate key command to run HTMLBeautify—or use HTMLBeautify from the Edit menu.
  • You can test the script with HTMLBeautifyTest.html: an HTML file with wacky indenting so you to see how this script works.

Settings

You can configure which tags should be processed with this script:

  • ignored_tag_opening : What are the opening tags that tell the script to ignore HTMLBeautify formatting?
  • ignored_tag_closing : What are the closing tags that tell the script to resume HTMLBeautify formatting?

  • tag_indent : If one of these opening tags is encountered, the contents (next line) will be indented by one level.

  • tag_unindent : If one of these closing tags is encountered, the next line will be un-indented one level.

  • tag_unindent_line : If one of these closing tags is encountered, this line is un-indented one level.

  • tag_pos_inline : These are special “one line” tags that open and close on the same line, so indenting should be ignored.

  • remove_extraline : Set true to remove empty line.

Changing the Key Binding

You can create your own custom keymap (key command/macro) in your keymap file: Packages/User/Default[OS].sublime-keymap

{
    "keys": ["super+alt+shift+f"], //  create your own key command combination here!
    "command": "html_beautify", // command that executes html_beautify
    "context": [{
        // these options ensure that the command is executed in the right files/context
        "key": "selector",
        "operator": "equal",
        "operand": "text.html,text.html.twig,text.twig,source.html,source.html.twig,source.twig"
    }]
}

For more details: Sublime Text Unofficial Documentation: Key Bindings

Disclaimer

This script has been tested for basic HTML coding situations, but your mileage may vary—use with caution if using this in a production environment. (Please report bugs or contribute corrections to the script!) Although the script does not remove or modify code directly (it only attempts to adjust indentation levels), be sure to test this script throughly to make sure it works as expected! The author is not responsible for any bugs that might be introduced to your HTML. :)