Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update doc #226

Merged
merged 2 commits into from
Jan 31, 2024
Merged

Update doc #226

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
341b27c
docs: add ts-source-parser workspace
jean-michelet Jan 31, 2024
98d4797
docs: replace RuntimeOptions by RuntimeFileOptions runASTAnalysisOnFi…
jean-michelet Jan 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
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
Loading