Skip to content

Commit 7d90426

Browse files
committed
update docs with suggested feedback
1 parent 267ae02 commit 7d90426

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

PLUGINS.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Some plugins come built-in with the scanner and can be enabled via [actions inpu
66

77
## How plugins work
88

9-
Plugins are dynamically loaded by the scanner when it runs. The scanner will look into the `./.github` folder in your repo (where you run the workflow from) and search for a `scanner-plugins` folder. If it finds it, it will assume each folder under that is a plugin, and attempt to load the `index.ts` (first) or `index.js` (second) file inside it. Once loaded, the scanner will invoke the exported default function from the `index.js/ts` file.
9+
Plugins are dynamically loaded by the scanner when it runs. The scanner will look into the `./.github` folder in your repo (where you run the workflow from) and search for a `scanner-plugins` folder. If it finds it, it will assume each folder under that is a plugin, and attempt to load the `index.ts` (first) or `index.js` (second) file inside it. Once loaded, the scanner will invoke the exported default function from the `index.js/index.ts` file.
1010

1111
### Default function API
1212

@@ -28,8 +28,8 @@ As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For
2828

2929
- Each separate plugin should be contained in it's own directory in `./.github/scanner-plugins`. For example, `./.github/scanner-plugins/plugin-1` would be 1 plugin loaded by the scanner.
3030
- Each plugin should have one `index.ts` OR `index.js` file inside its folder.
31-
- The `index.ts/js` file must export a `name` field. This is the name used to pass to the `scans` input. So if the plugin exports a name value of `my-custom-plugin` and we pass the following to the scanner action inputs: `scans: ['my-custom-plugin']`, it would cause the scanner to only run that plugin.
32-
- The `index.ts/js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function.
31+
- The `index.ts/index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So if the plugin exports a name value of `my-custom-plugin` and we pass the following to the scanner action inputs: `scans: ['my-custom-plugin']`, it would cause the scanner to only run that plugin.
32+
- The `index.ts/index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function.
3333

3434
## Things to look out for
3535

0 commit comments

Comments
 (0)