Skip to content

Commit

Permalink
fix(readme): update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
joseacabaneros committed Oct 21, 2024
1 parent 4cbcd07 commit e7b3f7b
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 6 deletions.
56 changes: 52 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# @empathyco/eslint-config

![NPM Version](https://img.shields.io/npm/v/%40empathyco%2Feslint-config)
[![code style](https://antfu.me/badge-code-style.svg)](https://github.com/antfu/eslint-config)

- [ESLint](https://eslint.org/) as code linter sharing configuration preset.
- [Prettier](https://github.com/prettier/prettier) as code formatter sharing configuration preset.
- [@antfu/eslint-config](https://github.com/antfu/eslint-config) as default ESLint config preset.
- [Prettier](https://github.com/prettier/prettier) as code formatter sharing config preset.
- [@eslint/config-inspector](https://github.com/eslint/config-inspector) the visual tool for inspecting and understanding your ESLint flat configs.

> [!NOTE]
> The ESLint and Prettier dependencies are referenced in the package itself, so there is no
> needed to install them in your project.
## Usage

### Install
Expand All @@ -12,7 +20,9 @@
npm i -D eslint @empathyco/eslint-config
```

And create `eslint.config.mjs` in your project root:
### ESLint config

Create `eslint.config.mjs` in your project root:

```js
// eslint.config.mjs
Expand All @@ -21,9 +31,19 @@ import { empathyco } from '@empathyco/eslint-config';
export default empathyco();
```

### Add script for package.json
### Prettier config

Reference shared config file into `package.json`:

```json
{
"prettier": "@empathyco/eslint-config/prettier"
}
```

### Add scripts for `package.json`

For example:
This is a script set that you can add to your repository:

```json
{
Expand All @@ -36,3 +56,31 @@ For example:
}
}
```

### Customization

Configure the initial preset with the same parameters as expose [@antfu/eslint-config](https://github.com/antfu/eslint-config/blob/main/README.md#customization)

Example:

```js
import { empathyco } from '@empathyco/eslint-config';

export default empathyco(
// Configures for empathyco's (antfu) config.
{},
// From the second arguments they are ESLint Flat Configs.
// You can have multiple configs.
{
rules: {
'vue/custom-event-name-casing': 'off'
}
},
{
files: ['**/*.spec.{ts,tsx,js,jsx}'],
rules: {
'jsdoc/check-param-names': 'off'
}
}
);
```
3 changes: 1 addition & 2 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,5 @@ export async function empathyco(options: AntfuParams[0] = {}, ...userConfigs: An

/**
* Pending:
* Stylelint?
* Publish NPM package (GitHub actions)
* Stylelint
*/

0 comments on commit e7b3f7b

Please sign in to comment.