https://github.com/atom/wrap-guide

Don't cross the line
https://github.com/atom/wrap-guide

Last synced: about 1 year ago
JSON representation

Don't cross the line

• Host: GitHub
• URL: https://github.com/atom/wrap-guide
• Owner: atom
• License: mit
• Archived: true
• Created: 2013-08-13T01:33:50.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2022-09-28T10:52:01.000Z (over 3 years ago)
• Last Synced: 2024-10-27T11:51:07.317Z (over 1 year ago)
• Language: CoffeeScript
• Size: 178 KB
• Stars: 40
• Watchers: 17
• Forks: 31
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
##### Atom and all repositories under Atom will be archived on December 15, 2022. Learn more in our [official announcement](https://github.blog/2022-06-08-sunsetting-atom/)

 # Wrap Guide package

[![macOS Build Status](https://travis-ci.org/atom/wrap-guide.svg?branch=master)](https://travis-ci.org/atom/wrap-guide)

[![Windows Build Status](https://ci.appveyor.com/api/projects/status/5qk1io3uar5j8hol/branch/master?svg=true)](https://ci.appveyor.com/project/Atom/wrap-guide/branch/master)

[![Dependency Status](https://david-dm.org/atom/wrap-guide.svg)](https://david-dm.org/atom/wrap-guide)

The `wrap-guide` package places a vertical line in each editor at a certain column to guide your formatting, so lines do not exceed a certain width.

By default, the wrap-guide is placed at the value of `editor.preferredLineLength` config setting. The 80th column is used as the fallback if the config value is unset.

![](https://f.cloud.github.com/assets/671378/2241976/dbf6a8f6-9ced-11e3-8fef-d8a226301530.png)

## Configuration

You can customize where the column is placed for different file types by opening the Settings View and configuring the "Preferred Line Length" value. If you do not want the guide to show for a particular language, that can be set using scoped configuration. For example, to turn off the guide for GitHub-Flavored Markdown, you can add the following to your `config.cson`:

```coffeescript

'.source.gfm':

  'wrap-guide':

    'enabled': false

```

It is possible to configure the color and/or width of the line by adding the following CSS/LESS to your `styles.less`:

```css

atom-text-editor .wrap-guide {

  width: 10px;

  background-color: red;

}

```

Multiple guide lines are also supported. For example, add the following to your `config.cson` to create four columns at the indicated positions:

```coffeescript

'wrap-guide':

  'columns': [72, 80, 100, 120]

```

> Note: When using multiple guide lines, the right-most guide line functions as your `editor.preferredLineLength` setting.