Merge pull request #118 from issue-ops/ncalteen/opt

Skip validators for fields not present in the issue

Author: ncalteen

__tests__/validate.test.ts

@@ -185,4 +185,36 @@ describe('validate()', () => {
 
     existsSyncSpy.mockRestore()
   })
+
+  it('Skips running custom validators for fields not in the issue', async () => {
+    const existsSyncSpy = jest.spyOn(fs, 'existsSync').mockReturnValue(true)
+    const fsReadFileSyncSpy = jest
+      .spyOn(fs, 'readFileSync')
+      .mockReturnValue('validators:\n  - field: test\n    script: test.js\n')
+
+    const errors: string[] = await validate(
+      {
+        'read-team': {
+          label: 'test',
+          type: 'input',
+          required: true
+        },
+        'write-team': {
+          label: 'test',
+          type: 'input',
+          required: true
+        }
+      },
+      {
+        'read-team': 'IssueOps-Demo-Readers',
+        'write-team': 'IssueOps-Demo-Writers'
+      },
+      process.cwd()
+    )
+
+    expect(errors).toEqual([])
+
+    existsSyncSpy.mockRestore()
+    fsReadFileSyncSpy.mockRestore()
+  })
 })

badges/coverage.svg

@@ -1,7 +1,7 @@
 {
   "name": "issue-ops-validator",
   "description": "Validate issue form submissions",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "author": "Nick Alteen <[email protected]>",
   "type": "module",
   "homepage": "https://github.com/issue-ops/validator#readme",

dist/index.js

@@ -46,6 +46,13 @@ export async function validate(
   )
 
   for (const validator of config.validators) {
+    if (Object.keys(issue).includes(validator.field) === false) {
+      core.info(
+        `Field '${validator.field}' not found in issue, skipping validator`
+      )
+      continue
+    }
+
     core.info(
       `Running custom validator '${validator.script}' on '${validator.field}'`
     )