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

Js​Format

by jdc0589 ST2/ST3 Top 25

Javascript formatting for Sublime Text 2 & 3

Details

  • 2017.07.05.18.35.05
  • github.​com
  • github.​com
  • 2 months ago
  • 2 hours ago
  • 6 years ago

Installs

  • Total 524K
  • Win 319K
  • OS X 140K
  • Linux 66K
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 Aug 4 Aug 3 Aug 2 Aug 1 Jul 31 Jul 30 Jul 29 Jul 28 Jul 27 Jul 26 Jul 25 Jul 24 Jul 23 Jul 22 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
Windows 54 181 318 256 322 320 292 175 223 311 346 303 315 320 155 211 284 330 289 383 368 182 257 346 387 373 380 392 200 226 344 387 409 391 450 241 247 355 407 413 403 385 183 251 337 420
OS X 11 61 96 78 102 114 112 79 75 122 111 100 103 107 69 58 97 107 109 137 131 51 69 139 121 125 101 90 49 68 103 140 104 133 127 59 67 117 125 110 128 131 62 76 119 135
Linux 9 27 41 40 42 39 36 24 21 34 36 48 27 25 29 31 34 47 34 34 40 19 28 39 40 32 49 42 28 30 49 35 55 50 32 26 28 46 32 42 46 39 31 29 41 44

Readme

Source
raw.​githubusercontent.​com

Join the chat at https://gitter.im/jdc0589/JsFormat

LOOKING FOR A NEW MAINTAINER

I haven't been giving JsFormat the attention it deserves lately, and I'd like to bring on someone else to help maintain the project. Shoot me an email if you are interested.

About

JsFormat is a javascript formatting plugin for Sublime Text 2. It uses jsbeautifier to format whole js or json files, or the selected portion(s).

Features

  • javascript/json formatting (obviously)
  • all settings are customizable (whitespace, formatting style, etc..)
  • .jsbeautifyrc settings files support for even more control on a per-project basis
  • puts the cursor back in the same location it was before formatting (accounts for whitespace/newline changes)
  • Sublime Text 3 support

Settings

JsFormat uses whatever tab/indent settings are configured with the standard translate_tabs_to_spaces and tab_size sublime settings.

The following JsBeautifier settings are available in JsFormat/JsFormat.sublime-settings (defaults shown below). Check out the official jsbeautifier documentation for more details on the options:

  • indent_with_tabs: false
  • max_preserve_newlines: 4
  • preserve_newlines: true
  • space_in_paren: false
  • jslint_happy: false
  • brace_style: “collapse”
  • keep_array_indentation: false
  • keep_function_indentation: false
  • eval_code: false,
  • unescape_strings: false,
  • break_chained_methods: false*
  • e4x: false
  • wrap_line_length: 0
  • space_after_anon_function: false

The following JsFormat specific settings are also exposed:

I had temporary lapse of judgment a while back and merged a pull request that modified jsbeautifier. As a result, the functionality that was added from that pull request has been lost; "ensure_space_before_linestarters" is no longer supported.

The JsFormat specific ensure_newline_at_eof_on_save setting has also been removed. This functionality exists in sublime core.

jsbeautifyrc files

JsFormat now supports .jsbeautifyrc JSON files (disabled by default), which themselves support any of the exposed JsBeautifier options. The option augmentation order is: default options -> user settings -> .jsbeautifyrc option files.

A hierarchy of .jsbeautifyrc files is supported, where rc files at the deeper levels override the settings from rc files at higher levels. For example, given the file structure listed below, formatting /home/you/myProject/app.js would inherit settings from: default -> user settings -> /home/you/myProject/.jsbeautifyrc, while formatting /home/you/myProject/tests/test.js would inherit settings from: default -> user settings -> /home/you/myProject/.jsbeautifyrc -> /home/you/myProject/tests/.jsbeautifyrc

  • /home/you/myProject/.jsbeautifyrc
  • /home/you/myProject/app.js
  • /home/you/myProject/tests/.jsbeautifyrc
  • /home/you/myProject/tests/test.js

Install

Package Control (Recommended)

JsFormat is now included in the default repository channel for Package Control. It should show up in your install list with no changes.

If it does not show up, or you are on an older version of Package Control, add https://github.com/jdc0589/JsFormat as a Package Control repository. JsFormat will show up in the package install list.

Git Clone

Clone this repository in to the Sublime Text 2 “Packages” directory, which is located where ever the “Preferences” -> “Browse Packages” option in sublime takes you.

Key Binding

The default key binding is “ctrl+alt+f”

Key Binding Conflicts

Unfortunately there are other plugins that use “ctrl + alt + f”, this is a hard problem to solve. If JsFormat works OK via the command palette but does nothing when you use the “ctrl + alt + f” shortcut, you have two options:

  1. Add { "keys": ["ctrl+alt+f"], "command": "js_format", "context": [{"key": "selector", "operator": "equal", "operand": "source.js,source.json"}] } to your user keybindings file. This will override anything specified by a plugin.
  2. Find the offending plugin, and change the shortcut in its sublime-keymap file (will revert on updates)

Command Palette

Open the command palette via “ctrl + shift + p”, Jsformat appears as “Format: Javascript”


License

Copyright © 2012 Davis Clark

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.