Skip to content

Commit 6cfe283

Browse files
docs: better example of installation
1 parent fe8f2b0 commit 6cfe283

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Almost all of these rules require the TypeScript parser for ESLint and are indic
1717

1818
See [typescript-eslint's Getting Started](https://typescript-eslint.io/getting-started) for a full ESLint setup guide.
1919

20-
Then use the `recommended` configuration in your `eslint.config.mjs`:
20+
Then use the `recommended` configuration in your `eslint.config.mjs` and enable typed linting:
2121

2222
```js
2323
// @ts-check
@@ -26,6 +26,7 @@ import rxjsX from 'eslint-plugin-rxjs-x';
2626

2727
export default tseslint.config({
2828
extends: [
29+
...tseslint.configs.recommended,
2930
rxjsX.configs.recommended,
3031
],
3132
languageOptions: {
@@ -36,6 +37,10 @@ export default tseslint.config({
3637
});
3738
```
3839

40+
The above example uses `typescript-eslint`'s built-in config to set up the TypeScript parser for us.
41+
Enabling `projectService` then turns on typed linting.
42+
See [Linting with Type Information](https://typescript-eslint.io/getting-started/typed-linting/) for details.
43+
3944
## Configs
4045

4146
<!-- begin auto-generated configs list -->

0 commit comments

Comments
 (0)