Introduce two new APIs loadNodePackageJson() and tryLoadNodePackageJsonFor() that return INodePackageJson

octogonz · octogonz · commit 1446574cfbaa · 2019-03-18T22:16:01.000-07:00
diff --git a/common/reviews/api/node-core-library.api.md b/common/reviews/api/node-core-library.api.md
@@ -423,10 +423,12 @@ declare class PackageJsonLookup {
     // (undocumented)
     constructor(parameters?: IPackageJsonLookupParameters);
     clearCache(): void;
+    loadNodePackageJson(jsonFilename: string): INodePackageJson;
     static loadOwnPackageJson(dirnameOfCaller: string): IPackageJson;
     loadPackageJson(jsonFilename: string): IPackageJson;
     tryGetPackageFolderFor(fileOrFolderPath: string): string | undefined;
     tryGetPackageJsonFilePathFor(fileOrFolderPath: string): string | undefined;
+    tryLoadNodePackageJsonFor(fileOrFolderPath: string): INodePackageJson | undefined;
     tryLoadPackageJsonFor(fileOrFolderPath: string): IPackageJson | undefined;
 }
 
diff --git a/libraries/node-core-library/src/PackageJsonLookup.ts b/libraries/node-core-library/src/PackageJsonLookup.ts
@@ -5,7 +5,7 @@
 
 import * as path from 'path';
 import { JsonFile } from './JsonFile';
-import { IPackageJson } from './IPackageJson';
+import { IPackageJson, INodePackageJson } from './IPackageJson';
 import { FileConstants } from './Constants';
 import { FileSystem } from './FileSystem';
 
@@ -177,6 +177,18 @@ export class PackageJsonLookup {
     return this.loadPackageJson(packageJsonFilePath);
   }
 
+  /**
+   * This function is similar to {@link tryLoadPackageJsonFor}, except that it does not report an error if the
+   * `version` field is missing from the package.json file.
+   */
+  public tryLoadNodePackageJsonFor(fileOrFolderPath: string): INodePackageJson | undefined {
+    const packageJsonFilePath: string | undefined = this.tryGetPackageJsonFilePathFor(fileOrFolderPath);
+    if (!packageJsonFilePath) {
+      return undefined;
+    }
+    return this.loadNodePackageJson(packageJsonFilePath);
+  }
+
   /**
    * Loads the specified package.json file, if it is not already present in the cache.
    *
@@ -189,6 +201,21 @@ export class PackageJsonLookup {
    * @param jsonFilename - a relative or absolute path to a package.json file
    */
   public loadPackageJson(jsonFilename: string): IPackageJson {
+    const packageJson: INodePackageJson = this.loadNodePackageJson(jsonFilename);
+
+    if (!packageJson.version) {
+      throw new Error(`Error reading "${jsonFilename}":\n  `
+        + 'The required field "version" was not found');
+    }
+
+    return packageJson as IPackageJson;
+  }
+
+  /**
+   * This function is similar to {@link loadPackageJson}, except that it does not report an error if the
+   * `version` field is missing from the package.json file.
+   */
+  public loadNodePackageJson(jsonFilename: string): INodePackageJson {
     if (!FileSystem.exists(jsonFilename)) {
       throw new Error(`Input file not found: ${jsonFilename}`);
     }
diff --git a/libraries/node-core-library/src/test/PackageJsonLookup.test.ts b/libraries/node-core-library/src/test/PackageJsonLookup.test.ts
@@ -3,7 +3,7 @@
 
 import * as path from 'path';
 import { PackageJsonLookup } from '../PackageJsonLookup';
-import { IPackageJson } from '../IPackageJson';
+import { IPackageJson, INodePackageJson } from '../IPackageJson';
 import { FileConstants } from '../Constants';
 
 describe('PackageJsonLookup', () => {
@@ -28,10 +28,10 @@ describe('PackageJsonLookup', () => {
       }
     });
 
-    test('tryLoadPackageJsonFor() test package with no version', () => {
+    test('tryLoadNodePackageJsonFor() test package with no version', () => {
       const packageJsonLookup: PackageJsonLookup = new PackageJsonLookup();
       const sourceFilePath: string = path.join(__dirname, './test-data/example-package-no-version');
-      const packageJson: IPackageJson | undefined = packageJsonLookup.tryLoadPackageJsonFor(sourceFilePath);
+      const packageJson: INodePackageJson | undefined = packageJsonLookup.tryLoadNodePackageJsonFor(sourceFilePath);
       expect(packageJson).toBeDefined();
       if (packageJson) {
         expect(packageJson.name).toEqual('example-package');
