PR feedback -- use "[test mode]" instead of an empty string

octogonz · octogonz · commit 81de96ae8d2a · 2019-01-30T16:06:59.000-08:00
diff --git a/apps/api-extractor/src/api/model/ApiPackage.ts b/apps/api-extractor/src/api/model/ApiPackage.ts
@@ -115,7 +115,9 @@ export class ApiPackage extends ApiItemContainerMixin(ApiNameMixin(ApiDocumented
     const jsonObject: IApiPackageJson = {
       metadata: {
         toolPackage: Extractor.packageName,
-        toolVersion: options.testMode ? '' : Extractor.version,
+        // In test mode, we don't write the real version, since that would cause spurious diffs whenever
+        // the verison is bumped.  Instead we write a placeholder string.
+        toolVersion: options.testMode ? '[test mode]' : Extractor.version,
         schemaVersion: ApiJsonSchemaVersion.V_1000
       }
     } as IApiPackageJson;
diff --git a/build-tests/api-documenter-test/etc/api-documenter-test.api.json b/build-tests/api-documenter-test/etc/api-documenter-test.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/apiItemKinds/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport1/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport1/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/circularImport2/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint1/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint1/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint2/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint3/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/defaultExportOfEntryPoint4/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate1/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportDuplicate1/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportEquals/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportImportedExternal/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar1/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar1/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar2/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",
diff --git a/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/test-outputs/exportStar3/api-extractor-scenarios.api.json
@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "",
+    "toolVersion": "[test mode]",
     "schemaVersion": 1000
   },
   "kind": "Package",

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"metadata": {`
`3`	`3`	`"toolPackage": "@microsoft/api-extractor",`
`4`		`- "toolVersion": "",`
	`4`	`+ "toolVersion": "[test mode]",`
`5`	`5`	`"schemaVersion": 1000`
`6`	`6`	`},`
`7`	`7`	`"kind": "Package",`