Skip to content

Commit ffd8834

Browse files
committed
docs: update.
Signed-off-by: Chao Wang <[email protected]>
1 parent b35967a commit ffd8834

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ vulnerability report.
5151
- For Golang projects, analyzing a `go.mod` file, you must have the `go` binary in your IDE's `PATH` environment. Furthermore, Golang projects can only be analyzed with IntelliJ Ultimate Edition.
5252
- For Python projects, analyzing a `requirements.txt` file, you must have the `python3` and `pip3` binaries in your
5353
IDE's `PATH` environment.
54-
- For Gradle projects, analyzing a `build.gradle` file, you must have the `gradle` binary in your system's `PATH` environment.
54+
- For Gradle projects, analyzing a `build.gradle` file or `build.gradle.kts` file, you must have the `gradle` binary in your system's `PATH` environment.
5555
- For base images, analyzing a `Dockerfile`, you must have the [`syft`](https://github.com/anchore/syft?tab=readme-ov-file#installation) and [`skopeo`](https://github.com/containers/skopeo/blob/main/install.md) binaries in your IDE's `PATH` environment.
5656

5757
**Procedure**

src/main/resources/META-INF/plugin.xml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
IDE's <code>PATH</code> environment.
4040
</li>
4141
<li>For Node projects, analyzing a <code>package.json</code> file, you must have one of the corresponding package manager <code>npm</code>, <code>pnpm</code> or <code>yarn</code> and
42-
<code>node</code> binaries in your IDE's <code>PATH</code> environment.
42+
<code>node</code> binaries in your IDE's <code>PATH</code> environment. It also requires a corresponding lock file to be present in order to analyze package.json files.
4343
</li>
4444
<li>For Golang projects, analyzing a <code>go.mod</code> file, you must have the <code>go</code> binary in your
4545
IDE's <code>PATH</code> environment. Furthermore, Golang projects can only be analyzed with IntelliJ Ultimate Edition.
@@ -48,7 +48,7 @@
4848
<code>pip3</code> binaries in your IDE's <code>PATH</code> environment.
4949
</li>
5050
<li>
51-
For Gradle projects, analyzing a <code>build.gradle</code> file, you must have the <code>gradle</code> binary in your system's <code>PATH</code> environment.
51+
For Gradle projects, analyzing a <code>build.gradle</code> file or <code>build.gradle.kts</code> file, you must have the <code>gradle</code> binary in your system's <code>PATH</code> environment.
5252
</li>
5353
<li>For base images, analyzing a <code>Dockerfile</code>, you must have the <code><a
5454
href="https://github.com/anchore/syft?tab=readme-ov-file#installation" rel="noopener noreferrer"
@@ -122,6 +122,7 @@
122122
executable.
123123
<br>If the paths are not provided, your IDE's <code>PATH</code> environment will be used to locate the
124124
executables.
125+
<br>It also requires a corresponding lock file to be present in order to analyze package.json files.
125126
</li>
126127
<li>
127128
<b>Golang</b>:
@@ -396,7 +397,7 @@
396397
<p>Added support for Proxy setting.</p>
397398
<p>Enable using the Maven Wrapper.</p>
398399
<p>No restart needed after installation.</p>
399-
<p>Opening and analysing a single package.json file in editor is not supposed anymore.</p>
400+
<p>Require a lock file to be present in order to analyze package.json files.</p>
400401
<p><b>1.0.0</b></p>
401402
<p>Added support for base image vulnerability scanning in Dockerfiles.</p>
402403
<p>Bumped Telemetry plugin to 1.1.0.</p>

0 commit comments

Comments
 (0)