Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/menudocs/eslint-config-tesseract
Some rules everyone should follow.
https://github.com/menudocs/eslint-config-tesseract
eslint lint menudocs rules yarn
Last synced: about 1 month ago
JSON representation
Some rules everyone should follow.
- Host: GitHub
- URL: https://github.com/menudocs/eslint-config-tesseract
- Owner: MenuDocs
- Created: 2020-04-28T08:43:14.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-04T14:58:43.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T05:51:22.328Z (2 months ago)
- Topics: eslint, lint, menudocs, rules, yarn
- Language: JavaScript
- Size: 97.7 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MenuDocs-lint
> Central shareable eslint config for all MenuDocs projects
## Installation
## Pre-requisites
- [ESLint](https://eslint.org)
### npm
```shell
npm i -D eslint-config-tesseract eslint
```
### yarn
```shell
yarn add -D eslint-config-tesseract eslint
```
### GitHub
- npm:
```shell
npm i --save-dev MenuDocs/eslint-config-tesseract eslint
```
- yarn:
```shell
yarn add -D MenuDocs/eslint-config-tesseract eslint
```
## Standard ESLint rules
```json
{
"extends": "tesseract"
}
```
## Standar ESlint rules for Typescript
- npm:
```shell
npm i --save-dev @typescript-eslint/parser @typescript-eslint/eslint-plugin
```
- yarn:
```shell
yarn add -D @typescript-eslint/parser @typescript-eslint/eslint-plugin
```
```json
{
"extends": "tesseract/typescript"
}
```
## Prettier
- npm:
```shell
npm i --save-dev prettier eslint-plugin-prettier eslint-config-prettier
```
- yarn:
```shell
yarn add -D prettier eslint-plugin-prettier eslint-config-prettier
```
## Standard ESLint rules and Prettier
```json
{
"extends": "tesseract/prettier"
}
```
## Standard ESLint rules and Prettier for Typescript
Note: Prettier config extends TypeScript eslint config.
```json
{
"extends": "tesseract/prettier/typescript"
}
```
## Setting up ESLint rules
ESLint may display a lot of warnings and errors about your code when you start using it, but don't let this startle you. In order to get started, follow these steps:
1) Create a file in your root directory named `.eslintrc.json` (where your main project file is located).
2) Copy the code below into the file.
```json
{
"extends": "tesseract"
}
```