From be5c3d95e833aebb92327d60cbae1dda2977c5f3 Mon Sep 17 00:00:00 2001 From: Jean <110341611+jean-michelet@users.noreply.github.com> Date: Wed, 31 Jan 2024 11:48:24 +0100 Subject: [PATCH] Update doc (#226) * docs: add ts-source-parser workspace * docs: replace RuntimeOptions by RuntimeFileOptions runASTAnalysisOnFile description --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 69b3008..4b42ec3 100644 --- a/README.md +++ b/README.md @@ -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 -
runASTAnalysis(str: string, options?: RuntimeOptions): Report @@ -165,10 +164,10 @@ interface Report { runASTAnalysisOnFile(pathToFile: string, options?: RuntimeFileOptions): Promise< ReportOnFile > ```ts -interface RuntimeOptions { +interface RuntimeFileOptions { module?: boolean; - isMinified?: boolean; removeHTMLComments?: boolean; + packageName?: string; } ``` @@ -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