Skip to content

feat(metadata): hreflang links #847

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

Merged
merged 4 commits into from
Mar 20, 2025
Merged

feat(metadata): hreflang links #847

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a37c7c0
feat(metadata): hreflang links
rofe Mar 20, 2025
66c356e
chore: uppercase country code
rofe Mar 20, 2025
eaf9139
chore: use all lowercase for locale
rofe Mar 20, 2025
ff2a75c
chore: optimize regex
rofe Mar 20, 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
23 changes: 21 additions & 2 deletions src/steps/render.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ import rehypeParse from 'rehype-parse';
import { cleanupHeaderValue } from '@adobe/helix-shared-utils';
import { contentSecurityPolicyOnAST } from './csp.js';

const LANG_REGEX = /^[a-z]{2}([-_]{1}[a-z]{2})?$/i;

function formatLang(lang) {
return lang
.replace('_', '-')
.toLowerCase();
}

function appendElement($parent, $el) {
if ($el) {
$parent.children.push($el);
Expand Down Expand Up @@ -76,8 +84,19 @@ export default async function render(state, req, res) {
continue;
}
if (name.toLowerCase() === 'html-lang') {
if (/^[a-z]{2}([-_]{1}[a-z]{2})?$/i.test(value)) {
htmlLang = value;
if (LANG_REGEX.test(value)) {
htmlLang = formatLang(value);
}
// eslint-disable-next-line no-continue
continue;
}
if (name.toLowerCase().startsWith('hreflang-')) {
const lang = name.substring(9);
if (LANG_REGEX.test(lang)) {
appendElement(
$head,
createElement('link', 'rel', 'alternate', 'hreflang', formatLang(lang), 'href', value),
);
}
// eslint-disable-next-line no-continue
continue;
Expand Down
27 changes: 27 additions & 0 deletions test/fixtures/content/page-metadata-hreflang-invalid.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<html>
<head>
<title>Home | Helix Project Boilerplate</title>
<link rel="canonical" href="https://helix-pages.com/page-metadata-hreflang-invalid">
<meta property="og:title" content="Home | Helix Project Boilerplate">
<meta property="og:url" content="https://helix-pages.com/page-metadata-hreflang-invalid">
<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">
</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>
11 changes: 11 additions & 0 deletions test/fixtures/content/page-metadata-hreflang-invalid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# HTML lang test

This is great.

+-------------------------------------------------------------------------------------------+
| Metadata |
+================+==========================================================================+
| title | Home \| Helix Project Boilerplate |
+----------------+--------------------------------------------------------------------------|
| hreflang-x | https://helix-pages.com/x/page-metadata-hreflang |
+----------------+--------------------------------------------------------------------------+
29 changes: 29 additions & 0 deletions test/fixtures/content/page-metadata-hreflang.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<html>
<head>
<title>Home | Helix Project Boilerplate</title>
<link rel="canonical" href="https://helix-pages.com/page-metadata-hreflang">
<meta property="og:title" content="Home | Helix Project Boilerplate">
<meta property="og:url" content="https://helix-pages.com/page-metadata-hreflang">
<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 rel="alternate" hreflang="de" href="https://helix-pages.com/de/page-metadata-hreflang">
<link rel="alternate" hreflang="fr-fr" href="https://helix-pages.com/fr/page-metadata-hreflang">
<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">
</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>
13 changes: 13 additions & 0 deletions test/fixtures/content/page-metadata-hreflang.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# HTML lang test

This is great.

+-------------------------------------------------------------------------------------------+
| Metadata |
+================+==========================================================================+
| title | Home \| Helix Project Boilerplate |
+----------------+--------------------------------------------------------------------------|
| hreflang-de | <https://helix-pages.com/de/page-metadata-hreflang> |
+----------------+--------------------------------------------------------------------------+
| hreflang-fr-FR | <https://helix-pages.com/fr/page-metadata-hreflang> |
+----------------+--------------------------------------------------------------------------+
2 changes: 1 addition & 1 deletion test/fixtures/content/page-metadata-htmllang.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<html lang="en-US">
<html lang="en-us">
<head>
<title>Home | Helix Project Boilerplate</title>
<link rel="canonical" href="https://helix-pages.com/page-metadata-htmllang">
Expand Down
10 changes: 10 additions & 0 deletions test/rendering.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -535,6 +535,16 @@ describe('Rendering', () => {
config = DEFAULT_CONFIG_EMPTY;
await testRender('page-metadata-htmllang-invalid', ':scope');
});

it('injects hreflang link', async () => {
config = DEFAULT_CONFIG_EMPTY;
await testRender('page-metadata-hreflang', ':scope');
});

it('rejects invalid hreflang', async () => {
config = DEFAULT_CONFIG_EMPTY;
await testRender('page-metadata-hreflang-invalid', ':scope');
});
});

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