Fix an issue with the 'fileUrlPath' on Windows.

iclanton · iclanton · commit 8cc7a044bf10 · 2022-10-16T20:03:33.000-07:00
diff --git a/apps/api-extractor/src/generators/ApiModelGenerator.ts b/apps/api-extractor/src/generators/ApiModelGenerator.ts
@@ -34,6 +34,7 @@ import {
   IApiTypeParameterOptions,
   EnumMemberOrder
 } from '@microsoft/api-extractor-model';
+import { Path } from '@rushstack/node-core-library';
 
 import { Collector } from '../collector/Collector';
 import { ISourceLocation } from '../collector/SourceMapper';
@@ -1138,6 +1139,11 @@ export class ApiModelGenerator {
       pos: declaration.pos
     });
 
-    return path.posix.relative(this._collector.extractorConfig.projectFolder, sourceLocation.sourceFilePath);
+    let result: string = path.relative(
+      this._collector.extractorConfig.projectFolder,
+      sourceLocation.sourceFilePath
+    );
+    result = Path.convertToSlashes(result);
+    return result;
   }
 }
diff --git a/build-tests/api-extractor-scenarios/etc/referenceTokens/api-extractor-scenarios.api.json b/build-tests/api-extractor-scenarios/etc/referenceTokens/api-extractor-scenarios.api.json
@@ -907,6 +907,7 @@
               "text": "unique symbol"
             }
           ],
+          "fileUrlPath": "src/referenceTokens/index.ts",
           "isReadonly": true,
           "releaseTag": "Public",
           "name": "SomeSymbol1",
@@ -929,6 +930,7 @@
               "text": "\"ThisIsSomeVar1\""
             }
           ],
+          "fileUrlPath": "src/referenceTokens/index.ts",
           "initializerTokenRange": {
             "startIndex": 1,
             "endIndex": 2
diff --git a/common/changes/@microsoft/api-extractor/fix-path-regression_2022-10-17-02-48.json b/common/changes/@microsoft/api-extractor/fix-path-regression_2022-10-17-02-48.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "comment": "Fix a regression where the \"fileUrlPath\" property would contain a malformed path when API Extractor is run on Windows.",
+      "type": "patch"
+    }
+  ],
+  "packageName": "@microsoft/api-extractor"
+}
