Skip to content

Commit

Permalink
fix(core): fix symbol url anchors when "flattenOutputFiles" is "true" (…
Browse files Browse the repository at this point in the history 
…#616)
  • Loading branch information
@tgreyuk
tgreyuk committed May 15, 2024
1 parent 62062af commit cc967ca
Show file tree
Hide file tree
Showing 3 changed files with 77 additions and 80 deletions.
86 changes: 41 additions & 45 deletions packages/typedoc-plugin-markdown/src/theme/core/url-builder.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ export function buildUrls(theme: MarkdownTheme, project: ProjectReflection) {
buildUrlsFromProject(project);
}

return flattenOutputFiles ? flattenFiles(urls) : urls;
return urls;

function buildEntryUrls() {
const preserveReadme =
Expand Down Expand Up @@ -235,28 +235,35 @@ export function buildUrls(theme: MarkdownTheme, project: ProjectReflection) {
);

if (mapping) {
const directory = urlOptions.directory || mapping.directory;
const urlPath = getUrlPath(reflection, {
...urlOptions,
directory,
});
let url: string;
let urlPath = '';

if (flattenOutputFiles) {
url = getFlattenedUrl(reflection);
} else {
const directory = urlOptions.directory || mapping.directory;
urlPath = getUrlPath(reflection, {
...urlOptions,
directory,
});

let url = getUrl(reflection, urlPath, urlOptions);
url = getUrl(reflection, urlPath, urlOptions);

if (ignoreScopes) {
url = removeFirstScopedDirectory(url);
}
if (ignoreScopes) {
url = removeFirstScopedDirectory(url);
}

const duplicateUrls = urls.filter(
(urlMapping) =>
urlMapping.url.toLowerCase().replace(/-\d+$/, '') ===
url.toLowerCase(),
);
const duplicateUrls = urls.filter(
(urlMapping) =>
urlMapping.url.toLowerCase().replace(/-\d+$/, '') ===
url.toLowerCase(),
);

if (duplicateUrls.length > 0) {
const urlParts = url.split('.');
urlParts[urlParts.length - 2] += `-${duplicateUrls.length}`;
url = urlParts.join('.');
if (duplicateUrls.length > 0) {
const urlParts = url.split('.');
urlParts[urlParts.length - 2] += `-${duplicateUrls.length}`;
url = urlParts.join('.');
}
}

urls.push({
Expand Down Expand Up @@ -475,31 +482,20 @@ export function buildUrls(theme: MarkdownTheme, project: ProjectReflection) {
: getFileNameWithExtension('globals', fileExtension);
}

function flattenFiles(urls: UrlMapping<Reflection>[]) {
const getUrl = (reflection: Reflection) => {
const fullName = reflection.getFullName();
const fullNameParts = fullName.replace(/\//g, '.').split('.');
if (reflection.kind !== ReflectionKind.Module) {
fullNameParts.splice(
fullNameParts.length - 1,
0,
ReflectionKind.singularString(reflection.kind).split(' ')[0],
);
}
const url = `${fullNameParts.join('.')}${fileExtension}`
.replace(/"/g, '')
.replace(/^\./g, '');
reflection.url = url;
return url;
};
return urls.map((urlMapping) => {
if (urlMapping.model.kind === ReflectionKind.Project) {
return urlMapping;
}
return {
...urlMapping,
url: getUrl(urlMapping.model),
};
});
function getFlattenedUrl(reflection: DeclarationReflection) {
const fullName = reflection.getFullName();
const fullNameParts = fullName.replace(/\//g, '.').split('.');
if (reflection.kind !== ReflectionKind.Module) {
fullNameParts.splice(
fullNameParts.length - 1,
0,
ReflectionKind.singularString(reflection.kind).split(' ')[0],
);
}
const url = `${fullNameParts.join('.')}${fileExtension}`
.replace(/"/g, '')
.replace(/^\./g, '');
reflection.url = url;
return url;
}
}
5 changes: 3 additions & 2 deletions packages/typedoc-plugin-markdown/test/fixtures/config.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,10 @@ const config: Record<string, Fixture> = {
{
useHTMLAnchors: true,
preserveAnchorCasing: true,
publicPath: '/some-path',
fileExtension: 'mdx',
publicPath: 'http://example.com',
fileExtension: '.mdx',
sanitizeComments: true,
flattenOutputFiles: true,
},
],
},
Expand Down
66 changes: 33 additions & 33 deletions packages/typedoc-plugin-markdown/test/specs/__snapshots__/comments.spec.ts.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ Comments form module comments
Links using \`{@link}\` inline tags.
- [CommentInterface](/some-path/interfaces/CommentInterface.mdx) - Links to CommentInterface
- [Links to CommentInterface.prop](/some-path/interfaces/CommentInterface.mdx#prop)
- [Links to CommentInterface.propb](/some-path/interfaces/CommentInterface.mdx#propb)
- [CommentEnum.MemberB](/some-path/enumerations/CommentEnum.mdx#MemberB)
- [SameName:var](/some-path/variables/SameName.mdx)
- [SameName:interface](/some-path/interfaces/SameName.mdx)
- [SameName.prop](/some-path/interfaces/SameName.mdx#prop)
- [prop:var](/some-path/variables/prop.mdx)
- [_prop_with_underscore:var](/some-path/variables/prop_with_underscore.mdx)
- [CommentInterface](http:/example.com/Interface.CommentInterface.mdx) - Links to CommentInterface
- [Links to CommentInterface.prop](http:/example.com/Interface.CommentInterface.mdx#prop)
- [Links to CommentInterface.propb](http:/example.com/Interface.CommentInterface.mdx#propb)
- [CommentEnum.MemberB](http:/example.com/Enumeration.CommentEnum.mdx#MemberB)
- [SameName:var](http:/example.com/Variable.SameName.mdx)
- [SameName:interface](http:/example.com/Interface.SameName.mdx)
- [SameName.prop](http:/example.com/Interface.SameName.mdx#prop)
- [prop:var](http:/example.com/Variable.prop.mdx)
- [_prop_with_underscore:var](http:/example.com/Variable._prop_with_underscore.mdx)
External links:
Expand Down Expand Up @@ -178,25 +178,25 @@ This is a simple example on how to use include.
## Enumerations
- [CommentEnum](/some-path/enumerations/CommentEnum.mdx)
- [CommentEnum](http:/example.com/Enumeration.CommentEnum.mdx)
## Interfaces
- [CommentInterface](/some-path/interfaces/CommentInterface.mdx)
- [CommentInterfaceExtended](/some-path/interfaces/CommentInterfaceExtended.mdx)
- [SameName](/some-path/interfaces/SameName.mdx)
- [CommentInterface](http:/example.com/Interface.CommentInterface.mdx)
- [CommentInterfaceExtended](http:/example.com/Interface.CommentInterfaceExtended.mdx)
- [SameName](http:/example.com/Interface.SameName.mdx)
## Variables
- [SameName](/some-path/variables/SameName.mdx)
- [\\_prop\\_with\\_underscore](/some-path/variables/prop_with_underscore.mdx)
- [prop](/some-path/variables/prop.mdx)
- [propb](/some-path/variables/propb.mdx)
- [SameName](http:/example.com/Variable.SameName.mdx)
- [\\_prop\\_with\\_underscore](http:/example.com/Variable._prop_with_underscore.mdx)
- [prop](http:/example.com/Variable.prop.mdx)
- [propb](http:/example.com/Variable.propb.mdx)
## Functions
- [multipleExampleTags](/some-path/functions/multipleExampleTags.mdx)
- [singleExampleTag](/some-path/functions/singleExampleTag.mdx)
- [multipleExampleTags](http:/example.com/Function.multipleExampleTags.mdx)
- [singleExampleTag](http:/example.com/Function.singleExampleTag.mdx)
"
`;
Expand Down Expand Up @@ -414,15 +414,15 @@ Comments form module comments
Links using \`{@link}\` inline tags.
- [CommentInterface](/some-path/README.mdx#CommentInterface) - Links to CommentInterface
- [Links to CommentInterface.prop](/some-path/README.mdx#prop)
- [Links to CommentInterface.propb](/some-path/README.mdx#propb)
- [CommentEnum.MemberB](/some-path/README.mdx#MemberB)
- [SameName:var](/some-path/README.mdx#SameName-1)
- [SameName:interface](/some-path/README.mdx#SameName)
- [SameName.prop](/some-path/README.mdx#prop-2)
- [prop:var](/some-path/README.mdx#prop-3)
- [_prop_with_underscore:var](/some-path/README.mdx#_prop_with_underscore)
- [CommentInterface](http:/example.com/README.mdx#CommentInterface) - Links to CommentInterface
- [Links to CommentInterface.prop](http:/example.com/README.mdx#prop)
- [Links to CommentInterface.propb](http:/example.com/README.mdx#propb)
- [CommentEnum.MemberB](http:/example.com/README.mdx#MemberB)
- [SameName:var](http:/example.com/README.mdx#SameName-1)
- [SameName:interface](http:/example.com/README.mdx#SameName)
- [SameName.prop](http:/example.com/README.mdx#prop-2)
- [prop:var](http:/example.com/README.mdx#prop-3)
- [_prop_with_underscore:var](http:/example.com/README.mdx#_prop_with_underscore)
External links:
Expand Down Expand Up @@ -491,7 +491,7 @@ This is a simple example on how to use include.
| Enumeration Member | Value | Description |
| :------ | :------ | :------ |
| <a id="Member" name="Member"></a> \`Member\` | \`0\` | <p>Comment for Member</p>Some \\<p\\> html \\</p\\> and \\<tag\\>\\</tag\\>.<p>**Deprecated**</p><p>Deprecated member</p><p>**See**</p><p>[SameName](/some-path/README.mdx#SameName-1)</p> |
| <a id="Member" name="Member"></a> \`Member\` | \`0\` | <p>Comment for Member</p>Some \\<p\\> html \\</p\\> and \\<tag\\>\\</tag\\>.<p>**Deprecated**</p><p>Deprecated member</p><p>**See**</p><p>[SameName](http:/example.com/README.mdx#SameName-1)</p> |
| <a id="MemberB" name="MemberB"></a> \`MemberB\` | \`1\` | - |
## Interfaces
Expand All @@ -502,7 +502,7 @@ This is a simple example on how to use include.
#### Extended by
- [\`CommentInterfaceExtended\`](/some-path/README.mdx#CommentInterfaceExtended)
- [\`CommentInterfaceExtended\`](http:/example.com/README.mdx#CommentInterfaceExtended)
#### Properties
Expand All @@ -519,14 +519,14 @@ This is a simple example on how to use include.
#### Extends
- [\`CommentInterface\`](/some-path/README.mdx#CommentInterface)
- [\`CommentInterface\`](http:/example.com/README.mdx#CommentInterface)
#### Properties
| Property | Type | Inherited from |
| :------ | :------ | :------ |
| <a id="prop-1" name="prop-1"></a> \`prop\` | \`string\` | [\`CommentInterface\`](/some-path/README.mdx#CommentInterface).[\`prop\`](/some-path/README.mdx#prop) |
| <a id="propb-1" name="propb-1"></a> \`propb\` | \`string\` | [\`CommentInterface\`](/some-path/README.mdx#CommentInterface).[\`propb\`](/some-path/README.mdx#propb) |
| <a id="prop-1" name="prop-1"></a> \`prop\` | \`string\` | [\`CommentInterface\`](http:/example.com/README.mdx#CommentInterface).[\`prop\`](http:/example.com/README.mdx#prop) |
| <a id="propb-1" name="propb-1"></a> \`propb\` | \`string\` | [\`CommentInterface\`](http:/example.com/README.mdx#CommentInterface).[\`propb\`](http:/example.com/README.mdx#propb) |
| <a id="propc" name="propc"></a> \`propc\` | \`string\` | - |
***
Expand Down

0 comments on commit cc967ca

Please sign in to comment.