Eslint-config-akkadu NPM

Eslint Config

Get started on Javascript projects at Akkadu much quicker by using this template repository.

View Demo • Report Bug • Request Feature

About The Project
- Built With
Getting Started
- Prerequisites
- Installation
Usage
Roadmap
Edge Cases Addressed
Contributing
Author
Dependencies
Acknowledgements

About The Project

This is Akkadu's living Javascript linting standard. It's created and maintained by the core Akkadu Tech Force and designed to enforce more readable and efficient code.

Built With

These are the major linting plugins integrated with our own linting rules.

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

yarn

npm install yarn@latest -g

Installation

Clone the repo
Get the .env keys from techforce@akkadu-team.com

git clone https://github.com/Akkadu/eslint-config-akkadu.git

Install NPM packages

yarn install

Usage

yarn add -D prettier eslint-config-akkadu

.eslintrc

{
  "extends": ["eslint-config-akkadu"]
}

Roadmap

See the open issues for a list of proposed features (and known issues)

Edge Cases Addressed

eslint-config-akkadu also adds a few rules that have had some problems in the recent past. These are the kinds of problems that may be inconsistent in occurence and will probably prop up as your dependency versions change:

babel-eslint template literal indentation (babel/babel-eslint issue #799) Depending your current version of babel-eslint or @babel/parser, the following ESlint error may present itself in places that use template literals in code:
```
TypeError: Cannot read property 'range' of null
```
This was fixed by adding the following snippet to the indent rule:
Source: babel/babel-eslint#799 (comment)
```
{
  "rules": {
    "indent": [
      "error",
      2,
      {
        "SwitchCase": 1,
        "ignoredNodes": [
          "TemplateLiteral"
        ]
      }
    ],
    "template-curly-spacing": 0
  }
}
```
This issue will be resolved by future versions of Babel. We can remove if from the config then.