Handle package-json-validator breaking changes

Author: Silic0nS0ldier

src/main.ts

@@ -1,6 +1,6 @@
 import semver from "semver";
 import { intersect as semverIntersect } from "semver-intersect";
-import { PJV, INpmValidateResult } from "package-json-validator";
+import { validate as packageJsonValidator } from "package-json-validator";
 import fs from "fs";
 import path from "path";
 import chalk from "chalk";
@@ -14,8 +14,6 @@ export {
     InvalidBowerPackageException,
 } from "./exceptions.js";
 
-const packageJsonValidator = PJV.validate;
-
 // Known dependency keys
 const npmDependencyTypes = [
     "dependencies",
@@ -61,6 +59,14 @@ interface ITemplatePath {
     path: string;
 }
 
+interface INpmValidateResult {
+    valid: boolean;
+    errors?: { field: string; message: string }[];
+    critical?: Record<string, string> | string;
+    warnings?: string[];
+    recommendations?: string[];
+}
+
 /**
  * @public
  */
@@ -296,7 +302,10 @@ function npmValidate(pkg: INodeTemplate, pkgSpec: string, log: LogOption): void
             if (pkg[depType] && typeof pkg[depType] !== 'object') {
                 if (!results.errors) results.errors = [];
                 results.valid = false;
-                results.errors.push(`"${depType}" must be an object.`);
+                results.errors.push({
+                    field: depType,
+                    message: "must be an object."
+                });
             }
         }
     }
@@ -328,14 +337,16 @@ function npmErrors(results: INpmValidateResult, log: LogOption): void {
     if (log) {
         // Announce critical errors.
         if (results.critical) {
-            log(chalk.bgRed("Critical Error: ") + chalk.red(results.critical));
+            const criticalError = typeof results.critical === "string" ? results.critical : JSON.stringify(results.critical);
+            log(chalk.bgRed("Critical Error: ") + chalk.red(criticalError));
         }
 
         // Announce errors.
         if (results.errors) {
             log(chalk.underline.red("Errors:"));
             for (let error of results.errors) {
-                log("  " + chalk.red(error));
+                const errorMessage = `${error.field}: ${error.message}`;
+                log("  " + chalk.red(errorMessage));
             }
         }
 

src/missing-types.d.ts

@@ -1,34 +1,3 @@
 declare module "semver-intersect" {
     export function intersect(...versions: string[]): string;
 }
-
-declare module "package-json-validator" {
-    export interface INpmValidateResult {
-        valid: boolean;
-        errors?: string[];
-        critical?: string;
-        warnings?: string[];
-        recommendations?: string[]
-    }
-    type PackageSpecs = "npm" | "commonjs_1.0" | "commonjs_1.1";
-    type PJV = {
-        packageFormat: string,
-        versionFormat: string,
-        urlFormat: string,
-        emailFormat: string,
-        getSpecMap(specName: PackageSpecs): false | {},
-        parse(data: string): string;
-        validate(
-            data: string,
-            specName?: PackageSpecs,
-            options?: {}
-        ): INpmValidateResult,
-        validateType(name: string, field: {}, value: any): string[],
-        validateDependencies(name: string, deps: {}): string[],
-        isValidVersionRange(v: string): boolean,
-        validateUrlOrMailto(name: string, obj: {}): string[],
-        validatePeople(name: string, obj: {}): string[],
-        validateUrlTypes(name: string, obj: {}): string[],
-    }
-    export const PJV: PJV;
-}