A Brackets extension to show indent guides in the code editor
JavaScript
Switch branches/tags
Nothing to show
Clone or download
Latest commit 44de6ca Sep 4, 2017
lkcampbell committed Sep 4, 2017 Update Change Log

README.md

Indent Guides for Brackets

An extension for Brackets to show indent guides in the code editor.

How to Install

  1. Select Brackets > File > Extension Manager...
  2. Search for this extension.
  3. Click on the Install button.

How to Use Extension

Toggle the extension with View > Indent Guides.

Screenshots:

Life without Indent Guides:

off

Life with Indent Guides:

on

Works great in the dark as well:

dark

Preferences let you control the style and color:

preferences

Extension Preferences

brackets-indent-guides.enabled (boolean)
Determines whether the indent guides will be shown or hidden.

brackets-indent-guides.hideFirst (boolean)
Determines whether the first Indent Guide will be hidden or shown.

brackets-indent-guides.guideColor (string)
The color of the indent guides. Can be any valid CSS Color value.

brackets-indent-guides.guideStyle (string)
This value determines the style of the guide: "solid" or "dotted".

For more information on setting preferences see How to Use Brackets - Preferences

Custom Key Bindings

If you would like to add a customized keyboard shortcut to toggle indent guides, set your shortcut key to the following command id: lkcampbell.toggleIndentGuides.

For example, if you want the shortcut Ctrl-Shift-I to toggle the indent guides, type the following entry into the overrides section of your keyboardmap.json file:

"Ctrl-Shift-I": "lkcampbell.toggleIndentGuides"

For more information on setting Custom Key Bindings see User Key Bindings.

Code Challenges

Code challenges are closed issues and enhancement requests that I have attempted to resolve without success. Maybe you have an idea that will help?

Just look for the code challenge label in the closed issues list. Post a comment on the issue and we can discuss your solution ideas. Here is a list of the current code challenges for this extension:

  1. Empty lines do not display indent guides
  2. Show only one indent guide in hanging indent
  3. Indent guides make scrolling less performant
  4. Only show indent guides when text is present on line

License

MIT-licensed -- see main.js for details.