refactor: audit_level → severity_level

basaldev · Apr 18, 2023 · 49b8282 · 49b8282
1 parent 55b254a
commit 49b8282
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ If vulnerabilities are found by `yarn npm audit`, Action triggered by push, sche
 
 |Parameter|Required|Default Value|Description|
 |:--:|:--:|:--:|:--|
-|severity|false|low|The value of `--severity` flag|
+|severity_level|false|low|The value of `--severity` flag|
 |create_issues|false|true|Flag to create issues when vulnerabilities are found|
 |create_pr_comments|false|true|Flag to create pr comments when vulnerabilities are found|
 |dedupe_issues|false|false|Flag to de-dupe against open issues|
@@ -67,7 +67,7 @@ jobs:
         run: yarn install
       - uses: basaldev/yarn-npm-audit-action@v2
         with:
-          audit_level: moderate
+          severity_level: moderate
           github_token: ${{ secrets.MY_GITHUB_ACCESS_TOKEN }}
           issue_assignees: basal-luke
           issue_labels: vulnerability,test

diff --git a/action.yml b/action.yml
@@ -2,7 +2,7 @@ name: 'yarn npm audit action'
 description: 'run yarn npm audit'
 author: 'basal-luke <luke@basal.dev>'
 inputs:
-  audit_level:
+  severity_level:
     description: 'The value of `--severity` flag'
     default: low
     required: false

diff --git a/src/audit.ts b/src/audit.ts
@@ -8,13 +8,13 @@ export class Audit {
   private status: number | null = null
 
   public run(
-    auditLevel: string,
+    severityLevel: string,
     productionFlag: string,
     jsonFlag: string,
     resursiveFlag: string
   ): void {
     try {
-      const auditOptions: Array<string> = ['audit', '--severity', auditLevel]
+      const auditOptions: Array<string> = ['audit', '--severity', severityLevel]
 
       const isWindowsEnvironment: boolean = process.platform == 'win32'
       const cmd: string = isWindowsEnvironment ? 'yarn npm.cmd' : 'yarn npm'

diff --git a/src/main.ts b/src/main.ts
@@ -19,14 +19,14 @@ export async function run(): Promise<void> {
     }
     core.info(`Current working directory: ${process.cwd()}`)
 
-    // get audit-level
-    const auditLevel = core.getInput('severity', {required: true})
+    // get severity-level
+    const severityLevel = core.getInput('severity', {required: true})
     if (
       !['critical', 'high', 'moderate', 'low', 'info', 'none'].includes(
-        auditLevel
+        severityLevel
       )
     ) {
-      throw new Error('Invalid input: severity')
+      throw new Error('Invalid input: severity_level')
     }
 
     const productionFlag = core.getInput('production_flag', {required: false})
@@ -46,7 +46,7 @@ export async function run(): Promise<void> {
 
     // run `npm audit`
     const audit = new Audit()
-    audit.run(auditLevel, productionFlag, jsonFlag, recursiveFlag)
+    audit.run(severityLevel, productionFlag, jsonFlag, recursiveFlag)
     core.info(audit.stdout)
     core.setOutput('npm_audit', audit.stdout)