Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/acronym-class-type-links.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@doc-kit/core': patch
---

fix(metadata): link class types whose name starts with an acronym
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,16 @@ describe('resolveTypeReference', () => {
strictEqual(resolveTypeReference('vm.Module'), 'vm.html#class-vmmodule');
});

it('uses the class prefix for names starting with an acronym', () => {
strictEqual(
resolveTypeReference('tls.TLSSocket'),
'tls.html#class-tlstlssocket'
);
});

it('does not use the class prefix for non-class members', () => {
strictEqual(resolveTypeReference('vm.constants'), 'vm.html#vmconstants');
strictEqual(resolveTypeReference('os.EOL'), 'os.html#oseol');
});

it('prefers the map over the dotted heuristic', () => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ export const resolveTypeReference = (name, typeMap) => {
// Transform Node.js types like 'vm.Something'.
if (MODULE_QUALIFIED_NAME.test(name)) {
const [mod, ...pieces] = name.split('.');
const isClass = pieces.at(-1).match(/^[A-Z][a-z]/);
const isClass = pieces.at(-1).match(/^[A-Z](?=.*[a-z])/);

return `${mod}.html#${isClass ? 'class-' : ''}${slug(name)}`;
}
Expand Down
Loading