Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avivharuzi/eslint-config-vamp
ESLint config for vampires 🩸
https://github.com/avivharuzi/eslint-config-vamp
config eslint eslint-config eslint-rules javascript typescript
Last synced: 1 day ago
JSON representation
ESLint config for vampires 🩸
- Host: GitHub
- URL: https://github.com/avivharuzi/eslint-config-vamp
- Owner: avivharuzi
- License: mit
- Created: 2022-07-22T15:38:23.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-08-12T11:43:23.000Z (over 2 years ago)
- Last Synced: 2024-11-15T07:09:07.017Z (2 months ago)
- Topics: config, eslint, eslint-config, eslint-rules, javascript, typescript
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/eslint-config-vamp
- Size: 15.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
## 📖 Table of Contents
- [Overview](#🔫-Overview)
- [Installation](#🛠️-Installation)
- [Usage](#⚡️-Usage)
- [License](#📜-License)
## 🔫 Overview
This package includes ESLint configuration files, this configuration files only include rules to prevent environment problems and conflicts with other rules.
Currently, there is 2 configurations:
1. `javascript` - the default one that includes ESLint rules only
2. `typescript` - includes typescript/eslint rules only
## 🛠️ Installation
```shell
npm i -D eslint-config-vamp
```
## ⚡️ Usage
### javascript
The javascript configuration requires only `eslint` package to be installed.
> .eslintrc.json
```json
{
"extends": [
"vamp/javascript"
]
}
```
Example of advanced configuration with `javascript`:
Packages required:
- `eslint`
- `eslint-config-prettier`
> .eslintrc.json
```json
{
"extends": [
"eslint:recommended",
"vamp/javascript",
"prettier"
]
}
```
### typescript
The typescript configuration require those packages in order to work:
- `eslint`
- `@typescript-eslint/eslint-plugin`
- `@typescript-eslint/parser`
> .eslintrc.json
```json
{
"extends": [
"vamp/javascript",
"vamp/typescript"
]
}
```
Example of advanced configuration with `typescript`:
Packages required:
- `eslint`
- `@typescript-eslint/eslint-plugin`
- `@typescript-eslint/parser`
- `prettier`
> .eslintrc.json
```json
{
"extends": [
"eslint:recommended",
"vamp/javascript",
"plugin:@typescript-eslint/recommended",
"vamp/typescript",
"prettier"
]
}
```
### Annoying Rules
All the rules considered as best practices but some of them can make to your existing projects problems, so those rules can be disabled easily with the rules object:
```json
{
"rules": {
"id-length": "off",
"max-classes-per-file": "off",
"max-depth": "off",
"max-nested-callbacks": "off",
"max-params": "off"
}
}
```
## 📜 License
[MIT](LICENSE)
