Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@gravitywelluk/eslint-plugin-test

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@gravitywelluk/eslint-plugin-test

Gravitywell defined ESLint rule sets as a ESLint plugin

  • 1.0.9
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

Gravitywell ESLint Plugin

Gravitywell defined ESLint rule sets for ESLint.

CI


Table of Contents

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" ],
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
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
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
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.

FAQs

Package last updated on 01 Oct 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc