diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index f209304..ccb52cc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -40,5 +40,9 @@ jobs: - run: npm run smoke # The whole shop on a real Worker: settings, content published with the - # Mallok CLI, the seed, pages in two languages, the cart + # Mallok CLI, the seed, every kind of page in four languages, the cart - run: npm run smoke:shop + + # The one command a newcomer runs first still ends with a filled shop + # and an admin login that works + - run: npm run preview -- --check diff --git a/CLAUDE.md b/CLAUDE.md index f19beec..5a85d57 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -15,7 +15,8 @@ Nundar is in development. Several features wait for extension points Mallok does ```bash npm ci npm run build # mallok prepare (stages admin + theme assets) then a deploy dry run -npm run dev # wrangler dev with local D1 and R2; needs .dev.vars +npm run preview # a filled local shop on a throwaway database; prints an admin login +npm run dev # wrangler dev with local D1 and R2 that keep their data; starts empty, needs .dev.vars npm run lint # biome check . (npm run lint:fix to apply) npm run typecheck npm test # test:project, then test:shop @@ -39,8 +40,8 @@ CI (`.github/workflows/ci.yml`) runs `npm ci` → lint → typecheck → test - `src/worker/index.ts` is the whole site: `createMallok({ theme: nundarTheme, plugins: [inquiry, shop] })`. Theme and plugins are build-time choices. - `src/plugins/shop/` — commerce logic and nothing about pages. `plugin.json` is the manifest (validated strictly by `definePlugin`: unknown fields are rejected, every declared hook and route needs an implementation and vice versa). `migrations/` holds SQL, `lib/` the logic, `routes/` the HTTP handlers, `index.ts` wires them. -- `src/theme/` — how pages look and nothing else: `theme.json` (kinds, fields, options), `layouts/`, `partials/`, `locales/.json`, `assets/`. It has no tables, no routes and no JavaScript. -- `content/` and `seed/` — the sample catalogue. `site.json` — the site's languages, kinds, navigation and theme options. +- `src/theme/` — how pages look and nothing else: `theme.json` (kinds, fields, options), `layouts/`, `partials/`, `locales/.json`, `assets/` (the stylesheet, four images, the fonts and their licences, and the scripts `theme.json` declares). It has no tables and no routes. +- `content/` and `seed/` — the sample catalogue, a fictional titanium fastener supplier: 31 bundles in four languages, and one variant per SKU. `site.json` — the site's languages, kinds, navigation and theme options, which is where this site's own copy lives. Mallok decides the contracts on both sides. Its documentation is the reference: `PLUGIN_API.md`, `THEME_FORMAT.md` and `CONTENT_FORMAT.md` in the Mallok repository (`node_modules/mallok/types/worker.d.ts` has the types). @@ -59,9 +60,16 @@ Mallok decides the contracts on both sides. Its documentation is the reference: ### The theme and content - Templates are restricted Liquid. Output is escaped; only `content.html` and `page.head` are emitted verbatim. `page.head` carries hreflang and structured data from Mallok and must stay in `layouts/base.liquid`. -- Interface strings are in `locales/*.json` (flat maps, the default locale is the fallback). Site-specific copy is a theme option; per-language option values go under `themeOptions.$locales` in `site.json`. -- **References resolve by slug within the same language.** An `application` names its `product`; the product page lists them through `content.backrefs.application`. A `product` names its `collection`; the collection page lists `content.backrefs.product`. Mallok resolves `reference` only, not `reference[]`. -- Each language of a bundle is its own content item with its own `slug` (`index.md`, `index..md`); Mallok puts them in one `translation_group`. A bundle carries a `mallok.json` only when something outside the content must name it: the product's fixes the `translation_group` that `seed/shop-sample.sql` attaches variants to. `test/content.test.ts` checks the reference rule and keeps any identity file in step with its bundle. +- Interface strings are in `locales/*.json` (flat maps, the default locale is the fallback). Site-specific copy — the home page's headline and sections, the footer, the links behind the buttons — is a theme option, never a string in a template; per-language option values go under `themeOptions.$locales` in `site.json`, and `test/project.test.ts` fails when a language is left without one. +- **Kinds**: `product`, `collection`, `application` (the sample's industry pages, at `/industries`), `case`, `faq`, `tool`, `article`, `page`. A kind with a `base` needs a `listLayout`: without one Mallok answers its base path with a 500. +- **A product is one page with its sizes on it**, not a page per size. `facets` are the attributes a buyer filters by; `sizes` maps each SKU to what distinguishes it; `specs` is the full table. `partials/spec-table.liquid` (the specification finder, the catalogue, a collection's products, a product's neighbours) takes its columns from the first product that has `facets` and fills every row by attribute name, so every product in a language must use the same names. Below 72rem the same table is laid out as cards, two to a row on a tablet: seven columns need about 1100px in German. +- **References resolve by slug within the same language.** An `application` and a `case` name their `product`; the product page lists them through `content.backrefs.application` and `content.backrefs.case`. A `product` names its `collection`; the collection page lists `content.backrefs.product`. Mallok resolves `reference` only, not `reference[]`. +- **A link in a Markdown body is plain text to Mallok**: it is not rewritten per language and nothing reports a dead one. Write the path of the page in the same language (`/de/products/`); `test/content.test.ts` checks every one. +- `[[inquiry]]` on a line of its own becomes the inquiry plugin's form when that plugin is enabled. Its labels exist in English and Chinese only (Mallok), so the other languages show English labels. +- The header puts the site name, the navigation, the language control and one button on a single line from 1280px. The sample's ten links fit in all four languages with little to spare (German is the longest); a longer label in `site.json` overflows that line, and only a look at the page at 1280px shows it. +- **A script only adds to a page that is already whole.** There are two. `assets/finder.js` puts filters above the specification table on the home page and in the catalogue. `assets/calculators.js` runs the three fastener calculators on a `tool` page whose front matter says `calculators: fasteners`, above a text that prints the same formulas, constants and tables — and `test/theme-scripts.test.ts` holds every constant in the script, and every figure it computes, to that page. In both cases the form is in the page `hidden`, with its labels from the language pack and its numbers in `value` attributes, so the script reads no language and the page offers nothing it cannot do. A script asks for a field with `querySelector`, never through `form.elements`: that list answers `length` with a count, whatever a field is called. A script is a plain file — no build step, no imports — declared in `theme.json`'s `clientScripts` with its exact size, and loaded only as ``, only by the layout that has what it works on. It hands its pure functions to `module.exports` when a `module` exists, which is how `test/theme-scripts.test.ts` runs them under `node:vm`; what it does to a page is checked in a browser, by hand. +- Fonts are files in `assets/fonts/`, declared in `style.css` and preloaded in `layouts/base.liquid`; nothing is loaded from another host. Changing any asset means bumping `version` in `theme.json`: assets are served from a versioned path and cached for good. +- Each language of a bundle is its own content item with its own `slug` (`index.md`, `index..md`); Mallok puts them in one `translation_group`. A bundle carries a `mallok.json` only when something outside the content must name it: each product's fixes the `translation_group` that `seed/shop-sample.sql` attaches its variants to. `test/content.test.ts` checks the reference rule, keeps every identity file in step with its bundle, and holds the seed's variants to the SKUs the product pages list. - The default language (English) is unprefixed; others are `//…`. English pages default to USD, the rest to EUR (`lib/currency.ts`), never by IP. ### Known limits of mallok 0.1.0-rc.9 that shape the code @@ -81,7 +89,9 @@ Each is a task in Mallok's plan for plugin API 2. When Mallok ships one, upgrade - A test for a fix must be seen failing without the fix. For new guards, break the guard and confirm the test goes red. - A race is tested by running the calls with `Promise.all`, and such a test only counts once breaking the guard turns it red: that is the proof the two calls really interleave. - `countD1Calls` in `test/shop/helpers.ts` counts round trips; use it wherever the number is a design constraint. `interceptBatches` runs a hook around each batch: it is how a test changes the data between a function's reading and its writing, or loses the answer to a write that committed. -- `npm run smoke:shop` is the only place theme, plugin, content and the Mallok CLI run together; run it when touching any of them. +- `test/theme/pages.test.ts` renders every layout from content it creates itself, with everything set; `test/theme/bare.test.ts` does the same for a site that has filled in almost nothing, and fails on any empty element or `href=""`. Neither reads `content/`. A template that prints a wrapper has to check that there is something to put in it — and `content.html` is not a string, so capture it before comparing it with `blank`. The sample is checked by `test/content.test.ts` and `test/project.test.ts` (files only, no Worker) and by the smoke run. +- `npm run smoke:shop` is the only place theme, plugin, content and the Mallok CLI run together; run it when touching any of them. It publishes the real sample, requests every kind of page, and follows every header and footer link in all four languages. +- `scripts/lib/local-shop.mjs` is the one place that brings a local shop up — administrator, plugins, settings, content, variants, in that order and before any page is requested. The smoke run and `npm run preview` both use it; do not grow a second copy. Locally nothing purges the page cache (`s-maxage=3600`, persisted under the state directory), so a page requested before the set-up finished stays as it was. ## Commerce invariants (do not "simplify" them away) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbb8b82..1f63b2e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,12 +6,13 @@ Thanks for taking the time to contribute. ```bash npm ci -npm run build # stages the admin and the theme's assets -npm run smoke:shop # the whole shop on a throwaway local Worker +npm run preview # a local shop with the sample catalogue, to look at +npm run smoke:shop # the same shop, checked end to end ``` No Cloudflare account is needed for local development: D1 and R2 are simulated -locally. The README has the steps for a local shop you can browse. +locally. `preview` runs on a throwaway database; the README has the steps for a +local site that keeps its data. **npm, not pnpm or yarn.** Nundar is a Mallok site, and Mallok's CLI installs and upgrades with npm only; it refuses a project that carries another @@ -71,10 +72,13 @@ same pull request and explain the new reasoning. | Webhooks | Verified against the bytes as received before anything is parsed. 5xx only for what delivering again could change; everything else is answered 200 and written down. | | Language | Decided by the URL alone. Never redirect or switch by IP — crawlers would see one language. | | References | A `reference` field names the target's slug **in the same language**. `test/content.test.ts` checks the sample content. | -| Bundle identity | A bundle needs a `mallok.json` only when something outside the content names it: the sample variants attach to the product by its translation group. Where the file exists, `test/content.test.ts` keeps it in step with the bundle. | +| Links in content | A link in a Markdown body is the path of the page in the same language. Mallok does not rewrite it and does not report a dead one; `test/content.test.ts` does. | +| Product attributes | Every product in a language names the same `facets`, in the same order: they are the columns of the specification finder. A size is a row in `sizes`, not a page of its own. | +| Bundle identity | A bundle needs a `mallok.json` only when something outside the content names it: the sample variants attach to a product by its translation group. Where the file exists, `test/content.test.ts` keeps it in step with the bundle, and holds the seeded variants to the SKUs the page lists. | +| Site copy | Words a visitor reads that belong to this site, not to the theme, are theme options in `site.json`, with a value per language under `$locales`. `test/project.test.ts` fails when a language has none. | | Database access | Raw SQL through D1, no ORM. Batch reads and writes: a tick of the cron shares one invocation's CPU budget with every other plugin. | | Migrations | Additive only, idempotent, and a comment has a line to itself — Mallok's migrator drops whole-line comments and then splits on semicolons. | -| Theme | No `{% endif %} {% endblock %} diff --git a/src/theme/layouts/list.liquid b/src/theme/layouts/list.liquid index dbfba0e..943303f 100644 --- a/src/theme/layouts/list.liquid +++ b/src/theme/layouts/list.liquid @@ -6,14 +6,17 @@ {% if list.items.size > 0 %}
- {% for item in list.items %}{% render "partials/card", item: item %}{% endfor %} + {% for item in list.items %}{% render "partials/card", item: item, eyebrow: item.frontmatter.sector %}{% endfor %}
{% else %}

