Skip to content

Commit

Permalink
fix(docs): update shareable configs usage examples
Browse files Browse the repository at this point in the history
  • Loading branch information
bent10 committed Aug 27, 2024
1 parent c894b84 commit 4dc769b
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,10 @@ Doogu provides shareable configs for ESLint, Prettier, and Semantic Release that

### ESLint Configuration

To extend the shareable ESLint configuration in your `package.json` file, add the following:
Create your `eslint.config.js` file, add the following:

```json
{
"eslintConfig": {
"extends": "./node_modules/doogu/eslint"
}
}
```js
export { default } from 'doogu/eslint.config.js'
```

### Prettier Configuration
Expand All @@ -51,7 +47,7 @@ To extend the shareable Prettier configuration in your `package.json` file, add

```json
{
"prettier": "doogu/prettier.json"
"prettier": "doogu/prettier.config.js"
}
```

Expand Down Expand Up @@ -93,7 +89,7 @@ Or do anything you want:
"build": "vite build --ssr src/index.ts && npm run types",
"test": "vitest --ui",
"coverage": "vitest run --coverage",
"types": "tsc -d --emitDeclarationOnly --outDir ./dist && resolve-tspaths -o ./dist",
"types": "tsc -d --emitDeclarationOnly --outDir ./dist",
"lint": "tsc --noEmit && eslint .",
"format": "prettier --write ."
}
Expand Down Expand Up @@ -123,4 +119,4 @@ git add . && git cz

## Thank you

A project by [Stilearning](https://stilearning.com) © 2022-2023.
A project by [Stilearning](https://stilearning.com) © 2022-2024.

0 comments on commit 4dc769b

Please sign in to comment.