Skip to content

feat: add language-support feature #846

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

Closed
wants to merge 3 commits into from
Closed

feat: add language-support feature #846

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c1dcf17
feat: add language-support feature
rofe Mar 18, 2025
d8bc8e4
chore: pr feedback and refactoring
rofe Mar 18, 2025
9fc4c65
chore: use canoncial path
rofe Mar 19, 2025
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
59 changes: 59 additions & 0 deletions src/steps/render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,39 @@ function sanitizeJsonLd(jsonLd) {
return JSON.stringify(JSON.parse(sanitizedJsonLd.trim()), null, 2);
}

function getCurrentLang(canonical, langs) {
const { pathname } = canonical;
// find the longest matching prefix
const { lang: currentLang, prefix: currentPrefix } = langs.reduce((acc, lang) => {
const { prefix } = lang;
if ((pathname === prefix || pathname.startsWith(`${prefix}/`)) // path matches prefix
&& (!acc || prefix.length > acc.prefix.length)) { // prefix is longer than previous
return lang;
}
return acc;
});
return {
currentLang,
currentPrefix,
};
}

function getLangHref(canonical, currentPrefix, prefix) {
if (currentPrefix === prefix) {
// current prefix is identical to prefix -> canonical
return canonical.href;
} else {
const { pathname } = canonical;
if (!currentPrefix) {
// current prefix empty -> prepend prefix
return new URL(`${prefix}${pathname}`, canonical).href;
} else {
// replace current prefix with prefix
return new URL(pathname.replace(currentPrefix, prefix), canonical).href;
}
}
}