{{ t.empty }}

{% endif %} + {% if list.prev_path != "" or list.has_next %} + {% endif %} +{% if theme.options.cta_title != blank %}{% render "partials/closing" %}{% endif %} {% endblock %} diff --git a/src/theme/layouts/page.liquid b/src/theme/layouts/page.liquid index da260c9..616c055 100644 --- a/src/theme/layouts/page.liquid +++ b/src/theme/layouts/page.liquid @@ -5,6 +5,14 @@

{{ content.title }}

{% if content.description != "" %}

{{ content.description }}

{% endif %} -
{{ content.html }}
+ {% if content.cover != blank %} +
+ {% endif %} + {%- comment -%} + `content.html` is not a string, so it cannot be compared with one: the + body is captured first, and a page without one gets no empty box. + {%- endcomment -%} + {% capture body %}{{ content.html }}{% endcapture %} + {% if body != blank %}
{{ content.html }}
{% endif %} {% endblock %} diff --git a/src/theme/layouts/product.liquid b/src/theme/layouts/product.liquid index 8e27f56..d2276f8 100644 --- a/src/theme/layouts/product.liquid +++ b/src/theme/layouts/product.liquid @@ -7,68 +7,106 @@ {{ content.title }} -
-

{{ content.title }}

- {% if content.description != "" %}

{{ content.description }}

