Skip to content

Commit

Permalink
Update doc (#226)
Browse files Browse the repository at this point in the history
* docs: add ts-source-parser workspace

* docs: replace RuntimeOptions by RuntimeFileOptions runASTAnalysisOnFile description
  • Loading branch information
jean-michelet authored Jan 31, 2024
1 parent 4a07f1e commit be5c3d9
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,6 @@ This section describe all the possible warnings returned by JSXRay. Click on the
| [shady-link](./docs/shady-link.md) | ✔️ | The code contains shady/unsafe link |

## API

<details>
<summary>runASTAnalysis(str: string, options?: RuntimeOptions): Report</summary>

Expand Down Expand Up @@ -165,10 +164,10 @@ interface Report {
<summary>runASTAnalysisOnFile(pathToFile: string, options?: RuntimeFileOptions): Promise< ReportOnFile ></summary>

```ts
interface RuntimeOptions {
interface RuntimeFileOptions {
module?: boolean;
isMinified?: boolean;
removeHTMLComments?: boolean;
packageName?: string;
}
```

Expand Down Expand Up @@ -196,6 +195,7 @@ Click on one of the links to access the documentation of the workspace:
| --- | --- |
| estree-ast-utils | [@nodesecure/estree-ast-utils](./workspaces/estree-ast-utils) |
| sec-literal | [@nodesecure/sec-literal ](./workspaces/sec-literal) |
| ts-source-parser | [@nodesecure/ts-source-parser ](./workspaces/ts-source-parser) |
These packages are available in the Node Package Repository and can be easily installed with [npm](https://docs.npmjs.com/getting-started/what-is-npm) or [yarn](https://yarnpkg.com).
```bash
Expand Down

0 comments on commit be5c3d9

Please sign in to comment.