Skip to content

brennacodes/unruley

Repository files navigation

Unruley VSCode Extension

Unruley is a Visual Studio Code extension that allows you to easily see where lines are exceeding a given maximum line length.

Features

  • Set a custom color.
  • Set a custom opacity, or use the default of 0.1.
  • Define a maximum line length for your code (or use one that's already been set).

The background color is automatically applied to lines that exceed the maximum line length, providing a helpful visual cue.

Unruley Settings Page

Unruley Settings

Unruley In Action

Unruley In Action

Future Features

  • Allow users to set and update settings per workspace.

Usage

  1. Install the extension.
  2. Open the settings:
  • File > Preferences > Settings or
  • Mac: + + P (Command + Shift + P)
  • Windows: ^ + + P (Ctrl + Shift + P)
  1. Search for Unruley.
  2. Set your preferred background color. Click here to use Google's color picker. You can use hex (e.g., #RRGGBB or #RGB) or rgb (e.g., rgb(255, 0, 0)) color formats.
  3. Set the background color opacity.
  4. Set the maximum line length.

Commands

  • unruley: Open the settings for this extension.

Configuration

  • unruley.ruler: Set the maximum line length. Default is 80.
  • unruley.rulerColor: Set the background color. Accepts hex (e.g., #RRGGBB or #RGB) or rgb (e.g., rgb(255, 0, 0)) color formats. Default is #ff0000.
  • unruley.rulerColorOpacity: Set the opacity of the background color. Accepts a number between 0 (completely transparent) and 1 (completely opaque). Default is 0.1.

Support

Questions? Comments? Concerns? Ideas? Visit the Unruley discussions board.

Contributing

Ready to dive in and contribute? Check out the Contributing Guide.

License

GPL v3.0 © Brenna Stuart

Releases

No releases published

Packages

No packages published