{% endif %} -
+ {% assign shots = content.frontmatter.gallery %} + {% assign has_gallery = false %} + {% for path in shots %}{% if content.images[path] %}{% assign has_gallery = true %}{% endif %}{% endfor %} +
+ {% if has_gallery %} +
+ {%- comment -%} + The large picture is the first one that exists, which is not always + the first one named: a path that names no file is skipped, and the + picture after it must not be loaded as a thumbnail. + {%- endcomment -%} + {% assign shown = 0 %} + {% for path in shots %} + {% assign shot = content.images[path] %} + {% if shot %} + {% assign shown = shown | plus: 1 %} + {% if shot.alt != + {% endif %} + {% endfor %} +
+ {% endif %} -
-
- {% assign shots = content.frontmatter.gallery %} - {% assign has_gallery = false %} - {% for path in shots %}{% if content.images[path] %}{% assign has_gallery = true %}{% endif %}{% endfor %} - {% if has_gallery %} -
- {% for path in shots %} - {% assign shot = content.images[path] %} - {% if shot %} - {% if shot.alt != - {% endif %} - {% endfor %} -
+
+ {% if content.refs.collection %}

{{ content.refs.collection.title }}

{% endif %} +

{{ content.title }}

+ {% if content.description != "" %}

{{ content.description }}

{% endif %} + + {% assign facets = content.frontmatter.facets %} + {% if facets != blank %} +
+ {% for pair in facets %}
{{ pair[0] }}
{{ pair[1] }}
{% endfor %} +
{% endif %} {%- comment -%} - The body carries the product's features and the applications that have - not been given a page of their own. Keeping them here is deliberate: - they strengthen this page for attribute searches, where a page per - feature would only multiply near-identical pages. + The sizes on offer, each with the SKU a buyer quotes. Prices and + availability will sit in this table once the shop plugin can supply + them to the page. {%- endcomment -%} -
{{ content.html }}
- - {% assign specs = content.frontmatter.specs %} - {% if specs != blank %} -
-

{{ t.specifications }}

- + {% assign sizes = content.frontmatter.sizes %} + {% if sizes != blank %} +
+

{{ t.sizes }}

+
+ - {% for pair in specs %}{% endfor %} + {% for pair in sizes %}{% endfor %}
{{ t.sku }}{{ t.size }}
{{ pair[0] }}{{ pair[1] }}
{{ pair[0] }}{{ pair[1] }}
{% endif %} -
-
+
+ + {%- comment -%} + `content.html` is not a string, so it cannot be compared with one: the + body is captured first, and a page without one gets no empty box. + {%- endcomment -%} + {% capture body %}{{ content.html }}{% endcapture %} + {% assign specs = content.frontmatter.specs %} + {% if body != blank or specs != blank %} +
+ {%- comment -%} + The body carries the product's features and the uses that have not been + given a page of their own. Keeping them here is deliberate: they + strengthen this page for attribute searches, where a page per feature + would only multiply near-identical pages. + {%- endcomment -%} + {% if body != blank %}
{{ content.html }}
{% endif %} + + {% if specs != blank %} + + {% endif %}
+ {% endif %} {%- comment -%} - The application notes written about this product. Each is its own landing - page; Mallok resolves them from the `product` reference they declare, so - nothing here has to be kept in step by hand. + The industry pages and case studies written about this product. Each is + its own landing page; Mallok resolves them from the `product` reference + they declare, so nothing here has to be kept in step by hand. {%- endcomment -%} {% if content.backrefs.application.size > 0 %}
-

{{ t.application }}

+

{{ t.used_in }}

{{ t.applications_aside }}

@@ -77,13 +115,20 @@
{% endif %} - {% if content.siblings.size > 0 %} + {% if content.backrefs.case.size > 0 %}
-

{{ t.related_products }}

+

{{ t.cases_with }}

- {% for item in content.siblings limit: 3 %}{% render "partials/card", item: item %}{% endfor %} + {% for item in content.backrefs.case %}{% render "partials/card", item: item, eyebrow: item.frontmatter.sector %}{% endfor %}
{% endif %} + + {% if content.siblings.size > 0 %} +
+

{{ t.related_products }}

+ {% render "partials/spec-table", items: content.siblings %} +
+ {% endif %} {% endblock %} diff --git a/src/theme/layouts/products.liquid b/src/theme/layouts/products.liquid new file mode 100644 index 0000000..aac580a --- /dev/null +++ b/src/theme/layouts/products.liquid @@ -0,0 +1,25 @@ +{% layout "layouts/base" %} +{% block content %} +
+
+

{{ page.title }}

+

{{ t.catalogue_lede }}

+
+ {% if list.items.size > 0 %} + {% render "partials/spec-table", items: list.items, filters: true %} + {% else %} +

{{ t.empty }}

+ {% endif %} + {% if list.prev_path != "" or list.has_next %} + + {% endif %} +
+{% if theme.options.cta_title != blank %}{% render "partials/closing" %}{% endif %} +{%- comment -%} + Filters for the table above, added by a script when there is a table. +{%- endcomment -%} +{% if list.items.size > 0 %}{% endif %} +{% endblock %} diff --git a/src/theme/layouts/tool.liquid b/src/theme/layouts/tool.liquid new file mode 100644 index 0000000..9c1d3dd --- /dev/null +++ b/src/theme/layouts/tool.liquid @@ -0,0 +1,32 @@ +{% layout "layouts/base" %} +{% block content %} +
+ + +
+

{{ t.tool_eyebrow }}

+

{{ content.title }}

+ {% if content.description != "" %}

{{ content.description }}

{% endif %} +
+ + {%- comment -%} + `content.html` is not a string, so it cannot be compared with one: the + body is captured first, and a page without one gets no empty box. + {%- endcomment -%} + {% capture body %}{{ content.html }}{% endcapture %} + {%- comment -%} + A reference page may ask for the calculators that go with it. They sit + above the text, which gives the same formulas and constants and tables + of results: the page is whole without them, and they are in it hidden + until their script has run. + {%- endcomment -%} + {% if content.frontmatter.calculators == "fasteners" %}{% render "partials/calculators" %}{% endif %} + + {% if body != blank %}
{{ content.html }}
{% endif %} +
+{% if theme.options.cta_title != blank %}{% render "partials/closing" %}{% endif %} +{% if content.frontmatter.calculators == "fasteners" %}{% endif %} +{% endblock %} diff --git a/src/theme/locales/de.json b/src/theme/locales/de.json index bdb2bf6..d2d097b 100644 --- a/src/theme/locales/de.json +++ b/src/theme/locales/de.json @@ -6,30 +6,125 @@ "footer_nav": "Fußzeile", "language": "Sprache", "home": "Startseite", - "breadcrumb": "Brotkrumennavigation", - "request_quote": "Angebot anfordern", + "breadcrumb": "Brotkrumenpfad", + "request_quote": "Individuelles Angebot anfragen", + "quote_short": "Angebot anfragen", + "contact_us": "Kontakt aufnehmen", + "find_spec": "Spezifikation finden", + "browse_by_type": "Produkte nach Typ", + "view_all_specs": "Alle Spezifikationen ansehen", + "finder_title": "Spezifikation finden", + "finder_lede": "Teile aus dem Katalog mit den Merkmalen, nach denen sie spezifiziert werden, und den lieferbaren Größen.", + "catalogue_lede": "Alle Teile des Katalogs mit den Merkmalen, nach denen sie spezifiziert werden, und den lieferbaren Größen.", + "view_catalogue": "Gesamten Katalog ansehen", + "col_product": "Produkt", + "col_sizes": "Größen", + "view_specs": "Spezifikation ansehen", + "filter_title": "Teile filtern", + "filter_search": "Suche", + "filter_all": "Alle", + "filter_reset": "Filter zurücksetzen", + "filter_count": "{shown} von {total} Teilen", + "filter_none": "Kein Standardteil entspricht dieser Kombination.", + "custom_cta": "Gewünschtes Teil beschreiben", + "custom_diagram_alt": "Bemaßte Zeichnung einer Sonderschraube", + "quality_title": "Qualitätssicherung", "product": "Produkte", - "application": "Anwendungen", - "collection": "Kollektionen", - "article": "Neuigkeiten", - "applications_aside": "Wo dieses Produkt eingesetzt wird", - "application_note": "Anwendungsnotiz", + "collection": "Produkttypen", + "application": "Branchen", + "case": "Fallstudien", + "faq": "Häufig gestellte Fragen", + "article": "Aktuelles", + "tool": "Technische Hilfsmittel", + "applications_aside": "Wo unsere Teile spezifiziert werden – und warum", + "application_note": "Branche", "the_part": "Das hier besprochene Teil", "view_product": "Produkt ansehen", - "other_applications": "Weitere Anwendungen", - "collection_eyebrow": "Kollektion", - "products_in_collection": "Produkte in dieser Kollektion", - "related_products": "Ähnliche Produkte", - "specifications": "Spezifikationen", - "spec_highlights": "Worauf es bei dieser Anwendung ankommt", - "material": "Werkstoff", - "standard": "Norm", + "other_applications": "Weitere Branchen", + "collection_eyebrow": "Produkttyp", + "products_in_collection": "Produkte dieses Typs", + "related_products": "Verwandte Produkte", + "specifications": "Spezifikation", + "sizes": "Größen", + "sku": "Artikelnummer", + "size": "Größe", + "spec_highlights": "Worauf es hier ankommt", + "used_in": "Branchen, die es spezifizieren", + "cases_with": "Fallstudien mit diesem Teil", + "case_eyebrow": "Fallstudie", + "results": "Ergebnisse", + "the_product_used": "Das eingesetzte Teil", + "other_cases": "Weitere Fallstudien", + "faq_eyebrow": "Fragen und Antworten", + "other_faq": "Weitere Themen", + "tool_eyebrow": "Technisches Hilfsmittel", + "calc_title": "Schraubenrechner", + "calc_inputs": "Eingaben", + "calc_thread": "Gewindegröße", + "calc_mass_title": "Massenreduktion Titan gegenüber Stahl", + "calc_length": "Länge (mm)", + "calc_quantity": "Anzahl der Verbindungselemente", + "calc_baseline": "Vergleichsmetall", + "calc_steel": "Kohlenstoffstahl 10.9 (7,85 g/cm³)", + "calc_stainless": "Edelstahl 316 (8,00 g/cm³)", + "calc_head": "Kopfgeometrie", + "calc_head_socket": "Zylinderschraube mit Innensechskant (zylindrischer Standardkopf)", + "calc_head_button": "Linsenkopfschraube (flacher Kopf)", + "calc_head_countersunk": "Senkkopf 90°", + "calc_head_flange": "Schwere Sechskantschraube mit Flansch", + "calc_reduction": "Massenreduktion", + "calc_baseline_total": "Gesamtmasse, Vergleichsmetall", + "calc_titanium_total": "Gesamtmasse, Titan Grade 5", + "calc_saved": "Eingesparte Masse", + "calc_launch_cost": "Entsprechende Startkosten", + "calc_each": "Masse eines Verbindungselements", + "calc_each_baseline": "Vergleichsmetall", + "calc_each_grade5": "Titan Grade 5", + "calc_each_grade2": "Titan Grade 2", + "calc_each_aluminum": "Aluminium 7075-T6", + "calc_torque_title": "Anzugsdrehmoment und Vorspannkraft", + "calc_pitch": "Gewindesteigung (mm)", + "calc_grade": "Titansorte", + "calc_grade5": "Grade 5 (Streckgrenze 828 MPa)", + "calc_grade2": "Reintitan Grade 2 (Streckgrenze 275 MPa)", + "calc_preload_percent": "Vorspannung, % der Streckgrenze", + "calc_lubricant": "Schmierzustand", + "calc_lubricant_moly": "Anti-Seize-Paste mit Molybdändisulfid (MoS2), K = 0,11 (empfohlen)", + "calc_lubricant_copper": "Anti-Seize-Paste auf Kupferbasis, K = 0,13", + "calc_lubricant_oil": "Leichtes Maschinenöl SAE 30, K = 0,16", + "calc_lubricant_dry": "Trocken, im Anlieferungszustand, K = 0,22 (hohe Fressgefahr)", + "calc_dry_warning": "Die trockene Montage von Titangewinden führt unter Vorspannung zu Kaltverschweißen und Gewindefressen. Schreiben Sie immer eine Anti-Seize-Paste vor.", + "calc_torque": "Anzugsdrehmoment", + "calc_torque_imperial": "In angloamerikanischen Einheiten", + "calc_stress_area": "Spannungsquerschnitt As", + "calc_preload": "Vorspannkraft Fi", + "calc_engagement_title": "Einschraubtiefe gegen Gewindeausreißen", + "calc_housing": "Werkstoff des Gehäuses (Gewindebohrung)", + "calc_housing_aluminum": "Luftfahrtaluminium 6061-T6 / 7075-T6", + "calc_housing_magnesium": "Magnesiumguss (AZ91D / ZE41)", + "calc_housing_titanium": "Titan Grade 5 (Ti-6Al-4V)", + "calc_housing_steel": "Hochfester Stahl 4140 / Inconel", + "calc_note_aluminum": "Die geringere Scherfestigkeit von Aluminium-Innengewinden erfordert etwa 1,8× Durchmesser, damit die Schraube sicher bricht, bevor das Gewinde der Bohrung ausreißt.", + "calc_note_magnesium": "Der weiche Magnesium-Grundwerkstoff erfordert eine größere Gewindetiefe von etwa 2,2× Durchmesser, um ein Ausreißen des Gewindes zu verhindern.", + "calc_note_titanium": "Die gleichwertige Scherfestigkeit erlaubt die Standard-Einschraubtiefe von 1,2× Durchmesser.", + "calc_note_steel": "Die hohe Scherfließgrenze erlaubt eine kompakte Einschraubtiefe von 1,0× Durchmesser.", + "calc_depth": "Mindesteinschraubtiefe", + "calc_threads": "Tragende Gewindegänge, mindestens", + "calc_percent": "{value} %", + "calc_money": "{value} $", "datasheet": "Datenblatt herunterladen", "gallery": "Produktbilder", + "explore": "Entdecken", + "contact": "Kontakt", + "terms": "Allgemeine Geschäftsbedingungen", + "privacy": "Datenschutzerklärung", + "compliance": "Konformität", + "read_more": "Weiterlesen", "empty": "Hier gibt es noch nichts.", "pagination": "Seitennavigation", + "page": "Seite", "prev": "Zurück", "next": "Weiter", "not_found_title": "Seite nicht gefunden", - "not_found_body": "Die angeforderte Seite ist hier nicht vorhanden. Möglicherweise wurde sie verschoben, oder der Link ist fehlerhaft." + "not_found_body": "Die angeforderte Seite gibt es hier nicht. Sie wurde möglicherweise verschoben, oder der Link ist fehlerhaft." } diff --git a/src/theme/locales/en.json b/src/theme/locales/en.json index b5b3d02..bc688c2 100644 --- a/src/theme/locales/en.json +++ b/src/theme/locales/en.json @@ -7,27 +7,122 @@ "language": "Language", "home": "Home", "breadcrumb": "Breadcrumb", - "request_quote": "Request a quote", + "request_quote": "Request a custom quote", + "quote_short": "Request a quote", + "contact_us": "Contact our team", + "find_spec": "Find a specification", + "browse_by_type": "Browse products by type", + "view_all_specs": "View every specification", + "finder_title": "Find a specification", + "finder_lede": "Parts from the catalogue, with the attributes each is specified by and the sizes on offer.", + "catalogue_lede": "Every part in the catalogue, with the attributes it is specified by and the sizes on offer.", + "view_catalogue": "View the whole catalogue", + "col_product": "Product", + "col_sizes": "Sizes", + "view_specs": "View specification", + "filter_title": "Filter the parts", + "filter_search": "Search", + "filter_all": "All", + "filter_reset": "Clear filters", + "filter_count": "{shown} of {total} parts", + "filter_none": "No standard part matches this combination.", + "custom_cta": "Describe the part you need", + "custom_diagram_alt": "Dimensioned drawing of a custom bolt", + "quality_title": "Quality assurance", "product": "Products", - "application": "Applications", - "collection": "Collections", + "collection": "Product types", + "application": "Industries", + "case": "Case studies", + "faq": "Frequently asked questions", "article": "News", - "applications_aside": "Where it is specified, and why", - "application_note": "Application note", + "tool": "Engineering tools", + "applications_aside": "Where our parts are specified, and why", + "application_note": "Industry", "the_part": "The part discussed here", "view_product": "View product", - "other_applications": "Other applications", - "collection_eyebrow": "Collection", - "products_in_collection": "Products in this collection", + "other_applications": "Other industries", + "collection_eyebrow": "Product type", + "products_in_collection": "Products of this type", "related_products": "Related products", - "specifications": "Specifications", - "spec_highlights": "What matters in this application", - "material": "Material", - "standard": "Standard", + "specifications": "Specification", + "sizes": "Sizes", + "sku": "SKU", + "size": "Size", + "spec_highlights": "What matters here", + "used_in": "Industries that specify it", + "cases_with": "Case studies with this part", + "case_eyebrow": "Case study", + "results": "Results", + "the_product_used": "The part used", + "other_cases": "More case studies", + "faq_eyebrow": "Questions and answers", + "other_faq": "Other topics", + "tool_eyebrow": "Engineering tool", + "calc_title": "Fastener calculators", + "calc_inputs": "Inputs", + "calc_thread": "Thread size", + "calc_mass_title": "Titanium versus steel mass reduction", + "calc_length": "Length (mm)", + "calc_quantity": "Number of fasteners", + "calc_baseline": "Baseline metal", + "calc_steel": "Carbon steel 10.9 (7.85 g/cm³)", + "calc_stainless": "Stainless steel 316 (8.00 g/cm³)", + "calc_head": "Head geometry", + "calc_head_socket": "Socket head cap screw (standard cylindrical)", + "calc_head_button": "Button head screw (low profile)", + "calc_head_countersunk": "Flat countersunk 90° head", + "calc_head_flange": "Hex flange heavy bolt", + "calc_reduction": "Mass reduction", + "calc_baseline_total": "Total mass, baseline metal", + "calc_titanium_total": "Total mass, Grade 5 titanium", + "calc_saved": "Mass saved", + "calc_launch_cost": "Launch cost equivalent", + "calc_each": "Mass of one fastener", + "calc_each_baseline": "Baseline metal", + "calc_each_grade5": "Grade 5 titanium", + "calc_each_grade2": "Grade 2 titanium", + "calc_each_aluminum": "7075-T6 aluminum", + "calc_torque_title": "Tightening torque and preload", + "calc_pitch": "Thread pitch (mm)", + "calc_grade": "Titanium grade", + "calc_grade5": "Grade 5 (yield strength 828 MPa)", + "calc_grade2": "Grade 2, commercially pure (yield strength 275 MPa)", + "calc_preload_percent": "Preload, % of yield strength", + "calc_lubricant": "Lubricant condition", + "calc_lubricant_moly": "Molybdenum disulfide (MoS2) anti-seize paste, K = 0.11 (recommended)", + "calc_lubricant_copper": "Copper based anti-seize compound, K = 0.13", + "calc_lubricant_oil": "Light SAE 30 machine oil, K = 0.16", + "calc_lubricant_dry": "Dry, as received, K = 0.22 (high galling risk)", + "calc_dry_warning": "Dry assembly of titanium threads leads to cold welding and thread galling under preload. Always specify an anti-seize paste.", + "calc_torque": "Tightening torque", + "calc_torque_imperial": "In imperial units", + "calc_stress_area": "Tensile stress area As", + "calc_preload": "Clamping preload Fi", + "calc_engagement_title": "Thread shear engagement depth", + "calc_housing": "Housing material (tapped block)", + "calc_housing_aluminum": "6061-T6 / 7075-T6 aerospace aluminum", + "calc_housing_magnesium": "Magnesium casting (AZ91D / ZE41)", + "calc_housing_titanium": "Grade 5 titanium (Ti-6Al-4V)", + "calc_housing_steel": "High-strength 4140 steel / Inconel", + "calc_note_aluminum": "Lower shear strength of aluminum female threads requires about 1.8× diameter to guarantee the bolt breaks before the hole strips.", + "calc_note_magnesium": "Soft magnesium base material requires a deeper tap depth of about 2.2× diameter to prevent thread tear-out.", + "calc_note_titanium": "Matched shear strength allows the standard 1.2× diameter engagement depth.", + "calc_note_steel": "High shear yield allows a compact 1.0× diameter thread engagement.", + "calc_depth": "Minimum thread engagement length", + "calc_threads": "Engaged full threads, at least", + "calc_percent": "{value}%", + "calc_money": "${value}", "datasheet": "Download datasheet", "gallery": "Product images", + "explore": "Explore", + "contact": "Contact", + "terms": "Terms and conditions", + "privacy": "Privacy policy", + "compliance": "Compliance", + "read_more": "Read more", "empty": "Nothing here yet.", "pagination": "Pagination", + "page": "page", "prev": "Previous", "next": "Next", "not_found_title": "Page not found", diff --git a/src/theme/locales/es.json b/src/theme/locales/es.json index 2d888a3..7077f40 100644 --- a/src/theme/locales/es.json +++ b/src/theme/locales/es.json @@ -1,33 +1,128 @@ { "language_name": "Español", - "skip": "Ir al contenido", + "skip": "Saltar al contenido", "menu": "Menú", "nav": "Navegación principal", "footer_nav": "Pie de página", "language": "Idioma", "home": "Inicio", "breadcrumb": "Ruta de navegación", - "request_quote": "Solicitar presupuesto", + "request_quote": "Solicitar presupuesto a medida", + "quote_short": "Solicitar presupuesto", + "contact_us": "Contactar con nuestro equipo", + "find_spec": "Encontrar una especificación", + "browse_by_type": "Productos por tipo", + "view_all_specs": "Ver todas las especificaciones", + "finder_title": "Encontrar una especificación", + "finder_lede": "Piezas del catálogo, con los atributos por los que se especifican y las medidas disponibles.", + "catalogue_lede": "Todas las piezas del catálogo, con los atributos por los que se especifican y las medidas disponibles.", + "view_catalogue": "Ver todo el catálogo", + "col_product": "Producto", + "col_sizes": "Medidas", + "view_specs": "Ver la especificación", + "filter_title": "Filtrar las piezas", + "filter_search": "Buscar", + "filter_all": "Todos", + "filter_reset": "Borrar filtros", + "filter_count": "{shown} de {total} piezas", + "filter_none": "Ninguna pieza estándar coincide con esta combinación.", + "custom_cta": "Describir la pieza que necesita", + "custom_diagram_alt": "Plano acotado de un tornillo a medida", + "quality_title": "Aseguramiento de la calidad", "product": "Productos", - "application": "Aplicaciones", - "collection": "Colecciones", - "article": "Noticias", - "applications_aside": "Dónde se especifica este producto y por qué", - "application_note": "Nota de aplicación", - "the_part": "La pieza tratada aquí", - "view_product": "Ver producto", - "other_applications": "Otras aplicaciones", - "collection_eyebrow": "Colección", - "products_in_collection": "Productos de esta colección", + "collection": "Tipos de producto", + "application": "Sectores", + "case": "Casos de éxito", + "faq": "Preguntas frecuentes", + "article": "Novedades", + "tool": "Herramientas de ingeniería", + "applications_aside": "Dónde se especifican nuestras piezas, y por qué", + "application_note": "Sector", + "the_part": "La pieza de la que se trata", + "view_product": "Ver el producto", + "other_applications": "Otros sectores", + "collection_eyebrow": "Tipo de producto", + "products_in_collection": "Productos de este tipo", "related_products": "Productos relacionados", - "specifications": "Especificaciones", - "spec_highlights": "Lo que importa en esta aplicación", - "material": "Material", - "standard": "Norma", - "datasheet": "Descargar ficha técnica", + "specifications": "Especificación", + "sizes": "Medidas", + "sku": "Referencia", + "size": "Medida", + "spec_highlights": "Lo que importa aquí", + "used_in": "Sectores que la especifican", + "cases_with": "Casos de éxito con esta pieza", + "case_eyebrow": "Caso de éxito", + "results": "Resultados", + "the_product_used": "La pieza utilizada", + "other_cases": "Más casos de éxito", + "faq_eyebrow": "Preguntas y respuestas", + "other_faq": "Otros temas", + "tool_eyebrow": "Herramienta de ingeniería", + "calc_title": "Calculadoras de fijaciones", + "calc_inputs": "Datos de entrada", + "calc_thread": "Medida de rosca", + "calc_mass_title": "Reducción de masa del titanio frente al acero", + "calc_length": "Longitud (mm)", + "calc_quantity": "Número de fijaciones", + "calc_baseline": "Metal de referencia", + "calc_steel": "Acero al carbono 10.9 (7,85 g/cm³)", + "calc_stainless": "Acero inoxidable 316 (8,00 g/cm³)", + "calc_head": "Geometría de la cabeza", + "calc_head_socket": "Tornillo de cabeza cilíndrica Allen (cilíndrica estándar)", + "calc_head_button": "Tornillo de cabeza abombada (perfil bajo)", + "calc_head_countersunk": "Cabeza avellanada plana de 90°", + "calc_head_flange": "Tornillo pesado de cabeza hexagonal con brida", + "calc_reduction": "Reducción de masa", + "calc_baseline_total": "Masa total, metal de referencia", + "calc_titanium_total": "Masa total, titanio grado 5", + "calc_saved": "Masa ahorrada", + "calc_launch_cost": "Coste de lanzamiento equivalente", + "calc_each": "Masa de una fijación", + "calc_each_baseline": "Metal de referencia", + "calc_each_grade5": "Titanio grado 5", + "calc_each_grade2": "Titanio grado 2", + "calc_each_aluminum": "Aluminio 7075-T6", + "calc_torque_title": "Par de apriete y precarga", + "calc_pitch": "Paso de rosca (mm)", + "calc_grade": "Grado de titanio", + "calc_grade5": "Grado 5 (límite elástico 828 MPa)", + "calc_grade2": "Grado 2 comercialmente puro (límite elástico 275 MPa)", + "calc_preload_percent": "Precarga, % del límite elástico", + "calc_lubricant": "Estado de lubricación", + "calc_lubricant_moly": "Pasta antigripante de disulfuro de molibdeno (MoS2), K = 0,11 (recomendada)", + "calc_lubricant_copper": "Compuesto antigripante a base de cobre, K = 0,13", + "calc_lubricant_oil": "Aceite ligero de máquinas SAE 30, K = 0,16", + "calc_lubricant_dry": "En seco, tal como se recibe, K = 0,22 (alto riesgo de gripado)", + "calc_dry_warning": "El montaje en seco de roscas de titanio provoca soldadura en frío y gripado de la rosca bajo precarga. Especifique siempre una pasta antigripante.", + "calc_torque": "Par de apriete", + "calc_torque_imperial": "En unidades imperiales", + "calc_stress_area": "Sección resistente As", + "calc_preload": "Precarga de apriete Fi", + "calc_engagement_title": "Profundidad de acoplamiento de la rosca a cizalladura", + "calc_housing": "Material del alojamiento (bloque roscado)", + "calc_housing_aluminum": "Aluminio aeroespacial 6061-T6 / 7075-T6", + "calc_housing_magnesium": "Fundición de magnesio (AZ91D / ZE41)", + "calc_housing_titanium": "Titanio grado 5 (Ti-6Al-4V)", + "calc_housing_steel": "Acero 4140 de alta resistencia / Inconel", + "calc_note_aluminum": "La menor resistencia a cizalladura de las roscas hembra de aluminio requiere en torno a 1,8× el diámetro para garantizar que el tornillo rompa antes de que se arranque la rosca del agujero.", + "calc_note_magnesium": "El material base de magnesio, blando, requiere una profundidad de roscado mayor, de en torno a 2,2× el diámetro, para evitar el arrancamiento de la rosca.", + "calc_note_titanium": "La resistencia a cizalladura equiparada permite la profundidad de acoplamiento estándar de 1,2× el diámetro.", + "calc_note_steel": "El alto límite elástico a cizalladura permite un acoplamiento de rosca compacto de 1,0× el diámetro.", + "calc_depth": "Longitud mínima de acoplamiento de la rosca", + "calc_threads": "Filetes completos acoplados, como mínimo", + "calc_percent": "{value} %", + "calc_money": "{value} $", + "datasheet": "Descargar la ficha técnica", "gallery": "Imágenes del producto", - "empty": "Aún no hay nada aquí.", + "explore": "Explorar", + "contact": "Contacto", + "terms": "Términos y condiciones", + "privacy": "Política de privacidad", + "compliance": "Cumplimiento", + "read_more": "Leer más", + "empty": "Todavía no hay nada aquí.", "pagination": "Paginación", + "page": "página", "prev": "Anterior", "next": "Siguiente", "not_found_title": "Página no encontrada", diff --git a/src/theme/locales/fr.json b/src/theme/locales/fr.json index 42ed39b..ab08c53 100644 --- a/src/theme/locales/fr.json +++ b/src/theme/locales/fr.json @@ -6,30 +6,125 @@ "footer_nav": "Pied de page", "language": "Langue", "home": "Accueil", - "breadcrumb": "Fil d'Ariane", - "request_quote": "Demander un devis", + "breadcrumb": "Fil d’Ariane", + "request_quote": "Demander un devis sur mesure", + "quote_short": "Demander un devis", + "contact_us": "Contacter notre équipe", + "find_spec": "Trouver une spécification", + "browse_by_type": "Produits par type", + "view_all_specs": "Voir toutes les spécifications", + "finder_title": "Trouver une spécification", + "finder_lede": "Des pièces du catalogue, avec les caractéristiques qui les définissent et les dimensions proposées.", + "catalogue_lede": "Toutes les pièces du catalogue, avec les caractéristiques qui les définissent et les dimensions proposées.", + "view_catalogue": "Voir tout le catalogue", + "col_product": "Produit", + "col_sizes": "Dimensions", + "view_specs": "Voir la spécification", + "filter_title": "Filtrer les pièces", + "filter_search": "Recherche", + "filter_all": "Tous", + "filter_reset": "Effacer les filtres", + "filter_count": "{shown} sur {total} pièces", + "filter_none": "Aucune pièce standard ne correspond à cette combinaison.", + "custom_cta": "Décrire la pièce recherchée", + "custom_diagram_alt": "Plan coté d’une vis sur mesure", + "quality_title": "Assurance qualité", "product": "Produits", - "application": "Applications", - "collection": "Collections", + "collection": "Types de produits", + "application": "Secteurs", + "case": "Études de cas", + "faq": "Questions fréquentes", "article": "Actualités", - "applications_aside": "Où ce produit est spécifié, et pourquoi", - "application_note": "Note d'application", - "the_part": "La pièce concernée", + "tool": "Outils d’ingénierie", + "applications_aside": "Où nos pièces sont spécifiées, et pourquoi", + "application_note": "Secteur", + "the_part": "La pièce dont il est question", "view_product": "Voir le produit", - "other_applications": "Autres applications", - "collection_eyebrow": "Collection", - "products_in_collection": "Produits de cette collection", + "other_applications": "Autres secteurs", + "collection_eyebrow": "Type de produit", + "products_in_collection": "Produits de ce type", "related_products": "Produits associés", - "specifications": "Caractéristiques", - "spec_highlights": "Ce qui compte pour cette application", - "material": "Matériau", - "standard": "Norme", + "specifications": "Spécification", + "sizes": "Dimensions", + "sku": "Référence", + "size": "Dimension", + "spec_highlights": "Ce qui compte ici", + "used_in": "Secteurs qui la spécifient", + "cases_with": "Études de cas avec cette pièce", + "case_eyebrow": "Étude de cas", + "results": "Résultats", + "the_product_used": "La pièce utilisée", + "other_cases": "Autres études de cas", + "faq_eyebrow": "Questions et réponses", + "other_faq": "Autres sujets", + "tool_eyebrow": "Outil d’ingénierie", + "calc_title": "Calculateurs de fixations", + "calc_inputs": "Données d’entrée", + "calc_thread": "Dimension du filetage", + "calc_mass_title": "Réduction de masse du titane par rapport à l’acier", + "calc_length": "Longueur (mm)", + "calc_quantity": "Nombre de fixations", + "calc_baseline": "Métal de référence", + "calc_steel": "Acier au carbone 10.9 (7,85 g/cm³)", + "calc_stainless": "Acier inoxydable 316 (8,00 g/cm³)", + "calc_head": "Géométrie de la tête", + "calc_head_socket": "Vis à tête cylindrique à six pans creux (cylindrique standard)", + "calc_head_button": "Vis à tête bombée (profil bas)", + "calc_head_countersunk": "Tête fraisée plate à 90°", + "calc_head_flange": "Vis lourde à tête hexagonale à embase", + "calc_reduction": "Réduction de masse", + "calc_baseline_total": "Masse totale, métal de référence", + "calc_titanium_total": "Masse totale, titane grade 5", + "calc_saved": "Masse économisée", + "calc_launch_cost": "Coût de lancement équivalent", + "calc_each": "Masse d’une fixation", + "calc_each_baseline": "Métal de référence", + "calc_each_grade5": "Titane grade 5", + "calc_each_grade2": "Titane grade 2", + "calc_each_aluminum": "Aluminium 7075-T6", + "calc_torque_title": "Couple de serrage et précharge", + "calc_pitch": "Pas du filetage (mm)", + "calc_grade": "Nuance de titane", + "calc_grade5": "Grade 5 (limite d’élasticité 828 MPa)", + "calc_grade2": "Grade 2 commercialement pur (limite d’élasticité 275 MPa)", + "calc_preload_percent": "Précharge, % de la limite d’élasticité", + "calc_lubricant": "État de lubrification", + "calc_lubricant_moly": "Pâte antigrippante au bisulfure de molybdène (MoS2), K = 0,11 (recommandée)", + "calc_lubricant_copper": "Composé antigrippant à base de cuivre, K = 0,13", + "calc_lubricant_oil": "Huile de machine légère SAE 30, K = 0,16", + "calc_lubricant_dry": "À sec, état de livraison, K = 0,22 (risque élevé de grippage)", + "calc_dry_warning": "Le montage à sec de filetages en titane provoque un soudage à froid et un grippage des filets sous précharge. Prescrivez toujours une pâte antigrippante.", + "calc_torque": "Couple de serrage", + "calc_torque_imperial": "En unités impériales", + "calc_stress_area": "Section résistante As", + "calc_preload": "Précharge de serrage Fi", + "calc_engagement_title": "Profondeur de filetage en prise au cisaillement", + "calc_housing": "Matière du carter (bloc taraudé)", + "calc_housing_aluminum": "Aluminium aéronautique 6061-T6 / 7075-T6", + "calc_housing_magnesium": "Fonderie de magnésium (AZ91D / ZE41)", + "calc_housing_titanium": "Titane grade 5 (Ti-6Al-4V)", + "calc_housing_steel": "Acier 4140 haute résistance / Inconel", + "calc_note_aluminum": "La résistance au cisaillement plus faible des filets femelles en aluminium exige environ 1,8× le diamètre pour garantir que la vis casse avant que le taraudage ne s'arrache.", + "calc_note_magnesium": "Le magnésium, matériau de base tendre, exige une profondeur de taraudage plus importante, d'environ 2,2× le diamètre, pour éviter l'arrachement des filets.", + "calc_note_titanium": "Des résistances au cisaillement équivalentes autorisent la profondeur en prise standard de 1,2× le diamètre.", + "calc_note_steel": "Une limite d'élasticité en cisaillement élevée autorise une prise de filetage compacte de 1,0× le diamètre.", + "calc_depth": "Longueur minimale de filetage en prise", + "calc_threads": "Filets complets en prise, au moins", + "calc_percent": "{value} %", + "calc_money": "{value} $", "datasheet": "Télécharger la fiche technique", "gallery": "Images du produit", - "empty": "Rien pour le moment.", + "explore": "Explorer", + "contact": "Contact", + "terms": "Conditions générales", + "privacy": "Politique de confidentialité", + "compliance": "Conformité", + "read_more": "Lire la suite", + "empty": "Rien ici pour l’instant.", "pagination": "Pagination", + "page": "page", "prev": "Précédent", "next": "Suivant", "not_found_title": "Page introuvable", - "not_found_body": "La page demandée n'existe pas ici. Elle a peut-être été déplacée, ou le lien est incorrect." + "not_found_body": "La page demandée n’est pas ici. Elle a peut-être été déplacée, ou le lien est erroné." } diff --git a/src/theme/partials/calculators.liquid b/src/theme/partials/calculators.liquid new file mode 100644 index 0000000..f041afd --- /dev/null +++ b/src/theme/partials/calculators.liquid @@ -0,0 +1,135 @@ +{%- comment -%} + The three fastener calculators. + + Hidden until the script that computes them has run: a form that cannot + answer is worse than no form, and the page below gives the formulas, the + constants and tables of results without any script. + + Every label is in the language pack. An option that stands for a number + carries it, or a name the script knows, in its value and never in its + text, so the script reads no language. The first figure of each calculator + is an , which a screen reader announces when it changes; the + figures under it are not, or every keystroke would be read out nine times. +{%- endcomment -%} + diff --git a/src/theme/partials/card.liquid b/src/theme/partials/card.liquid index 9cac213..ee68416 100644 --- a/src/theme/partials/card.liquid +++ b/src/theme/partials/card.liquid @@ -1,21 +1,21 @@ {%- comment -%} - One item in a grid: a product, an application note, a collection, an article. + One item in a grid: an industry, a case study, an article, a product. Called as {% render "partials/card", item: item, eyebrow: "…" %}. {%- endcomment -%} {%- comment -%} - No cover, no picture frame: an application note or a collection usually - has none, and an empty grey block above its title reads as a broken image. + No cover, no picture frame: an empty grey block above a title reads as a + broken image. {%- endcomment -%} {% if item.cover != blank %}
- +
{% endif %}
{% if eyebrow != blank %}

{{ eyebrow }}

{% endif %}

{{ item.title }}

{% if item.description != blank %}

{{ item.description }}

{% endif %} - {% if item.frontmatter.standard %}

{{ item.frontmatter.standard }}

{% endif %} + {{ t.read_more }} →
diff --git a/src/theme/partials/closing.liquid b/src/theme/partials/closing.liquid new file mode 100644 index 0000000..1d76997 --- /dev/null +++ b/src/theme/partials/closing.liquid @@ -0,0 +1,18 @@ +{%- comment -%} + The band that closes a page: one sentence and the two ways to get in touch. +{%- endcomment -%} +
+ +
+
+

{{ theme.options.cta_title }}

+ {% if theme.options.cta_text != blank %}

{{ theme.options.cta_text }}

{% endif %} +
+ {% if theme.options.quote_href != blank or theme.options.contact_href != blank %} +
+ {% if theme.options.quote_href != blank %}{{ t.request_quote }}{% endif %} + {% if theme.options.contact_href != blank %}{{ t.contact_us }} {% render "partials/icon", name: "arrow" %}{% endif %} +
+ {% endif %} +
+
diff --git a/src/theme/partials/footer.liquid b/src/theme/partials/footer.liquid index 93f6b68..937786a 100644 --- a/src/theme/partials/footer.liquid +++ b/src/theme/partials/footer.liquid @@ -1,11 +1,37 @@
-
-
-

{{ site.name }}

- {% if site.tagline != "" %}

{{ site.tagline }}

{% endif %} +
+
+
+ {{ site.name }} + {% if theme.options.footer_blurb != blank %}

{{ theme.options.footer_blurb }}

{% elsif theme.options.tagline != blank %}

{{ theme.options.tagline }}

{% elsif site.tagline != "" %}

{{ site.tagline }}

{% endif %} + {% if theme.options.footer_note != blank %}

{{ theme.options.footer_note }}

{% endif %} +
+ +
+

{{ t.contact }}

+ {% if theme.options.contact_email != blank %}

{{ theme.options.contact_email }}

{% endif %} + {% if theme.options.contact_phone != blank %}

{{ theme.options.contact_phone }}

{% endif %} + {% if theme.options.contact_href != blank %}{{ t.contact_us }} →{% endif %} +
+
+
+ {%- comment -%} + No year: Mallok renders the same content to the same bytes every time, + and a page that printed the date could not be cached on that promise. + {%- endcomment -%} +

© {{ site.name }}

+ {% if theme.options.terms_href != blank or theme.options.privacy_href != blank or theme.options.compliance_href != blank %} +
+ {% if theme.options.terms_href != blank %}{{ t.terms }}{% endif %} + {% if theme.options.privacy_href != blank %}{{ t.privacy }}{% endif %} + {% if theme.options.compliance_href != blank %}{{ t.compliance }}{% endif %} +
+ {% endif %}
-
diff --git a/src/theme/partials/header.liquid b/src/theme/partials/header.liquid index 774d143..1943c77 100644 --- a/src/theme/partials/header.liquid +++ b/src/theme/partials/header.liquid @@ -15,10 +15,19 @@ Each language is named in its own words, because a reader looking for their language scans for its own name. A
disclosure is a real dropdown with no script, and it scales past two languages. + + The closed control carries the current language twice, as its name + and as its code: where the bar is short of room the stylesheet shows + the code, and the names are still what the open list offers. + + What it is — "Language" — is text inside the control and not an + aria-label: a label would replace the visible words in the control's + accessible name, and a reader of the screen would then hear the same + name on every page, whatever the language. {%- endcomment -%} {% if page.alternates.size > 1 %}
- {% for alt in page.alternates %}{% if alt.locale == site.locale %}{{ alt.name }}{% endif %}{% endfor %} + {% for alt in page.alternates %}{% if alt.locale == site.locale %}{{ alt.name }}{{ alt.locale }}{% endif %}{% endfor %}
{% endif %} - {{ t.request_quote }} + {%- comment -%} + The short wording: this button shares one line with the whole + navigation, in every language. + {%- endcomment -%} + {% if theme.options.quote_href != blank %}{{ t.quote_short }}{% endif %}
diff --git a/src/theme/partials/icon.liquid b/src/theme/partials/icon.liquid new file mode 100644 index 0000000..fafedea --- /dev/null +++ b/src/theme/partials/icon.liquid @@ -0,0 +1,16 @@ +{%- comment -%} + The theme's icons, inline so that they cost no request and take the colour + of the text around them. Called as {% render "partials/icon", name: "arrow" %}. + They are decoration: the text beside each one says what it means. +{%- endcomment -%} + diff --git a/src/theme/partials/spec-table.liquid b/src/theme/partials/spec-table.liquid new file mode 100644 index 0000000..538cd8a --- /dev/null +++ b/src/theme/partials/spec-table.liquid @@ -0,0 +1,71 @@ +{%- comment -%} + The specification finder: every product in `items` as a row, one column per + filterable attribute. + + The columns are the attribute names of the first product that has any. + Every row is then filled by name, not by position, so a product that lacks + an attribute leaves that cell empty instead of pushing its other values + under the wrong headings (see `facets` in theme.json). + + A product's value is found by walking its own attributes rather than by + `facets[name]`: Liquid answers `size`, `first` and `last` on any map with a + count or an entry of its own, so an attribute called "size" would put a + number in the cell of every product that does not have one. + + On a narrow screen the stylesheet lays each row out as a card, which takes + the table's own display values away. Two things in the markup exist for + that: `data-label` lets a cell name its column once the header row is out + of sight, and the explicit roles keep the table a table for a screen + reader, which otherwise stops announcing rows and columns as soon as + `display` changes. + + With `filters: true` the table is preceded by a form to narrow it. The + form is in the page hidden, and `assets/finder.js` fills its lists from the + rows below and shows it: a form that cannot filter is not offered, and a + page without the script is the whole table, as it is without `filters`. + The layout that asks for filters also loads that script. + + Called as {% render "partials/spec-table", items: recent.product %}. +{%- endcomment -%} +{% assign lead = nil %} +{% for item in items %}{% if lead == nil and item.frontmatter.facets != blank %}{% assign lead = item %}{% endif %}{% endfor %} +{% if filters %} +
+ +{% endif %} +
+ + + + + {% for pair in lead.frontmatter.facets %}{% endfor %} + + + + + + {% for item in items %} + + + {% for pair in lead.frontmatter.facets %}{% assign name = pair[0] %}{% assign value = "" %}{% for own in item.frontmatter.facets %}{% if own[0] == name %}{% assign value = own[1] %}{% endif %}{% endfor %}{% endfor %} + + + + {% endfor %} + +
{{ t.col_product }}{{ pair[0] }}{{ t.col_sizes }}
+
+ {% if item.cover != blank %}{% endif %} + {{ item.title }} +
+ 		{{ value }}{% if item.frontmatter.sizes != blank %}
{% for pair in item.frontmatter.sizes %}{{ pair[1] }}{% endfor %}
{% endif %}		{{ t.view_specs }} {% render "partials/icon", name: "arrow" %}
+
+{% if filters %} + +
+{% endif %} diff --git a/src/theme/theme.json b/src/theme/theme.json index 3c80adc..5d0c18f 100644 --- a/src/theme/theme.json +++ b/src/theme/theme.json @@ -1,8 +1,8 @@ { "id": "nundar", "name": "Nundar", - "description": "A commerce theme: specification-first product pages, application notes that stand as their own landing pages, and collections that gather products by attribute. Script-free.", - "version": "0.1.0", + "description": "A commerce theme for a technical catalogue: a specification finder, product pages built around a size table, landing pages for the applications a part is used in, collections by type, case studies and reference pages. HTML first: every page is complete without a script, and the two it declares only add to what is already there — filters for a table, calculators beside the tables of an engineering reference.", + "version": "0.4.0", "themeApi": 1, "home": "layouts/home.liquid", "kinds": { @@ -18,33 +18,34 @@ }, "product": { "layout": "layouts/product.liquid", - "listLayout": "layouts/list.liquid", + "listLayout": "layouts/products.liquid", "label": "Product", "base": "products", "fields": { - "standard": { - "type": "string", - "label": "Standard", - "help": "The standard the product is made to, for example EN 10204 3.1.", - "group": "Specification" + "facets": { + "type": "keyvalue", + "label": "Filterable attributes", + "group": "Specification", + "help": "What a buyer filters the catalogue by, for example Head type, Thread, Material. Use the same names, in the same order, on every product: they become the columns of the specification finder." }, - "material": { - "type": "string", - "label": "Material", - "group": "Specification" + "sizes": { + "type": "keyvalue", + "label": "Sizes", + "group": "Specification", + "help": "One row per size on offer: the SKU, then what distinguishes it, for example TI-SHC-M5-20 and 20 mm." }, "specs": { "type": "keyvalue", "label": "Specifications", - "help": "Shown as a table under the description.", - "group": "Specification" + "group": "Specification", + "help": "The full specification, shown as a table on the product page." }, "collection": { "type": "reference", "kind": "collection", "label": "Collection", - "help": "Slug of the collection this product is listed in.", - "group": "Classification" + "group": "Classification", + "help": "Slug of the collection this product is listed in." }, "gallery": { "type": "image[]", @@ -55,23 +56,29 @@ "datasheet": { "type": "file", "label": "Datasheet", - "accept": [".pdf"], + "accept": ["pdf"], "group": "Specification" } } }, + "collection": { + "layout": "layouts/collection.liquid", + "listLayout": "layouts/list.liquid", + "label": "Collection", + "base": "collections" + }, "application": { "layout": "layouts/application.liquid", "listLayout": "layouts/list.liquid", "label": "Application", - "base": "applications", + "base": "industries", "fields": { "product": { "type": "reference", "kind": "product", "label": "Product", - "help": "Slug of the product this application note is about.", - "required": true + "required": true, + "help": "Slug of the product this application note is about." }, "spec_highlights": { "type": "keyvalue", @@ -80,37 +87,237 @@ } } }, - "collection": { - "layout": "layouts/collection.liquid", + "case": { + "layout": "layouts/case.liquid", "listLayout": "layouts/list.liquid", - "label": "Collection", - "base": "collections" + "label": "Case study", + "base": "case-studies", + "fields": { + "sector": { + "type": "string", + "label": "Sector", + "help": "The industry the work was done for, shown above the title." + }, + "product": { + "type": "reference", + "kind": "product", + "label": "Product", + "help": "Slug of the product the case study used." + }, + "results": { + "type": "keyvalue", + "label": "Results", + "help": "The measured outcomes, each a short label and a figure." + } + } + }, + "faq": { + "layout": "layouts/faq.liquid", + "listLayout": "layouts/faq-list.liquid", + "label": "FAQ", + "base": "faq", + "fields": { + "faq": { + "type": "keyvalue", + "label": "Questions and answers", + "help": "Each question with its answer. They are shown on the page and published as FAQ structured data." + } + } + }, + "tool": { + "layout": "layouts/tool.liquid", + "listLayout": "layouts/list.liquid", + "label": "Engineering tool", + "base": "tools", + "fields": { + "calculators": { + "type": "select", + "label": "Calculators", + "choices": ["none", "fasteners"], + "default": "none", + "help": "Shows interactive calculators above the text. \"fasteners\" is mass reduction, tightening torque and thread engagement; the text should give the same formulas, constants and tables, because that is what a visitor without the script sees." + } + } } }, "options": { "accent": { "type": "color", "label": "Accent colour", - "default": "#0e5a6e" + "default": "#b45309" + }, + "tagline": { + "type": "string", + "label": "Tagline, after the site name in the home page title", + "default": "", + "help": "Empty uses the site's own tagline. That one has a single value for every language; this option can be given per language." + }, + "home_description": { + "type": "text", + "label": "Home page description, for search results and link previews", + "default": "", + "help": "Empty uses the tagline." }, "hero_title": { "type": "string", "label": "Home page headline", - "default": "Specified for the application, not just the catalogue." + "default": "Built around your requirements." }, "hero_lede": { "type": "text", "label": "Home page paragraph", - "default": "Browse products by what they are, by where they are used, and by the properties that matter for your project." + "default": "Find a part by specification, or discuss a custom one with our team." + }, + "hero_badge": { + "type": "string", + "label": "Caption on the home page picture", + "default": "" + }, + "prop_1_title": { + "type": "string", + "label": "First strength: title", + "default": "" + }, + "prop_1_text": { + "type": "string", + "label": "First strength: one line", + "default": "" + }, + "prop_2_title": { + "type": "string", + "label": "Second strength: title", + "default": "" + }, + "prop_2_text": { + "type": "string", + "label": "Second strength: one line", + "default": "" + }, + "prop_3_title": { + "type": "string", + "label": "Third strength: title", + "default": "" + }, + "prop_3_text": { + "type": "string", + "label": "Third strength: one line", + "default": "" + }, + "custom_title": { + "type": "string", + "label": "Custom work: headline", + "default": "" + }, + "custom_text": { + "type": "text", + "label": "Custom work: paragraph", + "default": "" + }, + "quality_1_title": { + "type": "string", + "label": "First assurance: title", + "default": "" + }, + "quality_1_text": { + "type": "text", + "label": "First assurance: text", + "default": "" + }, + "quality_2_title": { + "type": "string", + "label": "Second assurance: title", + "default": "" + }, + "quality_2_text": { + "type": "text", + "label": "Second assurance: text", + "default": "" + }, + "quality_3_title": { + "type": "string", + "label": "Third assurance: title", + "default": "" + }, + "quality_3_text": { + "type": "text", + "label": "Third assurance: text", + "default": "" + }, + "cta_title": { + "type": "string", + "label": "Closing banner: headline", + "default": "" + }, + "cta_text": { + "type": "string", + "label": "Closing banner: one line", + "default": "" + }, + "footer_blurb": { + "type": "text", + "label": "Footer: what the company does", + "default": "" + }, + "footer_note": { + "type": "string", + "label": "Footer: a line under it, for example certifications held", + "default": "" + }, + "contact_email": { + "type": "string", + "label": "Footer: email address", + "default": "" + }, + "contact_phone": { + "type": "string", + "label": "Footer: telephone number", + "default": "" + }, + "quote_href": { + "type": "string", + "label": "Link for the request-a-quote buttons", + "default": "/contact" }, "contact_href": { "type": "string", - "label": "Link for the request-a-quote button", + "label": "Link for the contact buttons", "default": "/contact" + }, + "catalogue_href": { + "type": "string", + "label": "Link to the full catalogue, under the home page finder", + "default": "/products", + "help": "The home page shows the ten newest products. Give this per language, for example /de/products; empty shows no link." + }, + "terms_href": { + "type": "string", + "label": "Footer: link to the terms", + "default": "" + }, + "privacy_href": { + "type": "string", + "label": "Footer: link to the privacy policy", + "default": "" + }, + "compliance_href": { + "type": "string", + "label": "Footer: link to the compliance statement", + "default": "" } }, "locales": ["en", "de", "fr", "es"], "defaultLocale": "en", "imageWidths": [480, 960, 1440], - "clientScripts": [] + "clientScripts": [ + { + "path": "assets/finder.js", + "purpose": "Home page and catalogue only: filters and a search box above the specification table. The table is complete without it.", + "bytes": 5315 + }, + { + "path": "assets/calculators.js", + "purpose": "Engineering reference pages that ask for it only: three fastener calculators above a page that prints the same formulas, constants and tables of results.", + "bytes": 9426 + } + ] } diff --git a/test/content.test.ts b/test/content.test.ts index a69e18b..a894894 100644 --- a/test/content.test.ts +++ b/test/content.test.ts @@ -1,5 +1,5 @@ import assert from 'node:assert/strict'; -import { readdir, readFile } from 'node:fs/promises'; +import { access, readdir, readFile } from 'node:fs/promises'; import { join } from 'node:path'; import { describe, it } from 'node:test'; @@ -7,10 +7,12 @@ import { describe, it } from 'node:test'; * Checks on the sample content that only this project can get wrong. * * Mallok resolves a `reference` field by slug **within the same language**, so - * a German application note has to name the German product's slug. Get that + * a German industry page has to name the German product's slug. Get that * wrong and the page still renders — it just quietly loses its link, which is * exactly the kind of mistake nobody notices until the long-tail pages stop - * pointing at each other. + * pointing at each other. The same holds for a link written in a body, for a + * product whose attributes are named differently from its neighbours', and + * for a SKU on a page that no variant in the shop carries. */ const CONTENT = 'content'; @@ -20,23 +22,95 @@ interface Item { readonly bundle: string; readonly locale: string; readonly slug: string; + readonly file: string; readonly fields: ReadonlyMap; + readonly frontmatter: string; + readonly body: string; +} + +interface Site { + readonly defaultLocale: string; + readonly locales: string[]; + readonly kinds: Record; +} + +/** A YAML scalar as written, without the quotes it may be wrapped in. */ +function unquote(value: string): string { + const trimmed = value.trim(); + const quoted = /^"((?:[^"\\]|\\.)*)"$|^'((?:[^']|'')*)'$/.exec(trimmed); + if (quoted === null) { + return trimmed; + } + return quoted[1] !== undefined + ? quoted[1].replace(/\\(.)/g, '$1') + : (quoted[2] ?? '').replace(/''/g, "'"); } /** The scalar front-matter fields of an `index[.].md`. */ -function scalarFields(markdown: string): Map { - const block = /^---\n([\s\S]*?)\n---/.exec(markdown)?.[1] ?? ''; +function scalarFields(frontmatter: string): Map { const fields = new Map(); - for (const line of block.split('\n')) { + for (const line of frontmatter.split('\n')) { // Top-level keys only: nested maps such as `specs` are indented. const match = /^([a-z_]+):\s*(\S.*)$/.exec(line); if (match?.[1] !== undefined && match[2] !== undefined) { - fields.set(match[1], match[2].trim()); + fields.set(match[1], unquote(match[2])); } } return fields; } +/** + * The entries of a nested map such as `facets` or `sizes`, in file order. + * + * A reader for the one shape these files use — a key, then two-space-indented + * `name: value` lines — rather than a YAML parser, so the project's own tests + * need nothing installed. + */ +function mapField(frontmatter: string, name: string): [string, string][] { + const lines = frontmatter.split('\n'); + const start = lines.indexOf(`${name}:`); + const entries: [string, string][] = []; + if (start === -1) { + return entries; + } + for (const line of lines.slice(start + 1)) { + const match = + /^ {2}(?:"((?:[^"\\]|\\.)*)"|'([^']*)'|([^:]+?)):\s+(.*)$/.exec(line); + if (match === null) { + break; + } + const key = match[1] ?? match[2] ?? match[3] ?? ''; + entries.push([key.replace(/\\(.)/g, '$1'), unquote(match[4] ?? '')]); + } + return entries; +} + +/** The image paths a bundle's front matter and body name. */ +function imagePaths(item: Item): string[] { + const paths: string[] = []; + const cover = item.fields.get('cover'); + if (cover !== undefined) { + paths.push(cover); + } + const lines = item.frontmatter.split('\n'); + const gallery = lines.indexOf('gallery:'); + if (gallery !== -1) { + for (const line of lines.slice(gallery + 1)) { + const match = /^ {2}- (.+)$/.exec(line); + if (match?.[1] === undefined) { + break; + } + paths.push(unquote(match[1])); + } + } + for (const match of item.body.matchAll(/!\[[^\]]*\]\(([^)\s]+)/g)) { + if (match[1] !== undefined) { + paths.push(match[1]); + } + } + return paths; +} + async function loadItems(defaultLocale: string): Promise { const items: Item[] = []; const kinds = await readdir(CONTENT, { withFileTypes: true }); @@ -53,16 +127,21 @@ async function loadItems(defaultLocale: string): Promise { if (match === null) { continue; } - const fields = scalarFields( - await readFile(join(CONTENT, kind.name, bundle.name, file), 'utf8'), - ); + const path = join(CONTENT, kind.name, bundle.name, file); + const markdown = await readFile(path, 'utf8'); + const parts = /^---\n([\s\S]*?)\n---\n?([\s\S]*)$/.exec(markdown); + const frontmatter = parts?.[1] ?? ''; + const fields = scalarFields(frontmatter); items.push({ kind: kind.name, bundle: bundle.name, locale: match[1] ?? defaultLocale, // The default language's slug defaults to the bundle's own name. slug: fields.get('slug') ?? bundle.name, + file: path, fields, + frontmatter, + body: parts?.[2] ?? '', }); } } @@ -70,14 +149,21 @@ async function loadItems(defaultLocale: string): Promise { return items; } -async function readSite(): Promise<{ - defaultLocale: string; - locales: string[]; - kinds: Record; -}> { +async function readSite(): Promise { return JSON.parse(await readFile('site.json', 'utf8')); } +/** Where a language's pages start: nothing for the default, `/de` for German. */ +function prefixOf(site: Site, locale: string): string { + return locale === site.defaultLocale ? '' : `/${locale}`; +} + +/** The public path Mallok gives an item. */ +function pathOf(site: Site, item: Item): string { + const base = site.kinds[item.kind]?.base ?? ''; + return `${prefixOf(site, item.locale)}${base === '' ? '' : `/${base}`}/${item.slug}`; +} + describe('sample content', () => { it('uses only kinds and languages the site declares', async () => { const site = await readSite(); @@ -96,6 +182,28 @@ describe('sample content', () => { } }); + it('carries every bundle in every language of the site', async () => { + // The sample is what a visitor of the demo switches languages on: a + // bundle missing one would drop out of that language's lists and leave + // its other versions without that hreflang. + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + const bundles = new Set(items.map((item) => `${item.kind}/${item.bundle}`)); + + for (const bundle of bundles) { + for (const locale of site.locales) { + assert.ok( + items.some( + (item) => + `${item.kind}/${item.bundle}` === bundle && + item.locale === locale, + ), + `content/${bundle} has no "${locale}" version`, + ); + } + } + }); + it('gives every translation its own slug within its kind and language', async () => { const site = await readSite(); const items = await loadItems(site.defaultLocale); @@ -105,6 +213,11 @@ describe('sample content', () => { const key = `${item.kind}/${item.locale}/${item.slug}`; assert.ok(!seen.has(key), `Two items share ${key}`); seen.add(key); + if (item.locale !== site.defaultLocale) { + // Without its own `slug` a translation would take the bundle's name + // and collide with nothing, but answer at an English address. + assert.ok(item.fields.has('slug'), `${item.file} declares no slug`); + } } }); @@ -113,11 +226,29 @@ describe('sample content', () => { const items = await loadItems(site.defaultLocale); // The reference fields the commerce theme declares, and the kind each - // points at (src/theme/theme.json). - const references: Record> = { - application: { product: 'product' }, - product: { collection: 'collection' }, + // points at, read from the theme itself: a copy kept here would stay + // behind the first time a kind gained a reference. + const theme = JSON.parse( + await readFile(join('src', 'theme', 'theme.json'), 'utf8'), + ) as { + kinds: Record< + string, + { fields?: Record } + >; }; + const references: Record> = {}; + for (const [kind, definition] of Object.entries(theme.kinds)) { + for (const [field, declared] of Object.entries(definition.fields ?? {})) { + if (declared.type === 'reference' && declared.kind !== undefined) { + references[kind] = { ...references[kind], [field]: declared.kind }; + } + } + } + assert.deepEqual(Object.keys(references).sort(), [ + 'application', + 'case', + 'product', + ]); let checked = 0; for (const item of items) { @@ -143,7 +274,7 @@ describe('sample content', () => { assert.ok(checked > 0); }); - it('gives every application note a product', async () => { + it('gives every industry page a product', async () => { const site = await readSite(); const items = await loadItems(site.defaultLocale); @@ -154,46 +285,243 @@ describe('sample content', () => { ); } }); + + it('links, in every body, only to pages that exist in that language', async () => { + // A link in Markdown is plain text to Mallok: nothing rewrites it for the + // language and nothing reports it when its target is renamed. + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + + const pages = new Map>(); + for (const locale of site.locales) { + const prefix = prefixOf(site, locale); + const known = new Set([prefix === '' ? '/' : prefix, `${prefix}/`]); + for (const kind of Object.values(site.kinds)) { + if (kind.base !== '') { + known.add(`${prefix}/${kind.base}`); + } + } + pages.set(locale, known); + } + for (const item of items) { + pages.get(item.locale)?.add(pathOf(site, item)); + } + + let checked = 0; + for (const item of items) { + for (const match of item.body.matchAll( + /(? 0); + }); + + it('is what the navigation and the buttons in site.json point at', async () => { + // The header, the footer and every call to action take their addresses + // from `site.json`. A page renamed here and not there is a dead link on + // every page of that language. + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + const settings = JSON.parse(await readFile('site.json', 'utf8')) as { + nav: Record; + themeOptions: Record & { + $locales?: Record>; + }; + }; + + let checked = 0; + for (const locale of site.locales) { + const prefix = prefixOf(site, locale); + const known = new Set([prefix === '' ? '/' : prefix, `${prefix}/`]); + for (const kind of Object.values(site.kinds)) { + if (kind.base !== '') { + known.add(`${prefix}/${kind.base}`); + } + } + for (const item of items.filter((entry) => entry.locale === locale)) { + known.add(pathOf(site, item)); + } + + const options = + locale === site.defaultLocale + ? settings.themeOptions + : (settings.themeOptions.$locales?.[locale] ?? {}); + const links = [ + ...(settings.nav[locale] ?? []).map((entry) => entry.href), + ...Object.entries(options) + .filter(([name]) => name.endsWith('_href')) + .map(([, href]) => String(href)), + ]; + for (const href of links) { + assert.ok( + known.has(href.replace(/[#?].*$/, '')), + `site.json sends "${locale}" to ${href}, which is not a page in that language`, + ); + checked += 1; + } + } + assert.ok(checked > 0); + }); + + it('keeps every image a bundle names inside that bundle', async () => { + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + + let checked = 0; + for (const item of items) { + for (const path of imagePaths(item)) { + assert.ok( + !/^[a-z]+:/i.test(path) && !path.startsWith('/'), + `${item.file} names ${path}; an image is a path inside the bundle`, + ); + await assert.doesNotReject( + access(join(CONTENT, item.kind, item.bundle, path)), + `${item.file} names ${path}, which is not in the bundle`, + ); + checked += 1; + } + } + assert.ok(checked > 0); + }); +}); + +describe('sample products', () => { + it('name the same attributes, in the same order, within a language', async () => { + // The attribute names of the first product are the columns of the + // specification finder, and what its filters are built from. + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + + for (const locale of site.locales) { + const products = items.filter( + (item) => item.kind === 'product' && item.locale === locale, + ); + const expected = mapField(products[0]?.frontmatter ?? '', 'facets').map( + ([name]) => name, + ); + assert.ok(expected.length > 0, `no product attributes in "${locale}"`); + for (const product of products) { + assert.deepEqual( + mapField(product.frontmatter, 'facets').map(([name]) => name), + expected, + `${product.file} names different attributes from ${products[0]?.file}`, + ); + } + } + }); + + it('offer the same sizes under the same SKUs in every language', async () => { + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + const products = items.filter((item) => item.kind === 'product'); + + for (const source of products.filter( + (item) => item.locale === site.defaultLocale, + )) { + const sizes = mapField(source.frontmatter, 'sizes'); + assert.ok(sizes.length > 0, `${source.file} offers no size`); + for (const version of products.filter( + (item) => item.bundle === source.bundle, + )) { + assert.deepEqual( + mapField(version.frontmatter, 'sizes'), + sizes, + `${version.file} lists different sizes from ${source.file}`, + ); + } + } + }); }); describe('seed/shop-sample.sql', () => { - it('attaches its variants to a product bundle that exists', async () => { + /** product_group to the SKUs of its variants, as the seed inserts them. */ + async function seededVariants(): Promise> { const sql = await readFile(join('seed', 'shop-sample.sql'), 'utf8'); - const groups = new Set( - [...sql.matchAll(/'([0-9a-f]{8}-[0-9a-f-]{27})'/g)].map( - (match) => match[1], - ), - ); - assert.ok(groups.size > 0); + const variants = new Map(); + for (const match of sql.matchAll( + /\('[^']+',\s*'([0-9a-f]{8}-[0-9a-f-]{27})',\s*'([^']+)'/g, + )) { + const group = match[1] ?? ''; + variants.set(group, [...(variants.get(group) ?? []), match[2] ?? '']); + } + return variants; + } + + async function translationGroup(bundle: string): Promise { + try { + const identity = JSON.parse( + await readFile(join(CONTENT, 'product', bundle, 'mallok.json'), 'utf8'), + ) as { translation_group?: string }; + return identity.translation_group ?? null; + } catch { + // A bundle without an identity file gets one assigned on import, so + // nothing in the seed could name it. + return null; + } + } + + it('attaches its variants to a product bundle that exists', async () => { + const variants = await seededVariants(); + assert.ok(variants.size > 0); const products = await readdir(join(CONTENT, 'product'), { withFileTypes: true, }); const known = new Set(); for (const bundle of products.filter((entry) => entry.isDirectory())) { - try { - const identity = JSON.parse( - await readFile( - join(CONTENT, 'product', bundle.name, 'mallok.json'), - 'utf8', - ), - ) as { translation_group?: string }; - if (identity.translation_group !== undefined) { - known.add(identity.translation_group); - } - } catch { - // A bundle without an identity file gets one assigned on import, so - // nothing in the seed could name it. + const group = await translationGroup(bundle.name); + if (group !== null) { + known.add(group); } } - for (const group of groups) { + for (const group of variants.keys()) { assert.ok( - known.has(group ?? ''), + known.has(group), `seed/shop-sample.sql names product_group ${group}, which no product bundle's mallok.json declares`, ); } }); + + it('carries one variant for each SKU a product page lists, and no other', async () => { + // The page prints the SKU a buyer quotes; the shop sells the variant + // that carries it. A size on the page with no variant could never be + // bought, and a variant with no size on the page could never be found. + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + const variants = await seededVariants(); + + const products = items.filter( + (item) => item.kind === 'product' && item.locale === site.defaultLocale, + ); + assert.ok(products.length > 0); + for (const product of products) { + const group = await translationGroup(product.bundle); + assert.ok(group !== null, `${product.file} has no mallok.json`); + assert.deepEqual( + [...(variants.get(group) ?? [])].sort(), + mapField(product.frontmatter, 'sizes') + .map(([sku]) => sku) + .sort(), + `the variants seeded for ${product.bundle} are not the SKUs its page lists`, + ); + } + }); }); /** @@ -201,7 +529,7 @@ describe('seed/shop-sample.sql', () => { * * It is optional: Mallok puts every language of a bundle into one translation * group on its own. A bundle carries one here only when something outside the - * content has to name it — the sample variants attach to the product by its + * content has to name it — the sample variants attach to a product by its * translation group. Where the file exists, it has to agree with the bundle. */ describe('bundle identity', () => { @@ -239,14 +567,10 @@ describe('bundle identity', () => { `content/${item.kind}/${item.bundle}/mallok.json has no entry for "${item.locale}"`, ); assert.equal(entry.slug, item.slug); - assert.ok( - entry.path?.endsWith(`/${item.slug}`), - `${entry.path} does not end in the slug ${item.slug}`, - ); - // The default language is unprefixed, every other one carries its code. assert.equal( - entry.path?.startsWith(`/${item.locale}/`), - item.locale !== site.defaultLocale, + entry.path, + pathOf(site, item), + `content/${item.kind}/${item.bundle}/mallok.json gives "${item.locale}" a path that is not where the page is`, ); assert.ok( entry.id !== undefined && !ids.has(entry.id), @@ -256,4 +580,25 @@ describe('bundle identity', () => { } assert.ok(ids.size > 0); }); + + it('gives every translation group to one bundle only', async () => { + const site = await readSite(); + const items = await loadItems(site.defaultLocale); + const owners = new Map(); + + for (const item of items) { + const group = (await readIdentity(item))?.translation_group; + if (group === undefined) { + continue; + } + const bundle = `${item.kind}/${item.bundle}`; + assert.equal( + owners.get(group) ?? bundle, + bundle, + `the translation group ${group} is claimed by two bundles`, + ); + owners.set(group, bundle); + } + assert.ok(owners.size > 0); + }); }); diff --git a/test/project.test.ts b/test/project.test.ts index b1212a7..f1deb33 100644 --- a/test/project.test.ts +++ b/test/project.test.ts @@ -1,5 +1,5 @@ import assert from 'node:assert/strict'; -import { readdir, readFile } from 'node:fs/promises'; +import { readdir, readFile, stat } from 'node:fs/promises'; import { join } from 'node:path'; import { describe, it } from 'node:test'; @@ -71,6 +71,252 @@ describe('site.json', () => { }); }); +/** + * `site.json` carries this site's own copy: the navigation and the theme's + * options. Mallok renders whatever is there, so a language that was left out + * shows English on its most important page and nothing reports it. + */ +describe('site.json, in every language', () => { + interface Settings { + defaultLocale: string; + locales: string[]; + nav: Record; + themeOptions: Record & { + $locales?: Record>; + }; + } + + /** The option types that hold words or links rather than a setting. */ + const WRITTEN = new Set(['string', 'text']); + // The same in every language: an address, a number, a material grade. + const LANGUAGE_INDEPENDENT = new Set([ + 'contact_email', + 'contact_phone', + 'hero_badge', + ]); + + async function readSettings(): Promise { + return JSON.parse(await readFile('site.json', 'utf8')) as Settings; + } + + async function writtenOptions(): Promise { + const theme = JSON.parse( + await readFile(join('src', 'theme', 'theme.json'), 'utf8'), + ) as { options: Record }; + return Object.keys(theme.options).filter( + (name) => + WRITTEN.has(theme.options[name]?.type ?? '') && + !LANGUAGE_INDEPENDENT.has(name), + ); + } + + it('sets only options the theme declares', async () => { + const site = await readSettings(); + const theme = JSON.parse( + await readFile(join('src', 'theme', 'theme.json'), 'utf8'), + ) as { options: Record }; + + const sets = [ + site.themeOptions, + ...Object.values(site.themeOptions.$locales ?? {}), + ]; + for (const options of sets) { + for (const name of Object.keys(options)) { + assert.ok( + name === '$locales' || Object.hasOwn(theme.options, name), + `site.json sets the theme option "${name}", which the theme does not have`, + ); + } + } + }); + + it('gives each language its own words for every written option', async () => { + const site = await readSettings(); + const names = await writtenOptions(); + const others = site.locales.filter( + (locale) => locale !== site.defaultLocale, + ); + assert.ok(others.length > 0); + + let checked = 0; + for (const name of names) { + const original = site.themeOptions[name]; + for (const locale of others) { + const own = site.themeOptions.$locales?.[locale]?.[name]; + if (name === 'tagline') { + // The default language falls back to the site's own tagline; the + // others have nothing to fall back to in their language. + assert.ok(own, `site.json has no "${locale}" tagline`); + continue; + } + if (typeof original !== 'string' || original === '') { + continue; + } + assert.ok( + typeof own === 'string' && own !== '', + `site.json sets ${name} but gives "${locale}" no value for it`, + ); + assert.notEqual( + own, + original, + `site.json gives "${locale}" the default language's ${name}`, + ); + checked += 1; + } + } + assert.ok(checked > 0); + }); + + it('keeps each language’s links inside that language', async () => { + const site = await readSettings(); + + for (const locale of site.locales) { + const prefix = locale === site.defaultLocale ? '/' : `/${locale}/`; + const options = + locale === site.defaultLocale + ? site.themeOptions + : (site.themeOptions.$locales?.[locale] ?? {}); + const links = [ + ...(site.nav[locale] ?? []).map((item) => item.href), + ...Object.entries(options) + .filter(([name]) => name.endsWith('_href')) + .map(([, href]) => String(href)), + ]; + assert.ok(links.length > 0, `site.json has no links for "${locale}"`); + for (const href of links) { + assert.ok( + href.startsWith(prefix), + `site.json sends "${locale}" to ${href}`, + ); + if (locale === site.defaultLocale) { + assert.ok( + !site.locales.some( + (other) => + other !== locale && + (href === `/${other}` || href.startsWith(`/${other}/`)), + ), + `site.json sends the default language to ${href}`, + ); + } + } + } + }); + + it('offers the same navigation in every language', async () => { + const site = await readSettings(); + const expected = site.nav[site.defaultLocale]?.length ?? 0; + + assert.ok(expected > 0); + for (const locale of site.locales) { + assert.equal( + site.nav[locale]?.length, + expected, + `site.json gives "${locale}" a different number of navigation items`, + ); + for (const item of site.nav[locale] ?? []) { + assert.ok( + item.label.trim() !== '', + `site.json has a navigation item without a label in "${locale}"`, + ); + } + } + }); +}); + +/** + * What the theme runs in a visitor's browser is the list in `theme.json`, + * which Mallok shows the site's owner. The list is only worth showing if it + * is the whole truth: every script a template loads is on it, at the size it + * says, and nothing on it is dead weight. + */ +describe('the theme’s client scripts', () => { + const THEME = join('src', 'theme'); + + interface Declared { + path: string; + purpose: string; + bytes?: number; + } + + async function declared(): Promise { + const theme = JSON.parse( + await readFile(join(THEME, 'theme.json'), 'utf8'), + ) as { clientScripts: Declared[] }; + return theme.clientScripts; + } + + /** Every `