https://github.com/outofsyncstudios/eslint-config

ESLint definitions for Out of Sync Studios
https://github.com/outofsyncstudios/eslint-config

Last synced: about 2 months ago
JSON representation

ESLint definitions for Out of Sync Studios

• Host: GitHub
• URL: https://github.com/outofsyncstudios/eslint-config
• Owner: OutOfSyncStudios
• Created: 2021-07-07T23:26:40.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-03-06T05:38:57.000Z (almost 2 years ago)
• Last Synced: 2024-10-13T14:43:55.639Z (3 months ago)
• Language: JavaScript
• Size: 105 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# eslint-config-ooss

This is the Out of Sync Studios eslint common configuration for multiple Node development environments.

## Installation

```shell

$ npm install @outofsyncstudios/eslint-config-ooss

```

or

```shell

$ yarn add @outofsyncstudios/eslint-config-ooss

```

## Usage

This eslint config plugin provides a common environment and one extension for front-end specific rules.

To use this plugin install module as noted above and then edit the `.eslintrc.json` file in the root of your project to look like below.

```json

{

  "extends": "@outofsyncstudios/eslint-config",

  "rules": {

    ...

  }

}

```

This will include the `common` definitions. ***Note***: Any addtional rules that appear in the rules section will override the base settings.

You can also specify to add the front-end extensions as follows:

```json

{

  "extends": [

    "@outofsyncstudios/eslint-config",

    "@outofsyncstudios/eslint-config/frontend-extension"

  ],

  "rules": {

    ...

  }

}

```