diff --git a/linters/README.md b/linters/README.md new file mode 100644 index 0000000..77d9623 --- /dev/null +++ b/linters/README.md @@ -0,0 +1,10 @@ +## Linters +- [SublimeLinter](https://github.com/unsplash/javascript/tree/master/linters/SublimeLinter) +- [Syntastic](https://github.com/unsplash/javascript/tree/master/linters/syntastic) + +## Dependencies +Our `.eslintrc` requires the following packages: + +``` +npm install --save-dev eslint-config-unsplash eslint@1.x babel-eslint eslint-plugin-react +``` diff --git a/linters/syntastic/README.md b/linters/syntastic/README.md new file mode 100644 index 0000000..d9d0c5a --- /dev/null +++ b/linters/syntastic/README.md @@ -0,0 +1,26 @@ +So you want in-editor linting? + +## Table of Contents +- [Syntastic](https://github.com/unsplash/javascript/tree/master/linters/syntastic#syntastic) +- [ESLint](https://github.com/unsplash/javascript/tree/master/linters/syntastic#eslint) + +## Syntastic +> Add [Syntastic](https://github.com/scrooloose/syntastic) to your Plugins.
+> This example uses [Plug](https://github.com/junegunn/vim-plug) + +```vim +Plug 'scrooloose/syntastic' +``` + +> Install the plugin + +```vim +:PlugInstall +``` + +## ESLint +> Install ESLint, Babel ESLint and the Unsplash Config + +``` +npm i -g eslint@1.* babel-eslint eslint-config-unsplash +```