Introduce a schema for ConfigurationOptions.

This commit illustrates an approach, but is currently
failing the tests.

__tests__/config.test.ts

@@ -18,5 +18,5 @@ test('the default config path handles .yml and .yaml', async () => {
 test('returns a default config when the config file was not found', async () => {
     let options = readConfigFile("fixtures/i-dont-exist")
     expect(options.fail_on_severity).toEqual('low')
-    expect(options.allow_licenses).toEqual(['all'])
+    expect(options.allow_licenses).toEqual([])
 })

dist/index.js

@@ -1,6 +1,74 @@
 require('./sourcemap-register.js');/******/ (() => { // webpackBootstrap
 /******/ 	var __webpack_modules__ = ({
 
+/***/ 88:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.readConfigFile = exports.CONFIG_FILEPATH = exports.SEVERITIES = void 0;
+const fs = __importStar(__nccwpck_require__(7147));
+const yaml_1 = __importDefault(__nccwpck_require__(4083));
+const schemas_1 = __nccwpck_require__(8774);
+const path_1 = __importDefault(__nccwpck_require__(1017));
+exports.SEVERITIES = ["critical", "high", "moderate", "low"];
+exports.CONFIG_FILEPATH = "./.github/dep-review.yml";
+function readConfigFile(filePath = exports.CONFIG_FILEPATH) {
+    // By default we want to fail on all severities and allow all licenses.
+    const defaultOptions = {
+        fail_on_severity: 'low',
+        allow_licenses: []
+    };
+    let data;
+    try {
+        data = fs.readFileSync(path_1.default.resolve(filePath), "utf-8");
+    }
+    catch (error) {
+        if (error.code && error.code === 'ENOENT') {
+            return defaultOptions;
+        }
+        else {
+            throw error;
+        }
+    }
+    // This is a copy of line 34, not sure why this is failing!
+    schemas_1.ConfigurationOptionsSchema.parse({ fail_on_severity: 'critical', allow_licenses: ['BSD', 'GPL 2'] });
+    const values = yaml_1.default.parse(data);
+    const parsed = schemas_1.ConfigurationOptionsSchema.parse(values);
+    return parsed;
+}
+exports.readConfigFile = readConfigFile;
+
+
+/***/ }),
+
 /***/ 4966:
 /***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
 
@@ -209,8 +277,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
-exports.ChangesSchema = exports.PullRequestSchema = exports.ChangeSchema = void 0;
+exports.ChangesSchema = exports.ConfigurationOptionsSchema = exports.PullRequestSchema = exports.ChangeSchema = void 0;
 const z = __importStar(__nccwpck_require__(3301));
+const config_1 = __nccwpck_require__(88);
 exports.ChangeSchema = z.object({
     change_type: z.enum(['added', 'removed']),
     manifest: z.string(),
@@ -235,6 +304,12 @@ exports.PullRequestSchema = z.object({
     base: z.object({ sha: z.string() }),
     head: z.object({ sha: z.string() })
 });
+exports.ConfigurationOptionsSchema = z.object({
+    fail_on_severity: z.enum(config_1.SEVERITIES).default("low"),
+    allow_licenses: z.array(z.string()).default([]),
+    deny_licenses: z.array(z.string()).default([])
+}).partial()
+    .refine(obj => !(obj.allow_licenses && obj.deny_licenses), "Can't specify both allow_licenses and deny_licenses");
 exports.ChangesSchema = z.array(exports.ChangeSchema);
 
 
@@ -13622,16 +13697,15 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.readConfigFile = exports.CONFIG_FILEPATH = exports.SEVERITIES = void 0;
 const fs = __importStar(__nccwpck_require__(7147));
 const yaml_1 = __importDefault(__nccwpck_require__(4083));
-const z = __importStar(__nccwpck_require__(3301));
+const schemas_1 = __nccwpck_require__(1129);
 const path_1 = __importDefault(__nccwpck_require__(1017));
 exports.SEVERITIES = ["critical", "high", "moderate", "low"];
 exports.CONFIG_FILEPATH = "./.github/dep-review.yml";
 function readConfigFile(filePath = exports.CONFIG_FILEPATH) {
     // By default we want to fail on all severities and allow all licenses.
     const defaultOptions = {
-        fail_on_severity: "low",
+        fail_on_severity: 'low',
-        allow_licenses: ['all'],
+        allow_licenses: []
-        deny_licenses: []
     };
     let data;
     try {
@@ -13645,15 +13719,10 @@ function readConfigFile(filePath = exports.CONFIG_FILEPATH) {
             throw error;
         }
     }
+    // This is a copy of line 34, not sure why this is failing!
+    schemas_1.ConfigurationOptionsSchema.parse({ fail_on_severity: 'critical', allow_licenses: ['BSD', 'GPL 2'] });
     const values = yaml_1.default.parse(data);
-    const parsed = z.object({
+    const parsed = schemas_1.ConfigurationOptionsSchema.parse(values);
-        fail_on_severity: z.enum(exports.SEVERITIES),
-        allow_licenses: z.array(z.string()),
-        deny_licenses: z.array(z.string())
-    })
-        .partial()
-        .refine(obj => !(obj.allow_licenses && obj.deny_licenses), "Can't specify both allow_licenses and deny_licenses")
-        .parse(values);
     return parsed;
 }
 exports.readConfigFile = readConfigFile;
@@ -13691,6 +13760,73 @@ function filterChangesBySeverity(severity, changes) {
 exports.filterChangesBySeverity = filterChangesBySeverity;
 
 
+/***/ }),
+
+/***/ 1129:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
+
+"use strict";
+
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.ChangesSchema = exports.ConfigurationOptionsSchema = exports.PullRequestSchema = exports.ChangeSchema = void 0;
+const z = __importStar(__nccwpck_require__(3301));
+const config_1 = __nccwpck_require__(6373);
+exports.ChangeSchema = z.object({
+    change_type: z.enum(['added', 'removed']),
+    manifest: z.string(),
+    ecosystem: z.string(),
+    name: z.string(),
+    version: z.string(),
+    package_url: z.string(),
+    license: z.string().nullable(),
+    source_repository_url: z.string().nullable(),
+    vulnerabilities: z
+        .array(z.object({
+        severity: z.enum(['critical', 'high', 'moderate', 'low']),
+        advisory_ghsa_id: z.string(),
+        advisory_summary: z.string(),
+        advisory_url: z.string()
+    }))
+        .optional()
+        .default([])
+});
+exports.PullRequestSchema = z.object({
+    number: z.number(),
+    base: z.object({ sha: z.string() }),
+    head: z.object({ sha: z.string() })
+});
+exports.ConfigurationOptionsSchema = z.object({
+    fail_on_severity: z.enum(config_1.SEVERITIES).default("low"),
+    allow_licenses: z.array(z.string()).default([]),
+    deny_licenses: z.array(z.string()).default([])
+}).partial()
+    .refine(obj => !(obj.allow_licenses && obj.deny_licenses), "Can't specify both allow_licenses and deny_licenses");
+exports.ChangesSchema = z.array(exports.ChangeSchema);
+
+
 /***/ }),
 
 /***/ 2877:

