Skip to content
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

Jump to bottom

enhance(macros/APIRef): show badges on all links #9757

Merged
merged 6 commits into from
May 2, 2024
Merged

enhance(macros/APIRef): show badges on all links #9757

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8c0c7b4
feat(macros/APIRef): show badges on all links
caugner Oct 2, 2023
9d29d47
test(macros/APIRef): mock wiki.getPage()
caugner Feb 29, 2024
55971dd
fix(macros/APIRef): fall back to en-US to determine badges
caugner Feb 29, 2024
647e062
Merge branch 'main' into APIRef-show-badges-on-all-links
caugner Mar 1, 2024
e1ff045
Merge branch 'main' into APIRef-show-badges-on-all-links
caugner Mar 28, 2024
7119ad9
Merge branch 'main' into APIRef-show-badges-on-all-links
caugner May 2, 2024
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
30 changes: 20 additions & 10 deletions kumascript/macros/APIRef.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,17 @@ function getPageTitle(page) {
return title;
}

async function smartLinkWithBadges(url, content) {
let aPage = await wiki.getPage(url);
if (!aPage.title && env.locale !== 'en-US') {
const originalUrl = url.replace(`/${env.locale}/`, "/en-US/");
aPage = await wiki.getPage(originalUrl);
}
const link = web.smartLink(url, null, content, APIHref, null, "APIRef");
const badges = (await page.badges(aPage)).join("");
return link + badges;
}

async function buildSublist(pages, title) {
var result = '<li class="toggle"><details open><summary>' + title + '</summary><ol>';

Expand All @@ -185,8 +196,7 @@ async function buildSublist(pages, title) {
if (slug == aPage.slug) {
result += `<em><code>${title}</code> ${pageBadges}</em>`
} else {
result += web.smartLink(url, null, `<code>${title}</code>`, APIHref, null, "APIRef");
result += pageBadges;
result += await smartLinkWithBadges(url, `<code>${title}</code>`);
}

if (rtlLocales.indexOf(locale) != -1) {
Expand All @@ -201,13 +211,13 @@ async function buildSublist(pages, title) {
return result;
}

function buildIFList(interfaces, title) {
var result = '<li class="toggle"><details open><summary>' + title + '</summary><ol>';
async function buildIFList(interfaces, title) {
let result = '<li class="toggle"><details open><summary>' + title + '</summary><ol>';

for (var i = 0; i < interfaces.length; i++) {
var url = APIHref + '/' + interfaces[i].replace('()', '').replace('.', '/');
if (!url.endsWith(slug)) {
result += `<li>${web.smartLink(url, null, `<code>${interfaces[i]}</code>`, APIHref, null, "APIRef")}</li>`;
result += `<li>${await smartLinkWithBadges(url, `<code>${interfaces[i]}</code>`)}</li>`;
}
}

Expand All @@ -219,10 +229,10 @@ function buildIFList(interfaces, title) {
// output
output = '<section id="Quick_links" data-macro="APIRef"><ol>';
if (group && webAPIGroups[0][group] && webAPIGroups[0][group].overview) {
output += `<li class="section">${web.smartLink(APIHref + '/' + webAPIGroups[0][group].overview[0].replace(/ /g, '_'), null, webAPIGroups[0][group].overview[0], APIHref, null, "APIRef")}</li>`;
output += `<li class="section">${await smartLinkWithBadges(APIHref + '/' + webAPIGroups[0][group].overview[0].replace(/ /g, '_'), webAPIGroups[0][group].overview[0])}</li>`;
}

output += `<li class="section">${web.smartLink(APIHref + '/' + mainIF, null, `<code>${mainIF}</code>`, APIHref, null, "APIRef")}</li>`;
output += `<li class="section">${await smartLinkWithBadges(APIHref + '/' + mainIF, `<code>${mainIF}</code>`)}</li>`;

if (ctors.length > 0) {
output += await buildSublist(ctors, text['Constructor']);
Expand All @@ -243,14 +253,14 @@ if (events.length > 0) {
output += await buildSublist(events, text['Events']);
}
if (inh.length > 0) {
output += buildIFList(inheritedIF, text['Inheritance']);
output += await buildIFList(inheritedIF, text['Inheritance']);
}
if (implementedBy.length > 0) {
output += buildIFList(implementedBy, text['Implemented_by']);
output += await buildIFList(implementedBy, text['Implemented_by']);
}

if (related.length > 0) {
output += buildIFList(related, text['Related']);
output += await buildIFList(related, text['Related']);
}

output += '</ol></section>';
Expand Down
3 changes: 3 additions & 0 deletions kumascript/tests/macros/apiref.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -685,6 +685,9 @@ describeMacro("APIRef", function () {
expect(page).toEqual("/en-US/docs/Web/API/TestInterface");
return subpagesFixture;
});
macro.ctx.wiki.getPage = jest.fn((url) => {
return subpagesFixture.find((doc) => doc.url === url) ?? {};
});
});

// Test with current page as main interface page
Expand Down
Loading