eslint-config-foray1010

eslint-config-foray1010

Versioning

X.Y.Z

X for upgrading eslint or node engine (breaking changes)

Y for adding rules/options (more strict)

Z for removing rules/options (more loose)

Installation

on your repository

• If you want to install in the existing repository:

  • npm install --save-dev eslint eslint-config-foray1010

  • Create a .eslintrc.yml in the project root

    # for general purpose
    extends: "eslint-config-foray1010"
    
    # for general purpose with typescript support
    extends: "eslint-config-foray1010/typescript"
    
    # for frontend react project with typescript support
    extends: "eslint-config-foray1010/typescript-react"
    

on your editor

• For Atom:

  • Install in terminal by apm install linter linter-eslint

• For PhpStorm or WebStorm:

  • Languages & Frameworks -> JavaScript -> choose ECMAScript 6 for JavaScript language version
  • Preference -> Plugins -> click Browse repositories... -> search ESLint -> click Install plugin
  • Preference -> Languages & Frameworks -> JavaScript -> Code Quality Tools -> ESLint -> check Enable

• For Sublime Text 3:

  • Install Package Control
  • Install SublimeLinter and SublimeLinter-contrib-eslint by Package Control

• For vim or neovim:

  • Install benekastah/neomake by any plugin manager, such as vim-plug

  • Add the following lines to ~/.vimrc (vim) or ~/.config/nvim/init.vim (neovim)

    autocmd BufWrite * :Neomake
    
    let g:neomake_javascript_enabled_makers= ['eslint']
    
    " load local eslint in the project root
    " modified from https://github.com/mtscout6/syntastic-local-eslint.vim
    let s:eslint_path = system('PATH=$(npm bin):$PATH && which eslint')
    let g:neomake_javascript_eslint_exe = substitute(s:eslint_path, '^\n*\s*\(.\{-}\)\n*\s*$', '\1', '')
    

• For vscode:

  • Install Eslint plugin