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

Materya ESLint Standard Config
https://github.com/materya/eslint-config

config eslint eslint-config eslintconfig

Last synced: about 7 hours ago
JSON representation

Materya ESLint Standard Config

• Host: GitHub
• URL: https://github.com/materya/eslint-config
• Owner: materya
• License: gpl-3.0
• Created: 2020-04-29T19:55:06.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-05-30T14:49:09.000Z (over 1 year ago)
• Last Synced: 2024-11-06T21:20:27.870Z (2 days ago)
• Topics: config, eslint, eslint-config, eslintconfig
• Language: JavaScript
• Size: 788 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Materya ESLint Config

An opinionated ESLint config for Materya projects

## How to use

### Install

```

npm i eslint-plugin-materya

```

### peer dependencies

```

npx install-peerdeps -d -o eslint-config-materya

```

### Configure ESLint

Extends from this config in your eslint local config file.

Example in `.eslintrc`:

```js

module.exports = {

  extends: [

    'materya',            // Base set of rules

    'materya/pulumi',     // Extended rules for pulumi modules

    'materya/typescript', // Extended rules for Typescript

  ],

  ...

}

```

## Rules

### Dependencies

This set of rules extends a few standards:

* [AirBNB Javascript guidelines](https://github.com/airbnb/javascript)

* [ESLint Standard Style](https://github.com/standard/eslint-config-standard)

* [ESLint Import Plugin](https://github.com/benmosher/eslint-plugin-import)

### Custom rules

> WIP