eslint-config-arsam

Clean but organised.

❗️This package is in development. There is currently no plan to create any form of formal documentation or a change log. That being said, I hope you find this package useful

How to

• Install ESLint and Prettier extentions for your favourite text editor. I use and recommend VSCode.
• Install eslint-config-arsam as one of your project's dev dependencies

npm i --save-dev eslint-config-arsam

Or if you're cool 😎

yarn add --dev eslint-config-arsam

• Create an .eslintrc file at the root of your project and add the below to it.

{
  "extends": ["arsam"]
}

Voila! That's it. If you wish to override any of the rules you can do it as you see in the example below

{
  "rules": {
    "no-param-reassign": 0,
    "no-underscore-dangle": 0,
    "react/jsx-wrap-multilines": 0,
    "curly": "error"
  },
  "settings": {
    "import/resolver": {
      "alias": {
        "map": [
          ["babel-polyfill", "babel-polyfill/dist/polyfill.min.js"],
          ["helper", "./utils/helper"],
          ["material-ui/DatePicker", "../custom/DatePicker"],
          ["material-ui", "material-ui-ie10"]
        ],
        "extensions": [".ts", ".js", ".jsx", ".json"]
      }
    }
  }
}

Roadmap

• Re-think default rules
• Improve README