https://github.com/davidmyersdev/eslint-config-artisan
An opinionated ESLint configuration for artisans
https://github.com/davidmyersdev/eslint-config-artisan
Last synced: about 1 month ago
JSON representation
An opinionated ESLint configuration for artisans
- Host: GitHub
- URL: https://github.com/davidmyersdev/eslint-config-artisan
- Owner: davidmyersdev
- License: mit
- Created: 2023-05-16T19:15:34.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-31T22:22:33.000Z (over 2 years ago)
- Last Synced: 2024-10-29T23:48:09.571Z (over 1 year ago)
- Language: JavaScript
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `eslint-config-artisan`
An opinionated ESLint configuration for artisans
## Overview
This configuration is based on [`@antfu/eslint-config`](https://github.com/antfu/eslint-config) with some notable differences.
- Single quotes, but allow uninterpolated template literals for consistency
- Comma-delimited properties for object-like type definitions
- Use `type` and `interface` interchangeably for type definitions
- Braces are not required
- Single line braces are allowed
- Parenthesis for arrow functions are optional
## How to use it
Install the package in your project.
```bash
# npm
npm i -D eslint-config-artisan
# pnpm
pnpm add -D eslint-config-artisan
# yarn
yarn add -D eslint-config-artisan
```
Add it to your `.eslintrc` file.
```json
{
"extends": "artisan"
}
```
Add some scripts to your `package.json`.
```json
{
"scripts": {
"lint": "eslint .",
"lint:fix": "eslint --fix ."
}
}
```