Skip to content

Commit 1927bae

Browse files
committed
Fix an issue where DocItem.getApiReference() produced an invalid IApiItemReference
1 parent 9bb10cf commit 1927bae

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

apps/api-documenter/src/utils/DocItemSet.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,8 @@ export class DocItem {
132132
for (const docItem of this.getHierarchy()) {
133133
switch (i) {
134134
case 0:
135-
reference.packageName = docItem.name;
135+
reference.scopeName = PackageName.getScope(docItem.name);
136+
reference.packageName = PackageName.getUnscopedName(docItem.name);
136137
break;
137138
case 1:
138139
reference.exportName = docItem.name;

apps/api-extractor/src/markup/Markup.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
22
// See LICENSE in the project root for license information.
33

4+
import { PackageName } from '@microsoft/node-core-library';
45
import {
56
MarkupElement,
67
MarkupBasicElement,
@@ -131,6 +132,9 @@ export class Markup {
131132
throw new Error('The IApiItemReference.packageName cannot be empty');
132133
}
133134

135+
// Validate that the scopeName and packageName are formatted correctly
136+
PackageName.combineParts(target.scopeName, target.packageName);
137+
134138
return {
135139
kind: 'api-link',
136140
elements: textElements,

0 commit comments

Comments
 (0)