text_editors.md

Text Editors Guidelines

###Table of content:

1. Obligatory settings
2. Sublime Text
3. Atom

##Obligatory Settings ###We use 2 spaces indent and also take care about trailing whitespaces

Ensure your editor is configured properly:

.vimrc

if has("autocmd")
  " remove trailing white spaces
  autocmd BufWritePre * :%s/\s\+$//e
endif

Neatbeans config

* Tools -> Options -> Editor -> On Save > Remove Trailing Whitespace From
* Select: All lines

RubyMine config

Go to preferences / editor and check:

* Ensure line feed at file end on Save
* Strip trailing spaces on Save

SublimeText config

// Trims white space added by auto_indent when moving the caret off the line.
"ensure_newline_at_eof_on_save": true,
"tab_size": 2,
"translate_tabs_to_spaces": true,
"trim_automatic_white_space": true,
"trim_trailing_white_space_on_save": true

Atom config

• Install Whitespace package
• To configure press CMD + SHIFT + P -> Open Your Config

'.slim.text':
  whitespace:
    removeTrailingWhitespace: true

For controlling last, empty line at the end of document

##Sublime Text

###Useful resources:

• Useful keyboard shortcuts
• Unofficial Documentation
• SublimeText Screencasts

###In order to improve your workflow you may consider using some of extensions listed below:

• Package Control - helps in installing and managing packages. Absolulety must have.

• GitGutter - keeps track of git diff stats and shows them inline

  

• SideBarEnhancements - adds some useful file operations available from sidebar panel

  

• Emmet (zencoding) - with code shortcuts (like ul>li.class*3) helps you write code much faster. Visit smashing magazine for more examples.

  

• CursorRuler - draws vertical ruler in cursor position. Helps in tracking indentation level.

  

• DashDoc - you can look up the word under the cursor or selected text in Dash using ctrl+h shortcut. We use Dash in Monterail, ask your PM for license details

  

• Gist - you can create gists directly from sublime text in just few seconds.

  

##Atom

###Useful resources:

• Documentation
• Useful keyboard shortcuts

###Terminal commands:

• apm list - List of installed packages
• apm install PACKAGENAME - Package install
• apm uninstall PACKAGENAME - Package uninstall
• apm list --installed --bare > package-list.txt - Creates list of installed packages
• apm install --packages-file package-list.txt - Packages installation from file

###Useful packages for FE

• autocomplete-sass - CSS property name and value autocompletions for SASS.
• pigments - A package to display colors in project and files.

###Useful packages for BE

• language-elixir - Elixir language support.
• linter-rubocop - Linter based on rubocop settings.
• rubocop-auto-correct - Auto-correct ruby source code by using rubocop.
• cucumber - Cucumber support.

###Useful packages for everyone

• tabs-to-spaces - Provides the ability to convert between leading tabs and spaces in a document
• todo-show - Finds all the TODOs, FIXMEs, CHANGEDs, etc. in project.
• terminal-status - A terminal interface and status icon.
• minimap - Displays a preview of the full source code on the right side of editor.
• indent-guide-improved - Draws indent guide more correctly and understandably.
• linter, linter-coffeescript, linter-slim, linter-haml - Inline helper for syntax errors and so on.
• rulerz - A package to mark each of your cursors with a vertical ruler.
• language-haml, language-jade, language-slim - Languages support.
• angularjs - Adds syntax highlighting and snippets to AngularJS.
• highlight-line - Highlights the current line in the editor.
• seti-icons - The file extentions icons provided by Seti UI theme.
• git-plus - Make commits and other git things without the terminal.
• merge-conflicts - Resolve git conflicts within Atom.
• git-blame - Toggle git-blame annotations in the gutter of Atom editor.
• git-history - View previous versions of any file known to git.
• circle-ci - Adds build status from Circle CI for the current branch of the current project to the Atom UI.
• ruby-bundler - Control bundler from Atom. Run bundle install directly from Atom with ALT + CMD + B