Skip to content

Commit

Permalink
Added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jeroenvanwissen committed Sep 4, 2023
1 parent 60685fe commit a94c60f
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 3 deletions.
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# @fastone/eslint-config

[![npm version](https://badge.fury.io/js/%40fastone%2Feslint-config.svg)](https://badge.fury.io/js/%40fastone%2Feslint-config)
[![npm downloads](https://img.shields.io/npm/dm/%40fastone%2Feslint-config.svg)](https://www.npmjs.com/package/%40fastone%2Feslint-config)
[![GitHub stars](https://img.shields.io/github/stars/fastone/eslint-config.svg?style=social&label=Star&maxAge=2592000)](https://github.com/fastone/eslint-config)

## Description
This is a sharable eslint config for TypeScript React projects.
One config to rule all them projects.

## Installation
`npm install https://github.com/fastone/eslint-config.git`

## Usage
Create `.eslintrc.cjs` in the root of your project with the following content:

```
/** @type {import('eslint').Linter.Config} */
module.exports = {
extends: ['@fastone/eslint-config'],
parserOptions: {
tsconfigRootDir: __dirname,
},
};
```

## To Do

- [ ] Make this a public package on npm `npm install @fastone/eslint-config`
- [ ] Double check and update the rules while using it in a real project
4 changes: 2 additions & 2 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ module.exports = {
},
ecmaVersion: 'latest',
sourceType: 'module',
tsconfigRootDir: __dirname,
project: ['tsconfig.json', 'tsconfig.node.json']
tsconfigRootDir: '.',
project: ['./tsconfig.json', './tsconfig.node.json', './.eslintrc.cjs']
},
// Configuring third-party plugins
plugins: [
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@fastone/eslint-config",
"author": "fastone",
"version": "1.0.4",
"version": "1.0.6",
"description": "ESLint config to rule them all",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit a94c60f

Please sign in to comment.