@equitysim/code-style

EquitySim Code Style

A repo to document code standards for different languages and provide tools for linting EquitySim projects.

ES6/JSX

We use ESLint to lint ES6 and React/JSX code. If ESLint is installed in a project, we can use the configuration from this module by creating a file in the project root named .eslintrc.yml. If the project does not use JSX, the file contents should be

extends:
  - './node_modules/code-style/es6/es6.yml'

and for a React/JSX project:

extends:
  - './node_modules/code-style/es6/es6-react.yml'

or for a backend project:

extends:
  - './node_modules/code-style/backend/backend.yml`

If using a custom Webpack configuration, add the lines:

settings:
  import/resolver:
    webpack:
      config: '<path-to-webpack-config>'

to the .eslintrc.yml

Make sure to install the following NPM modules:

• eslint > 3.0
• eslint-plugin-import
• eslint-import-resolver-webpack
• eslint-plugin-react (for React/JSX linting only)

ESLint and Atom

Find out how to integrate ESLint and Atom Text.