Skip to content

Commit

Permalink
Fix some install steps (#154)
Browse files Browse the repository at this point in the history
Fix the static analysis docs to only make you install
`typescript-eslint` and the DBOS `eslint` plugin. Earlier, for the flat
config setup path, there was a conflict with installing both
`typescript-eslint` and `eslint` manually, but this solves that issue
(and `typescript-eslint` then pulls in a working version of `eslint`
with it).
  • Loading branch information
CaspianA1 authored Jul 8, 2024
1 parent 068001e commit 189e1d5
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/api-reference/static-analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Plugins to support TypeScript and detect common vulnerabilities are automaticall

To install the `eslint` package and the DBOS plugin:
```bash
npm install --save-dev eslint
npm install --save-dev typescript-eslint
npm install --save-dev @dbos-inc/eslint-plugin
```

Expand All @@ -50,8 +50,7 @@ Both of these options require you to set up a `tsconfig.json` file beforehand.
<Tabs groupId="config-types">
<TabItem value="flat-config" label="Flat config">
<h4> This config style will work with ESLint 8 and above. </h4>
For this config style, first run `npm install --save-dev typescript-eslint` (more info can be found [here](https://typescript-eslint.io/packages/typescript-eslint/)).
Then, place an `eslint.config.js` file similar to the following in your project directory.
Place an `eslint.config.js` file similar to the following in your project directory.

```js
const { FlatCompat } = require("@eslint/eslintrc");
Expand Down

0 comments on commit 189e1d5

Please sign in to comment.