From 8e26e0971d1a0972fa66e0dd01585659c08a1419 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Krist=C3=B3f=20Poduszl=C3=B3?= <14854048+kripod@users.noreply.github.com> Date: Wed, 1 Jan 2025 07:31:53 +0100 Subject: [PATCH] docs: move additional setup steps to the bottom --- .changeset/mean-readers-rhyme.md | 5 +++++ README.md | 16 +++++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) create mode 100644 .changeset/mean-readers-rhyme.md diff --git a/.changeset/mean-readers-rhyme.md b/.changeset/mean-readers-rhyme.md new file mode 100644 index 0000000..83c3871 --- /dev/null +++ b/.changeset/mean-readers-rhyme.md @@ -0,0 +1,5 @@ +--- +"@kripod/eslint-config": patch +--- + +docs: move additional setup steps to the bottom diff --git a/README.md b/README.md index 0c3ee25..8c05d8c 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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)