diff --git a/.gitignore b/.gitignore index 1516e93..b0a48ff 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ public resources/_gen +.DS_Store \ No newline at end of file diff --git a/README.md b/README.md index 426651d..4c6a557 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,19 @@ panel above it. The language link spans the panel's content width, includes the translation icon, and uses the same font size as the menu links. The page reserves space for the button so it does not cover content. +## Brand spelling check + +Hugo builds check content source lines for the name `Hackertours` in any other +casing and report the file and line as build errors for pages included in the +build. URLs, email addresses, social handles, Matrix room addresses and +Markdown link destinations are excluded. Commented-out content is checked too, +so it is ready to publish. + +For an intentional exception, add `` at the +end of a Markdown line, or `# hackertours-lint-ignore` at the end of a YAML +front matter line. This ignores that entire source line, so keep unrelated +occurrences on other lines. + ## Shortcode: Language badge Use the `lang` shortcode to mark whether a tour is in German, English or bilingual. It renders a small superscript badge next to the text, with details when hovered over or parsed by a screenreader. diff --git a/assets/css/_custom.css b/assets/css/_custom.css index 5dcf79f..f58cbc2 100644 --- a/assets/css/_custom.css +++ b/assets/css/_custom.css @@ -1,6 +1,10 @@ @import './_schedule.css'; @import './_gallery.css'; +.intro-text { + white-space: pre-line; +} + .header__logo { flex-shrink: 0; } @@ -229,4 +233,3 @@ span.content-image { font-size: var(--fs-xs); color: var(--color-text-meta); } - diff --git a/content/de/_index.md b/content/de/_index.md index 08cf4ee..623bfd4 100644 --- a/content/de/_index.md +++ b/content/de/_index.md @@ -19,9 +19,9 @@ Wir bereiten Touren für den [40C3](https://events.ccc.de/category/40c3/) vor. I )\s*$` $line) -}} + {{- $text := replaceRE `\]\([^)]*\)` "]" $line -}} + {{- $text = replaceRE `(?i)(?:https?://|mailto:|www\.)[^\s<>"']+|[[:alnum:]._%+-]+@[[:alnum:]._-]+|@[[:alnum:]_]+|#[[:alnum:]_-]+:[[:alnum:]._-]+` "" $text -}} + {{- range findRE `(?i)\bhackertours\b` $text -}} + {{- if ne . "Hackertours" -}} + {{- errorf "%s:%d: %q should be \"Hackertours\" (different casing) - to ignore this, add a hackertours-lint-ignore comment on this line" $file.Filename (add $index 1) . -}} + {{- end -}} + {{- end -}} + {{- end -}} + {{- end -}} +{{- end -}} diff --git a/layouts/baseof.html b/layouts/baseof.html index 116d459..c735616 100644 --- a/layouts/baseof.html +++ b/layouts/baseof.html @@ -1,3 +1,4 @@ +{{ partial "lint-brand.html" . }} diff --git a/layouts/home-baseof.html b/layouts/home-baseof.html index 116d459..c735616 100644 --- a/layouts/home-baseof.html +++ b/layouts/home-baseof.html @@ -1,3 +1,4 @@ +{{ partial "lint-brand.html" . }} diff --git a/tests/test_brand_lint.py b/tests/test_brand_lint.py new file mode 100644 index 0000000..bbb3a54 --- /dev/null +++ b/tests/test_brand_lint.py @@ -0,0 +1,64 @@ +import shutil +import subprocess +import tempfile +import unittest +from pathlib import Path + + +ROOT = Path(__file__).resolve().parents[1] + + +class BrandLintTest(unittest.TestCase): + def build(self, source): + with tempfile.TemporaryDirectory() as directory: + root = Path(directory) + (root / "content").mkdir() + (root / "layouts" / "_partials").mkdir(parents=True) + (root / "hugo.toml").write_text('baseURL = "https://example.org/"\n') + (root / "content" / "_index.md").write_text(source) + (root / "layouts" / "home.html").write_text( + '{{ partial "lint-brand.html" . }}{{ .Content }}' + ) + shutil.copy( + ROOT / "layouts" / "_partials" / "lint-brand.html", + root / "layouts" / "_partials" / "lint-brand.html", + ) + return subprocess.run( + ["hugo", "--source", str(root)], + capture_output=True, + text=True, + check=False, + ) + + def test_errors_include_spelling_and_source_line(self): + result = self.build("---\ntitle: Hackertours\n---\nHACKERTOURS and hackertours\n") + self.assertNotEqual(result.returncode, 0) + for line, spelling in [(2, "Hackertours"), (4, "HACKERTOURS"), (4, "hackertours")]: + self.assertIn(f':{line}: "{spelling}" should be "Hackertours"', result.stderr) + + def test_valid_names_identifiers_and_explicit_exceptions(self): + result = self.build( + "---\n" + "title: Hackertours # hackertours-lint-ignore\n" + "---\n" + "Hackertours\n" + "Hackertours \n" + "[Shop](https://hackertours.example/hackertours) " + "ticket@hackertours.example @hackertours " + "#easterhegg-hackertours:example.org\n" + ) + self.assertEqual(result.returncode, 0, result.stderr) + + def test_marker_only_ignores_its_own_line(self): + result = self.build( + "---\ntitle: Hackertours\n---\n" + "Hackertours \n" + "Hackertours\n" + ) + self.assertNotEqual(result.returncode, 0) + self.assertIn(':5: "Hackertours" should be "Hackertours"', result.stderr) + self.assertNotIn(':4: "Hackertours" should be "Hackertours"', result.stderr) + + +if __name__ == "__main__": + unittest.main()