@gravitywelluk/eslint-plugin-test

Gravitywell ESLint Plugin

Gravitywell defined ESLint rule sets for ESLint.

Table of Contents

• Table of Contents
• Getting started / Installation
• Usage
  • @gravitywelluk/eslint-recommended
  • @gravitywelluk/typescript-recommended
  • @gravitywelluk/react-recommended
  • @gravitywelluk/react-native-recommended
• Contributing

Getting started / Installation

As this package is not yet on NPM, you will need to tell your NPM package manager where to find it.

In your ~/.npmrc file as the following line,

@gravitywelluk:registry=https://npm.pkg.github.com/

Now you can install the package,

# Yarn
yarn add -D @gravitywelluk/eslint-plugin


# NPM
npm install --save-dev @gravitywelluk/eslint-plugin

Usage

In your .eslintrc file, add the package as a plugin.

plugins: [ "@gravitywelluk/eslint-plugin" ]

There are 4 configurations to choose from:

• @gravitywelluk/eslint-recommended
• @gravitywelluk/typescript-recommended
• @gravitywelluk/react-recommended
• @gravitywelluk/react-native-recommended

Note: You will only need to choose ONE from the list above as they inherit each other. Make sure that it is placed last in the extends array.

plugins: [ "@gravitywelluk/eslint-plugin" ]
extends: [ "@gravitywelluk/react-recommended" ],

@gravitywelluk/eslint-recommended

extends: [ "@gravitywelluk/eslint-recommended" ],

This includes the following plugins and rules including Gravitywell's own override rules:

• eslint
  • eslint:recommended
• eslint-plugin-import
  • plugin:import/errors
  • plugin:import/warnings

@gravitywelluk/typescript-recommended

extends: [ "@gravitywelluk/typescript-recommended" ],

This includes @gravitywelluk/eslint-recommended and the following plugins and rules :

• @gravitywelluk/eslint-recommended
• @typescript-eslint/eslint-plugin
  • plugin:@typescript-eslint/eslint-recommended
  • plugin:@typescript-eslint/recommended
• eslint-plugin-import
  • plugin:import/typescript

@gravitywelluk/react-recommended

extends: [ "@gravitywelluk/react-recommended" ],

This includes @gravitywelluk/typescript-recommended and the following plugins and rules :

• @gravitywelluk/typescript-recommended
• react
  • plugin:react/recommended
• react-hooks
  • plugin:react-hooks/recommended

@gravitywelluk/react-native-recommended

extends: [ "@gravitywelluk/react-native-recommended" ],

This includes @gravitywelluk/react-recommended and the following plugins and rules :

• @gravitywelluk/react-recommended
• @react-native-community/eslint-config

Contributing

To contribute to this package you will need to first setup access to GitHub packages.

1. You will firstly need to create a GitHub Personal Access Token (PAT). Use the following link on Creating a personal access token.

2. You will then need to add the following to your ~/.npmrc file.

   //npm.pkg.github.com/:_authToken=GITHUB_PAT
   

3. Contribute using the Git Truck flow (pull-request > master).

TODO - Continuous integration to bump the version and publish the package once a merge has been made into master.