Skip to content

Commit

Permalink
docs: move additional setup steps to the bottom
Browse files Browse the repository at this point in the history
  • Loading branch information
kripod committed Jan 1, 2025
1 parent b96ee08 commit 8e26e09
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
5 changes: 5 additions & 0 deletions .changeset/mean-readers-rhyme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@kripod/eslint-config": patch
---

docs: move additional setup steps to the bottom
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,15 @@ If using TypeScript, consider adopting [`@total-typescript/tsconfig`](https://gi
- Enable [`strictNullChecks`](https://www.typescriptlang.org/tsconfig/#strictNullChecks) or the broader [`strict`](https://www.typescriptlang.org/tsconfig/#strict) compiler option
- Set [`module`](https://www.typescriptlang.org/tsconfig/#module) to `Preserve` or `NodeNext`, as package entry points may fail to resolve otherwise

Package scripts can be added for convenience:
### Presets

- `base` — JS + TS, no framework-specific rules
- `type-checked` — Typed linting via [project service](https://typescript-eslint.io/troubleshooting/typed-linting/#project-service-issues)
- [Complements native-speed linters](https://typescript-eslint.io/troubleshooting/faqs/general/#how-does-typescript-eslint-compare-to-native-speed-linters)

### Additional setup

Package scripts may be added for convenience:

```jsonc
// package.json
Expand All @@ -62,9 +70,3 @@ Package scripts can be added for convenience:
},
}
```

### Presets

- `base` — JS + TS, no framework-specific rules
- `type-checked` — Typed linting via [project service](https://typescript-eslint.io/troubleshooting/typed-linting/#project-service-issues)
- [Complements native-speed linters](https://typescript-eslint.io/troubleshooting/faqs/general/#how-does-typescript-eslint-compare-to-native-speed-linters)

0 comments on commit 8e26e09

Please sign in to comment.