eslint-config-cove v1.0.8

eslint-config-cove

What is a linter?

A linter or lint refers to tools that analyze source code to flag programming errors, bugs, stylistic errors, and suspicious constructs. (source)

Purpose and motivation to utilize linters

JavaScript, being a dynamic and loosely-typed language, is especially prone to developer error. Without the benefit of a compilation process, JavaScript code is typically executed in order to find syntax or other errors. Linting tools like ESLint allow developers to discover problems with their JavaScript code without executing it. (source)

More information regarding linters:

• https://solidgeargroup.com/en/control-style-of-code-of-team-linters/

Installation

devDependencies already exist in all cove_react projects

The following steps are only necessary for react projects outside of cove_react

1. Install eslint-config-cove along with additional neccessary dev-dependencies

   Using npm

   npm install eslint-config-cove --save-dev

   Using yarn

   yarn -D add eslint-config-cove

2. Install the correct versions of each peerDependency package

   npx install-peerdeps --dev eslint-config-cove

Usage

Add the config to your package.json:

// package.json

{
  ...
  "eslintConfig": {
    "extends": "eslint-config-cove"
  },
  ...
}