src/config.ts

@@ -1,6 +1,6 @@
 import * as fs from 'fs'
 import YAML from 'yaml'
-import * as z from 'zod'
+import { ConfigurationOptions, ConfigurationOptionsSchema } from './schemas'
 import path from 'path'
 
 export type Severity = "critical" | "high" | "moderate" | "low"
@@ -8,18 +8,11 @@ export type Severity = "critical" | "high" | "moderate" | "low"
 export const SEVERITIES = ["critical", "high", "moderate", "low"] as const
 export const CONFIG_FILEPATH = "./.github/dep-review.yml"
 
-type ConfigurationOptions = {
-    fail_on_severity: string,
-    allow_licenses: Array<string>,
-    deny_licenses: Array<string>
-}
-
 export function readConfigFile(filePath: string = CONFIG_FILEPATH): ConfigurationOptions {
     // By default we want to fail on all severities and allow all licenses.
     const defaultOptions: ConfigurationOptions = {
-        fail_on_severity: "low",
+        fail_on_severity: 'low',
-        allow_licenses: ['all'],
+        allow_licenses: []
-        deny_licenses: []
     }
 
     let data
@@ -34,16 +27,11 @@ export function readConfigFile(filePath: string = CONFIG_FILEPATH): Configuratio
         }
     }
 
+    // This is a copy of line 34, not sure why this is failing!
+    ConfigurationOptionsSchema.parse({ fail_on_severity: 'critical', allow_licenses: ['BSD', 'GPL 2'] })
+
     const values = YAML.parse(data)
+    const parsed = ConfigurationOptionsSchema.parse(values)
 
-    const parsed = z.object({
+    return parsed;
-        fail_on_severity: z.enum(SEVERITIES),
-        allow_licenses: z.array(z.string()),
-        deny_licenses: z.array(z.string())
-    })
-        .partial()
-        .refine(obj => !(obj.allow_licenses && obj.deny_licenses), "Can't specify both allow_licenses and deny_licenses")
-        .parse(values)
-
-    return <ConfigurationOptions>parsed;
 }

src/schemas.ts

@@ -1,4 +1,5 @@
 import * as z from 'zod'
+import { SEVERITIES } from './config'
 
 export const ChangeSchema = z.object({
   change_type: z.enum(['added', 'removed']),
@@ -28,6 +29,15 @@ export const PullRequestSchema = z.object({
   head: z.object({ sha: z.string() })
 })
 
+export const ConfigurationOptionsSchema = z.object({
+  fail_on_severity: z.enum(SEVERITIES).default("low"),
+  allow_licenses: z.array(z.string()).default([]),
+  deny_licenses: z.array(z.string()).default([])
+}).partial()
+  .refine(obj => !(obj.allow_licenses && obj.deny_licenses), "Can't specify both allow_licenses and deny_licenses")
+
 export const ChangesSchema = z.array(ChangeSchema)
+
 export type Change = z.infer<typeof ChangeSchema>
 export type Changes = z.infer<typeof ChangesSchema>
+export type ConfigurationOptions = z.infer<typeof ConfigurationOptionsSchema>