cargdev/angular
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

build(docs-infra): fix autoLinkCode to ignore docs without a path (#36316)

Browse Source 
Previously, the auto linker generated links without an `href` when the
API was private. This commit fixes this by making sure that the `path`
of the document is not empty.

Closes #36260

PR Close #36316
This commit is contained in:
Sonu Kapoor
2020-03-30 07:10:15 -04:00
committed by Matias Niemelä
parent 4da901f8c0
commit 4fb034aeec
2 changed files with 37 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
aio/tools/transforms/angular-base-package/post-processors/auto-link-code.spec.js
View File

@ -126,6 +126,15 @@ describe('autoLinkCode post-processor', () => {
expect(doc.renderedContent).toEqual('<code>MyClass</code>');
});
it('should ignore code items that match an API doc but have no path set',
() => {
aliasMap.addDoc(
{docType: 'class', id: 'MyClass', aliases: ['MyClass'], path: ''});
const doc = {docType: 'test-doc', renderedContent: '<code>MyClass</code>'};
processor.$process([doc]);
expect(doc.renderedContent).toEqual('<code>MyClass</code>');
});
it('should insert anchors for individual text nodes within a code block', () => {
aliasMap.addDoc({docType: 'class', id: 'MyClass', aliases: ['MyClass'], path: 'a/b/myclass'});
const doc = {