Allow packages to not have a version field

Alan Agius · Alan Agius · commit d2b3fbf0e1a1 · 2019-03-04T15:41:01.000+01:00
NPM does now allow that, this is actually a node implementation of modules. NPM will only validate the primary package.json and fail on publish if version is missing. In the node documentation for modules it is clearly specified the the only requirement is the 'main' property Closes: microsoft#1044
diff --git a/apps/api-extractor/src/api/Extractor.ts b/apps/api-extractor/src/api/Extractor.ts
@@ -98,7 +98,7 @@ export class Extractor {
   /**
    * Returns the version number of the API Extractor NPM package.
    */
-  public static get version(): string {
+  public static get version(): string | undefined {
     return Extractor._getPackageJson().version;
   }
 
diff --git a/libraries/node-core-library/src/IPackageJson.ts b/libraries/node-core-library/src/IPackageJson.ts
@@ -59,7 +59,7 @@ export interface IPackageJson {
   /**
    * A version number conforming to the Semantic Versioning (SemVer) standard.
    */
-  version: string;
+  version?: string;
 
   /**
    * Indicates whether this package is allowed to be published or not.
diff --git a/libraries/node-core-library/src/PackageJsonLookup.ts b/libraries/node-core-library/src/PackageJsonLookup.ts
@@ -201,10 +201,6 @@ export class PackageJsonLookup {
         throw new Error(`Error reading "${jsonFilename}":\n  `
           + 'The required field "name" was not found');
       }
-      if (!loadedPackageJson.version) {
-        throw new Error(`Error reading "${jsonFilename}":\n  `
-          + 'The required field "version" was not found');
-      }
 
       if (this._loadExtraFields) {
         packageJson = loadedPackageJson;
diff --git a/libraries/node-core-library/src/test/PackageJsonLookup.test.ts b/libraries/node-core-library/src/test/PackageJsonLookup.test.ts
@@ -28,6 +28,20 @@ describe('PackageJsonLookup', () => {
       }
     });
 
+    test('tryLoadPackageJsonFor() 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);
+      expect(packageJson).toBeDefined();
+      if (packageJson) {
+        expect(packageJson.name).toEqual('example-package');
+        expect(packageJson.version).not.toBeDefined();
+
+        // The "nonstandardField" should have been trimmed because loadExtraFields=false
+        expect(packageJson).not.toHaveProperty('nonstandardField');
+      }
+    });
+
     test('tryGetPackageFolderFor() test', () => {
       const packageJsonLookup: PackageJsonLookup = new PackageJsonLookup();
       const sourceFilePath: string = path.join(__dirname, './test-data/example-package/src/ExampleFile.txt');
diff --git a/libraries/node-core-library/src/test/test-data/example-package-no-version/package.json b/libraries/node-core-library/src/test/test-data/example-package-no-version/package.json
@@ -0,0 +1,4 @@
+{
+  "name": "example-package",
+  "nonstandardField": 123
+}
diff --git a/libraries/node-core-library/src/test/test-data/example-package-no-version/src/ExampleFile.txt b/libraries/node-core-library/src/test/test-data/example-package-no-version/src/ExampleFile.txt
@@ -0,0 +1,29 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/**
+ * AEDoc for AliasClass
+ * @public
+ */
+export class AliasClass {
+  private readOnlyNumber: number;
+
+  /**
+   * AEDoc for aliasFunc()
+   * @internal
+   */
+  public _aliasFunc(): void {
+    console.log('this is an internal API');
+  }
+
+  public aliasField: number;
+
+  public get shouldBeReadOnly(): number {
+    return this.readOnlyNumber;
+  }
+}
+
+class PrivateAliasClass {
+  public test(): void {
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ export class Extractor {`
`98`	`98`	`/**`
`99`	`99`	`* Returns the version number of the API Extractor NPM package.`
`100`	`100`	`*/`
`101`		`- public static get version(): string {`
	`101`	`+ public static get version(): string \| undefined {`
`102`	`102`	`return Extractor._getPackageJson().version;`
`103`	`103`	`}`
`104`	`104`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "name": "example-package",
 +  "nonstandardField": 123
 +}