/**
* @type PipelineStep
* @param {PipelineState} state
Expand Down Expand Up @@ -116,6 +149,32 @@ export default async function render(state, req, res) {
$head.children.push(...$headHtml.children);
}

// language support
const { langs, defaultLang } = state.config?.features?.['language-support'] || {};
if (Array.isArray(langs)) {
const canonicalUrl = new URL(meta.canonical);
const { currentLang, currentPrefix } = getCurrentLang(canonicalUrl, langs);
if (currentLang) {
// set html lang if not already set via metadata
if (!htmlLang) {
htmlLang = currentLang;
}
// inject hreflang links
langs.forEach(({ lang, prefix }) => {
const href = getLangHref(canonicalUrl, currentPrefix, prefix);
$head.children.push(createElement('link', 'rel', 'alternate', 'hreflang', lang, 'href', href));
});
// write x-default hreflang link if default lang exists
if (defaultLang) {
const { lang, prefix } = langs.find((l) => l.lang === defaultLang);
if (lang) {
const href = getLangHref(canonicalUrl, currentPrefix, prefix);
$head.children.push(createElement('link', 'rel', 'alternate', 'hreflang', 'x-default', 'href', href));
}
}
}
}

res.document = {
type: 'root',
children: [
Expand Down
32 changes: 32 additions & 0 deletions test/fixtures/content/en/uk/page-metadata-language-support.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<html lang="en-GB">
<head>
<title>Home | Helix Project Boilerplate</title>
<link rel="canonical" href="https://helix-pages.com/en/uk/page-metadata-language-support">
<meta property="og:title" content="Home | Helix Project Boilerplate">
<meta property="og:url" content="https://helix-pages.com/en/uk/page-metadata-language-support">
<meta property="og:image" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
<meta property="og:image:secure_url" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="Home | Helix Project Boilerplate">
<meta name="twitter:image" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
<link id="favicon" rel="icon" type="image/svg+xml" href="/icons/spark.svg">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="/scripts.js" type="module"></script>
<link rel="stylesheet" href="/styles.css">
<link rel="alternate" hreflang="en-US" href="https://helix-pages.com/page-metadata-language-support">
<link rel="alternate" hreflang="en-GB" href="https://helix-pages.com/en/uk/page-metadata-language-support">
<link rel="alternate" hreflang="fr" href="https://helix-pages.com/fr/page-metadata-language-support">
<link rel="alternate" hreflang="de-DE" href="https://helix-pages.com/de/page-metadata-language-support">
<link rel="alternate" hreflang="x-default" href="https://helix-pages.com/page-metadata-language-support">
</head>
<body>
<header></header>
<main>
<div>
<h1 id="html-lang-test">HTML lang test</h1>
<p>This is great.</p>
</div>
</main>
<footer></footer>
</body>
</html>
9 changes: 9 additions & 0 deletions test/fixtures/content/en/uk/page-metadata-language-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# HTML lang test

This is great.

+-------------------------------------------------------------------------------------------+
| Metadata |
+================+==========================================================================+
| title | Home \| Helix Project Boilerplate |
+----------------+--------------------------------------------------------------------------+
32 changes: 32 additions & 0 deletions test/fixtures/content/page-metadata-language-support.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<html lang="en-US">
<head>
<title>Home | Helix Project Boilerplate</title>
<link rel="canonical" href="https://helix-pages.com/page-metadata-language-support">
<meta property="og:title" content="Home | Helix Project Boilerplate">
<meta property="og:url" content="https://helix-pages.com/page-metadata-language-support">
<meta property="og:image" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
<meta property="og:image:secure_url" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="Home | Helix Project Boilerplate">
<meta name="twitter:image" content="https://helix-pages.com/default-meta-image.png?width=1200&#x26;format=pjpg&#x26;optimize=medium">
<link id="favicon" rel="icon" type="image/svg+xml" href="/icons/spark.svg">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script src="/scripts.js" type="module"></script>
<link rel="stylesheet" href="/styles.css">
<link rel="alternate" hreflang="en-US" href="https://helix-pages.com/page-metadata-language-support">
<link rel="alternate" hreflang="en-GB" href="https://helix-pages.com/en/uk/page-metadata-language-support">
<link rel="alternate" hreflang="fr" href="https://helix-pages.com/fr/page-metadata-language-support">
<link rel="alternate" hreflang="de-DE" href="https://helix-pages.com/de/page-metadata-language-support">
<link rel="alternate" hreflang="x-default" href="https://helix-pages.com/page-metadata-language-support">
</head>
<body>
<header></header>
<main>
<div>
<h1 id="html-lang-test">HTML lang test</h1>
<p>This is great.</p>
</div>
</main>
<footer></footer>
</body>
</html>
9 changes: 9 additions & 0 deletions test/fixtures/content/page-metadata-language-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# HTML lang test

This is great.

+-------------------------------------------------------------------------------------------+
| Metadata |
+================+==========================================================================+
| title | Home \| Helix Project Boilerplate |
+----------------+--------------------------------------------------------------------------+
37 changes: 37 additions & 0 deletions test/rendering.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,33 @@ const DEFAULT_CONFIG_EMPTY = {
},
};

const CONFIG_LANGUAGE_SUPPORT = {
...DEFAULT_CONFIG_EMPTY,
features: {
'language-support': {
defaultLang: 'en-US',
langs: [
{
lang: 'en-US',
prefix: '',
},
{
lang: 'en-GB',
prefix: '/en/uk',
},
{
lang: 'fr',
prefix: '/fr',
},
{
lang: 'de-DE',
prefix: '/de',
},
],
},
},
};

describe('Rendering', () => {
let loader;
let config;
Expand Down Expand Up @@ -535,6 +562,16 @@ describe('Rendering', () => {
config = DEFAULT_CONFIG_EMPTY;
await testRender('page-metadata-htmllang-invalid', ':scope');
});

it('detects current lang and injects html lang and hreflang links based on feature config', async () => {
config = CONFIG_LANGUAGE_SUPPORT;
await testRender('en/uk/page-metadata-language-support', ':scope');
});

it('detects current lang with empty prefix', async () => {
config = CONFIG_LANGUAGE_SUPPORT;
await testRender('page-metadata-language-support', ':scope');
});
});

describe('Miscellaneous', () => {
Expand Down