• Packages
  • Themes
  • Documentation
  • Blog
  • Discuss
Sign in

clean-wrap-guide

Toggles the visibility of the wrap guide if exceeded.
  • #wrap-guide
  • #length
  • #ergonomic
  • #formatting
  • #readability
audunolsen
0.1.4 309
1
  • Repo
  • Bugs
  • Versions
  • License
Flag as spam or malicious

clean-wrap-guide

An atom package dedicated to striking the perfect compromise between helpful visual noise and an austere clean look.

The case for this package:

The ergonomic factors of code readability include a preferred line length limit. Automatic soft wrap is a nightmare because it hinders the "write first, refactor later" mentality because it wrecks readability immediately. An unusually long line is just a minor annoyance. A wrap guide is a visual cue showing you if cleanup is necessary at a later point.

The problem: having a wrap guide visible at all times is distracting visual noise. I'm on a quest to remove all unecessary visual noise from atom, and the wrap guide is undoubtedly unecessary when code is formatted well. This script toggles the visibility of the wrap guide if a line exceeds the preferred line length.

(…This is really just an exercise in publishing a package for Atom…)

Here's how it looks: clean wrap guide demo

TODO

  • [ ] Add keymap toggle
  • [ ] Performance: Add option to swap event listeners; e.g. onDidSave or onDidStopchanging
  • [ ] Blacklist files and/or filetypes. Useful when dealing with files with strict formats like JSON
  • [ ] Alert when config.cson features config options incompatible with the package, e.g. soft wrapping.
  • [ ] Look for file extension spesific specified linelengths in config.cson

I think this package is bad news.

Good catch. Let us know what about this package looks wrong to you, and we'll investigate right away.

  • Terms of Use
  • Privacy
  • Code of Conduct
  • Releases
  • FAQ
  • Contact
with by