Skip to content

chore(formatting): html anchor tags -> markdown syntax #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jaredcbaum wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

chore(formatting): html anchor tags -> markdown syntax #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72b281c
chore(formatting): md links instead of html elements
jaredcbaum Dec 19, 2023
25e9428
test(formatting): markdown links
jaredcbaum Dec 19, 2023
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
6 changes: 3 additions & 3 deletions src/formatting.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,17 +95,17 @@ function linkToken(data: DocsData, token: string) {
);
});
if (i) {
return `<a href="#${i.slug}">${token}</a>`;
return `[${token}](#${i.slug})`;
}

const ta = data.typeAliases.find((ta) => ta.name === t);
if (ta) {
return `<a href="#${ta.slug}">${token}</a>`;
return `[${token}](#${ta.slug})`;
}

const e = data.enums.find((e) => e.name === t || e.members.some((m) => e.name + '.' + m.name === t));
if (e) {
return `<a href="#${e.slug}">${token}</a>`;
return `[${token}](#${e.slug})`;
}

return null;
Expand Down
10 changes: 5 additions & 5 deletions src/test/formatting.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,34 +41,34 @@ describe('formatting', () => {

it('formatDescription w/ backticks', () => {
const r = formatDescription(d, 'Hey `SomeInterface`!');
expect(r).toEqual('Hey <a href="#someinterface">`SomeInterface`</a>!');
expect(r).toEqual('Hey [`SomeInterface`](#someinterface)!');
});

it('formatDescription', () => {
const r = formatDescription(d, `Hey SomeInterface and SomeInterface.prop and SomeEnum and SomeEnum.Value!`);
expect(r).toEqual(
`Hey <a href=\"#someinterface\">SomeInterface</a> and <a href=\"#someinterface\">SomeInterface.prop</a> and <a href=\"#someenum\">SomeEnum</a> and <a href=\"#someenum\">SomeEnum.Value</a>!`
`Hey [SomeInterface](#someinterface) and [SomeInterface.prop](#someinterface) and [SomeEnum](#someenum) and [SomeEnum.Value](#someenum)!`
);
});

it('formatType interface promise w/ union', () => {
const r = formatType(d, `Promise<SomeInterface | SomeEnum | Promise<void>>`);
expect(r.type).toEqual(`Promise<SomeInterface | SomeEnum | Promise<void>>`);
expect(r.formatted).toEqual(
`<code>Promise&lt;<a href="#someinterface">SomeInterface</a> | <a href=\"#someenum\">SomeEnum</a> | Promise&lt;void&gt;&gt;</code>`
`<code>Promise&lt;[SomeInterface](#someinterface) | [SomeEnum](#someenum) | Promise&lt;void&gt;&gt;</code>`
);
});

it('formatType interface promise', () => {
const r = formatType(d, `Promise<SomeInterface>`);
expect(r.type).toEqual(`Promise<SomeInterface>`);
expect(r.formatted).toEqual(`<code>Promise&lt;<a href="#someinterface">SomeInterface</a>&gt;</code>`);
expect(r.formatted).toEqual(`<code>Promise&lt;[SomeInterface](#someinterface)&gt;</code>`);
});

it('formatType interface', () => {
const r = formatType(d, `SomeInterface`);
expect(r.type).toEqual(`SomeInterface`);
expect(r.formatted).toEqual(`<code><a href="#someinterface">SomeInterface</a></code>`);
expect(r.formatted).toEqual(`<code>[SomeInterface](#someinterface)</code>`);
});

it('formatType remove undefined', () => {
Expand Down