From 91be8c28dcc0ee19706dfcda8707cce787d83ebf Mon Sep 17 00:00:00 2001 From: benjaminneildavis Date: Tue, 9 Dec 2014 17:50:39 -0500 Subject: [PATCH] Adding editorconfig file and my personal webstorm settings file (just the file formatting part of it). --- .editorconfig | 18 ++++++++++++++++++ README.md | 17 +++++++++++++++++ linters/webstorm-settings.jar | Bin 0 -> 1264 bytes 3 files changed, 35 insertions(+) create mode 100644 .editorconfig create mode 100644 linters/webstorm-settings.jar diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..8a6f796 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +root = true + +[*] +indent_style = tab +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true + +[package.json] +indent_style = space +indent_size = 2 + +[*.md] +trim_trailing_whitespace = false + +[*.js] +curly_bracket_next_line = false diff --git a/README.md b/README.md index a19c88b..d82c5fe 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,7 @@ 1. [ES5 Compatibility](#es5) 1. [Testing](#testing) 1. [Performance](#performance) + 1. [Editorconfig Setup / Use](#editorconfig) 1. [Resources](#resources) 1. [In the Wild](#in-the-wild) 1. [The JavaScript Style Guide Guide](#guide-guide) @@ -1195,6 +1196,22 @@ - Loading... **[[⬆]](#TOC)** + +## Editorconfig Setup / Use + - Usually for a project with more than one developer involved, it is essentially important for the project to define + and maintain a consistent coding style. Most code editors and IDEs, such as Vim, Emacs, Code::Blocks, provide settings + related to coding styles, such as the width of tab, the size of indentation, end of line, etc. However, it is hard to + provide the same settings for different Editors and IDEs: we have to maintain many config files for different editors + and IDEs, such as .vimrc for Vim, .emacs for Emacs. In order to solve this, EditorConfig was born. By defining coding + style in files named .editorconfig, the EditorConfig plugins for different editors and IDEs will automatically adjust + your coding style. + - To use EditorConfig, you have to download the corresponding [EditorConfig plugins](http://editorconfig.org/#download) for your Editor or IDE. + Follow the installation instructions to install them. + - The "base" .editorconfig file goes in the root directory. You can have other config files in specific folders if wanted. + The only difference would be at the top of the file to remove root = true from any file that isn't the root. + + + **[[⬆]](#TOC)** ## Resources diff --git a/linters/webstorm-settings.jar b/linters/webstorm-settings.jar new file mode 100644 index 0000000000000000000000000000000000000000..87655234d3c8146886cc0a808ebe8ed944049cd9 GIT binary patch literal 1264 zcmWIWW@Zs#-~hr|k*%%_NI;H(g(1J7Br`v+SU)*GB~`Duq%sFcCTFDPrWWf}(+S8gXOZj(W{U zpZsQ7RLYCF#XM+;-fpr#C;IxDEUUPfh?BcsMHsb2uFy1h?pPk-jzXNt<1?)9Xbe`{cvnt4`2{}nH>mD}><-@SR*o4W9=pZe`J zb10J?3bL{L$dgrdVI)SZXLgvE0^Y)phjX&QfM2qGn*x#CVx$oPe3BMomOn^r@mbA>CFEUv5A*IxcMo6T_1bOcHbxI4TFI8h=Y*?I{<-KP+^j^Gd{o~s7y~a8& zqP=4Jo08i4)0+=!mEJ#iyhhShD4b>0PXQxNvy}ZNTmM%{rGLErf*It9o+a_YUO+2? zfEba!&>bNQl=aLjNzKX0^iuG2adlL1&&f|p%uxtVEh)*&OD_)aW@Hj!Kx9JXWDClK zsDN;m1ewRhfIG1x%zFW3q9lEULqLfiIgmk#9{~h`L64*nEh`{<2oxH~;RK2j1USru i7D32v#}<$Xtscw-gOwGSI2agMfiN8C-e#Z%1_l6jzoLQw literal 0 HcmV?d00001