Skip to content

Commit

Permalink
docs: add documentation about TypeScript setup
Browse files Browse the repository at this point in the history
  • Loading branch information
mfeltscher committed Dec 8, 2023
1 parent 9c7bc6b commit 425d294
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Create a `.eslintrc` file in the root of your project's directory (it should liv
}
```

### NPM scripts

To use eslint add the following to your package.json:

```json
Expand All @@ -40,3 +42,7 @@ To use eslint add the following to your package.json:
"lint:fix": "eslint . --fix"
}
```

### TypeScript configuration

Since there are some rules which require type information please make sure to set up a `tsconfig.json` configuration file in the root directory of your project. If your TypeScript configuration file is placed in another location you have to configure it using `parserOptions.project` in your ESLint configuration file. For more information have a look at the [typescript-eslint documentation](https://typescript-eslint.io/packages/parser/#project).

0 comments on commit 425d294

Please sign in to comment.