@osskit/eslint-config

The eslint config used by osskit

Usage no npm install needed!

<script type="module">
  import osskitEslintConfig from 'https://cdn.skypack.dev/@osskit/eslint-config';
</script>

README

@osskit/eslint-config NPM version

ESLint shareable config used by osskit.

Install

$ npm install --save-dev @osskit/eslint-config

Plugins

This config uses several plugins:

$ npm install --save-dev eslint-plugin-import eslint-plugin-unicorn @typescript-eslint/eslint-plugin

Usage

Create an .eslintrc file:

{
  "extends": "@osskit"
}

Or add the ESLint config to your package.json:

{
  "name": "my-awesome-project",
  "eslintConfig": {
    "extends": "@osskit"
  }
}

Additional Configs

This package exposes additional configs.

Test @osskit/eslint-config/test

Use this for your jest tests

{
  "extends": "@osskit/eslint-config/test"
}

Install the plugin:

$ npm install --save-dev eslint-plugin-jest

React @osskit/eslint-config/react

{
  "extends": "@osskit/eslint-config/react"
}

Install the plugins:

$ npm install --save-dev eslint-plugin-react eslint-plugin-react-hooks

React Test @osskit/eslint-config/react-test

Use this for your react jest tests

{
  "extends": "@osskit/eslint-config/react-test"
}

Install the plugins:

$ npm install --save-dev eslint-plugin-jest eslint-plugin-react eslint-plugin-react-hooks

React Native @osskit/eslint-config/react-native

{
  "extends": "@osskit/eslint-config/react-native"
}

Install the plugins:

$ npm install --save-dev eslint-plugin-react eslint-plugin-react-native eslint-plugin-react-hooks

React Native Test @osskit/eslint-config/react-native-test

Use this for your react native jest tests

{
  "extends": "@osskit/eslint-config/react-native-test"
}

Install the plugins:

$ npm install --save-dev eslint-plugin-jest eslint-plugin-react eslint-plugin-react-native eslint-plugin-react-hooks