Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorLeitwolf2026-11-16 14:49:23 +0300
committerGitHub2026-11-16 14:49:23 +0300
commit324048967d1fb198e3489b1722ca1ff317338550 (patch)
treee270ad6dc86200cc79cbdccfa1ef6de1da8aff0d
parent45c1bb14326cbee8fe57c6f639550e8eadd81f0a (diff)
parent4ee77681379619b3fab7b8b33446a67164216cc8 (diff)
downloadtazel.net-324048967d1fb198e3489b1722ca1ff317338550.tar.gz
Merge pull request #10 from Progmasoft/content/new-tazelHEADmain
Rewrite the site for the Tazel of C, C++, Objective-C, Objective-C++ and Zig
-rw-r--r--.codacy.yml7
-rw-r--r--README.md33
-rw-r--r--app/assets/site.css10
-rw-r--r--app/components/DocsTree.vue4
-rw-r--r--app/components/ProseText.vue2
-rw-r--r--app/components/SiteFooter.vue4
-rw-r--r--app/components/SiteHeader.vue2
-rw-r--r--app/composables/useDocs.ts2
-rw-r--r--app/composables/useSiteLocale.ts7
-rw-r--r--app/content/chrome.ts80
-rw-r--r--app/content/home.ts269
-rw-r--r--app/content/locales.ts11
-rw-r--r--app/content/site.ts21
-rw-r--r--app/pages/[[locale]]/docs/[...slug].vue4
-rw-r--r--app/pages/[[locale]]/index.vue26
-rw-r--r--content.config.ts2
-rw-r--r--content/de-DE/docs/1.getting-started/1.installation.md52
-rw-r--r--content/de-DE/docs/1.getting-started/2.first-project.md166
-rw-r--r--content/de-DE/docs/1.getting-started/3.releases.md38
-rw-r--r--content/de-DE/docs/2.reference/1.commands.md119
-rw-r--r--content/de-DE/docs/2.reference/2.module-file.md112
-rw-r--r--content/de-DE/docs/2.reference/3.build-file.md143
-rw-r--r--content/de-DE/docs/3.extending/1.plugins.md87
-rw-r--r--content/de-DE/docs/4.internals/1.architecture.md52
-rw-r--r--content/en-US/docs/1.getting-started/1.installation.md51
-rw-r--r--content/en-US/docs/1.getting-started/2.first-project.md166
-rw-r--r--content/en-US/docs/1.getting-started/3.releases.md35
-rw-r--r--content/en-US/docs/2.reference/1.commands.md548
-rw-r--r--content/en-US/docs/2.reference/2.module-file.md111
-rw-r--r--content/en-US/docs/2.reference/2.project-file.md380
-rw-r--r--content/en-US/docs/2.reference/3.build-file.md143
-rw-r--r--content/en-US/docs/2.reference/3.lockfile.md98
-rw-r--r--content/en-US/docs/3.extending/1.plugins.md315
-rw-r--r--content/en-US/docs/4.internals/1.architecture.md179
-rw-r--r--content/fr-FR/docs/1.getting-started/1.installation.md51
-rw-r--r--content/fr-FR/docs/1.getting-started/2.first-project.md161
-rw-r--r--content/fr-FR/docs/1.getting-started/3.releases.md32
-rw-r--r--content/fr-FR/docs/2.reference/1.commands.md121
-rw-r--r--content/fr-FR/docs/2.reference/2.module-file.md112
-rw-r--r--content/fr-FR/docs/2.reference/3.build-file.md143
-rw-r--r--content/fr-FR/docs/3.extending/1.plugins.md87
-rw-r--r--content/fr-FR/docs/4.internals/1.architecture.md52
-rw-r--r--content/he-IL/docs/1.getting-started/1.installation.md42
-rw-r--r--content/he-IL/docs/1.getting-started/2.first-project.md59
-rw-r--r--content/he-IL/docs/1.getting-started/3.releases.md29
-rw-r--r--content/ru-RU/docs/1.getting-started/1.installation.md51
-rw-r--r--content/ru-RU/docs/1.getting-started/2.first-project.md165
-rw-r--r--content/ru-RU/docs/1.getting-started/3.releases.md35
-rw-r--r--content/ru-RU/docs/2.reference/1.commands.md119
-rw-r--r--content/ru-RU/docs/2.reference/2.module-file.md110
-rw-r--r--content/ru-RU/docs/2.reference/3.build-file.md143
-rw-r--r--content/ru-RU/docs/3.extending/1.plugins.md86
-rw-r--r--content/ru-RU/docs/4.internals/1.architecture.md50
-rw-r--r--grammars/tala.tmLanguage.json372
-rw-r--r--nuxt.config.ts7
-rw-r--r--scripts/sync-docs.mjs93
-rw-r--r--tests/locales.test.mjs16
-rw-r--r--tests/translations.test.mjs39
58 files changed, 3006 insertions, 2448 deletions
diff --git a/.codacy.yml b/.codacy.yml
index fc55949..9203885 100644
--- a/.codacy.yml
+++ b/.codacy.yml
@@ -1,14 +1,9 @@
# SPDX-FileCopyrightText: 2026 Progmasoft <[email protected]>
# SPDX-License-Identifier: AGPL-3.0-or-later
-# The reference under content/en-US/docs is copied from Progmasoft/tazel and
-# the Tala grammar from Progmasoft/tala; both are reviewed where they live.
+# Generated and installed files only; everything written here is analysed.
exclude_paths:
- "node_modules/**"
- ".nuxt/**"
- ".output/**"
- "coverage/**"
- - "content/en-US/docs/2.reference/**"
- - "content/en-US/docs/3.extending/**"
- - "content/en-US/docs/4.internals/**"
- - "grammars/**"
diff --git a/README.md b/README.md
index 43bed24..17d73ca 100644
--- a/README.md
+++ b/README.md
@@ -3,38 +3,31 @@
# tazel.net
-The site of [Tazel](https://github.com/Progmasoft/tazel), the build system and package manager of Tala, at
-[tazel.net](https://tazel.net/). It is a Nuxt site generated to static files, in English, German, Russian and Hebrew.
+The site of [Tazel](https://github.com/Progmasoft/tazel), the build system for C, C++, Objective-C, Objective-C++ and
+Zig, at [tazel.net](https://tazel.net/). It is a Nuxt site generated to static files, in English, German, Russian and
+French.
```bash
npm ci
npm run dev # http://localhost:3000
npm run generate # .output/public, every page in every language
npm run check # types
-npm test # the language helpers
+npm test # the language helpers and the translations
npm run format:check
```
## Content
-| Where | What |
-| ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `app/content/` | the words of the pages that are not documents: the frame, the home page, the site constants |
-| `content/<locale>/docs/` | the documentation as Markdown, one folder per language; the numbers order the tree |
-| `grammars/tala.tmLanguage.json` | the grammar that highlights Tala, from the [compiler repository](https://github.com/Progmasoft/tala/tree/main/Grammar) |
+| Where | What |
+| ------------------------ | ------------------------------------------------------------------------------------------- |
+| `app/content/` | the words of the pages that are not documents: the frame, the home page, the site constants |
+| `content/<locale>/docs/` | the documentation as Markdown, one folder per language; the numbers order the tree |
-The reference, under `content/en-US/docs/2.reference`, `3.extending` and `4.internals`, is copied from the
-`Documents/` of Tazel and is not edited here:
-
-```bash
-node scripts/sync-docs.mjs ../tazel
-```
-
-A page a language lacks is shown in English, with a note that says so. A release of Tazel changes
-`latestRelease` in `app/content/site.ts`.
+Every page exists in every language; `tests/translations.test.mjs` fails when one is missing. The documents describe
+what Tazel on its `main` branch does, and its examples are run with it. A release of Tazel changes `nextRelease` and
+`releaseNotes` in `app/content/site.ts`.
## Licence
-The code of the site is under AGPL-3.0-or-later with the Progmasoft Patent Grant 1.1; see [LICENSE.txt](LICENSE.txt),
-[PATENTS.md](PATENTS.md) and [NOTICE.txt](NOTICE.txt). The documents copied from Tazel and the Tala grammar keep their own
-licence, MPL-2.0 with the Progmasoft Exception 2.0, written at the top of each file or in the repository they come from.
+The code of the site is under AGPL-3.0-or-later; see [LICENSE.txt](LICENSE.txt) and [NOTICE.txt](NOTICE.txt).
+Progmasoft's own code is also covered by the [Progmasoft Patent Grant 1.1](PATENTS.md).
diff --git a/app/assets/site.css b/app/assets/site.css
index 2ae7ae3..9594370 100644
--- a/app/assets/site.css
+++ b/app/assets/site.css
@@ -239,7 +239,7 @@ pre {
line-height: 1.65;
}
-@media (max-width: 720px) {
+@media (width <= 720px) {
.section {
padding-block: 60px;
}
@@ -324,6 +324,14 @@ pre {
white-space: normal;
}
+/* On a phone a path can be wider than the column: there code breaks where it must. */
+@media (width <= 600px) {
+ .prose :not(pre) > code {
+ white-space: normal;
+ overflow-wrap: anywhere;
+ }
+}
+
.prose pre code {
white-space: pre;
}
diff --git a/app/components/DocsTree.vue b/app/components/DocsTree.vue
index 32d0312..83c02a9 100644
--- a/app/components/DocsTree.vue
+++ b/app/components/DocsTree.vue
@@ -77,10 +77,6 @@ summary svg {
transition: transform 0.15s;
}
-:root[dir="rtl"] summary svg {
- transform: scaleX(-1);
-}
-
details[open] > summary svg {
transform: rotate(90deg);
}
diff --git a/app/components/ProseText.vue b/app/components/ProseText.vue
index 1a58f93..51f8bfb 100644
--- a/app/components/ProseText.vue
+++ b/app/components/ProseText.vue
@@ -8,7 +8,7 @@
<script setup lang="ts">
const props = defineProps<{ text: string }>();
-// A flag starts a word: the dash of "Build-System" or of the Hebrew "ב-Kotlin" is not one.
+// A flag starts a word: the dash of "Build-System" is not one.
const flag = /((?<![\p{L}\p{N}_-])--?[A-Za-z][\w-]*|(?<![\p{L}\p{N}_-])--(?=[\s.,;:)]|$))/u;
const parts = computed(() =>
props.text
diff --git a/app/components/SiteFooter.vue b/app/components/SiteFooter.vue
index 8d67c11..24986d6 100644
--- a/app/components/SiteFooter.vue
+++ b/app/components/SiteFooter.vue
@@ -19,8 +19,6 @@ const words = computed(() => chrome[locale.value]);
<nav :aria-label="words.footer.family">
<h2>{{ words.footer.family }}</h2>
<ul>
- <li><a :href="family.tala">Tala</a></li>
- <li><a :href="family.talac">Talac</a></li>
<li><a :href="family.viget">ViGet</a></li>
</ul>
</nav>
@@ -102,7 +100,7 @@ a:hover {
margin: 0;
}
-@media (max-width: 760px) {
+@media (width <= 760px) {
.grid {
grid-template-columns: 1fr 1fr;
}
diff --git a/app/components/SiteHeader.vue b/app/components/SiteHeader.vue
index 304f74b..924af82 100644
--- a/app/components/SiteHeader.vue
+++ b/app/components/SiteHeader.vue
@@ -201,7 +201,7 @@ watch(
font-size: 0.94rem;
}
-@media (max-width: 760px) {
+@media (width <= 760px) {
.links {
display: none;
}
diff --git a/app/composables/useDocs.ts b/app/composables/useDocs.ts
index ac5598b..2167ba9 100644
--- a/app/composables/useDocs.ts
+++ b/app/composables/useDocs.ts
@@ -8,7 +8,7 @@ export const docCollections = {
"en-US": "docs_en",
"de-DE": "docs_de",
"ru-RU": "docs_ru",
- "he-IL": "docs_he",
+ "fr-FR": "docs_fr",
} as const satisfies Record<Locale, string>;
/** A group of the documentation tree and the pages in it, in their order. */
diff --git a/app/composables/useSiteLocale.ts b/app/composables/useSiteLocale.ts
index 1596751..45e3885 100644
--- a/app/composables/useSiteLocale.ts
+++ b/app/composables/useSiteLocale.ts
@@ -7,7 +7,6 @@ import {
localePath,
locales,
pageOfPath,
- textDirection,
type Locale,
} from "~/content/locales";
import { siteUrl } from "~/content/site";
@@ -25,14 +24,14 @@ export function useSiteLocale() {
}
/**
- * The head of a page: its title and description, the language and direction of the document,
- * and the address of the page in every language.
+ * The head of a page: its title and description, the language of the document, which runs left
+ * to right in every language of the site, and the address of the page in every language.
*/
export function usePageHead(text: () => { title: string; description: string }) {
const { locale, page } = useSiteLocale();
const url = (target: Locale) => `${siteUrl}${localePath(target, page.value)}`;
useHead(() => ({
- htmlAttrs: { lang: locale.value, dir: textDirection(locale.value) },
+ htmlAttrs: { lang: locale.value, dir: "ltr" },
link: [
{ rel: "canonical", href: url(locale.value) },
...locales.map((target) => ({
diff --git a/app/content/chrome.ts b/app/content/chrome.ts
index 1e07d54..6bae086 100644
--- a/app/content/chrome.ts
+++ b/app/content/chrome.ts
@@ -17,10 +17,10 @@ export const chrome: Record<Locale, Chrome> = {
copy: "Copy",
copied: "Copied",
footer: {
- tagline: "The build system and package manager of Tala.",
- family: "Tala",
+ tagline: "The build system for C, C++, Objective-C, Objective-C++ and Zig.",
+ family: "Packages",
company: "Progmasoft",
- license: "Tazel is free software under MPL-2.0 with the Progmasoft Exception 2.0.",
+ license: "Tazel is free software under the MIT license.",
},
docsNav: {
groups: {
@@ -54,10 +54,10 @@ export const chrome: Record<Locale, Chrome> = {
copy: "Kopieren",
copied: "Kopiert",
footer: {
- tagline: "Das Build-System und der Paketmanager von Tala.",
- family: "Tala",
+ tagline: "Das Build-System für C, C++, Objective-C, Objective-C++ und Zig.",
+ family: "Pakete",
company: "Progmasoft",
- license: "Tazel ist freie Software unter MPL-2.0 mit der Progmasoft Exception 2.0.",
+ license: "Tazel ist freie Software unter der MIT-Lizenz.",
},
docsNav: {
groups: {
@@ -80,7 +80,7 @@ export const chrome: Record<Locale, Chrome> = {
},
},
"ru-RU": {
- skip: "Перейти к содержанию",
+ skip: "Перейти к содержимому",
docs: "Документ",
getStarted: "Начать",
source: "Исходный код",
@@ -91,14 +91,14 @@ export const chrome: Record<Locale, Chrome> = {
copy: "Копировать",
copied: "Скопировано",
footer: {
- tagline: "Система сборки и менеджер пакетов Tala.",
- family: "Tala",
+ tagline: "Система сборки для C, C++, Objective-C, Objective-C++ и Zig.",
+ family: "Пакеты",
company: "Progmasoft",
- license: "Tazel — свободное ПО под MPL-2.0 с Progmasoft Exception 2.0.",
+ license: "Tazel — свободное программное обеспечение под лицензией MIT.",
},
docsNav: {
groups: {
- "getting-started": "Начало работы",
+ "getting-started": "Первые шаги",
reference: "Справочник",
extending: "Расширение Tazel",
internals: "Устройство",
@@ -107,50 +107,50 @@ export const chrome: Record<Locale, Chrome> = {
englishOnly: "Эта страница есть только на английском.",
previous: "Назад",
next: "Далее",
- edit: "Изменить страницу на GitHub",
+ edit: "Изменить эту страницу на GitHub",
pages: "Документация",
},
notFound: {
title: "Страница не найдена",
- text: "По этому адресу страницы нет.",
+ text: "По этому адресу нет страницы.",
home: "На главную",
},
},
- "he-IL": {
- skip: "דילוג לתוכן",
- docs: "מסמך",
- getStarted: "מתחילים",
- source: "קוד מקור",
- language: "שפה",
- toDark: "מעבר לערכת הנושא הכהה",
- toLight: "מעבר לערכת הנושא הבהירה",
- menu: "תפריט",
- copy: "העתקה",
- copied: "הועתק",
+ "fr-FR": {
+ skip: "Aller au contenu",
+ docs: "Document",
+ getStarted: "Commencer",
+ source: "Code source",
+ language: "Langue",
+ toDark: "Passer au thème sombre",
+ toLight: "Passer au thème clair",
+ menu: "Menu",
+ copy: "Copier",
+ copied: "Copié",
footer: {
- tagline: "מערכת הבנייה ומנהל החבילות של Tala.",
- family: "Tala",
+ tagline: "Le système de build pour C, C++, Objective-C, Objective-C++ et Zig.",
+ family: "Paquets",
company: "Progmasoft",
- license: "‏Tazel היא תוכנה חופשית תחת MPL-2.0 עם Progmasoft Exception 2.0.",
+ license: "Tazel est un logiciel libre sous licence MIT.",
},
docsNav: {
groups: {
- "getting-started": "צעדים ראשונים",
- reference: "עיון",
- extending: "הרחבת Tazel",
- internals: "מבפנים",
+ "getting-started": "Premiers pas",
+ reference: "Référence",
+ extending: "Étendre Tazel",
+ internals: "Fonctionnement interne",
},
- onThisPage: "בדף הזה",
- englishOnly: "הדף הזה זמין באנגלית בלבד.",
- previous: "הקודם",
- next: "הבא",
- edit: "עריכת הדף ב-GitHub",
- pages: "תיעוד",
+ onThisPage: "Sur cette page",
+ englishOnly: "Cette page n’existe qu’en anglais.",
+ previous: "Précédent",
+ next: "Suivant",
+ edit: "Modifier cette page sur GitHub",
+ pages: "Documentation",
},
notFound: {
- title: "הדף לא נמצא",
- text: "אין דף בכתובת הזאת.",
- home: "לדף הבית",
+ title: "Page introuvable",
+ text: "Il n’y a pas de page à cette adresse.",
+ home: "Vers l’accueil",
},
},
};
diff --git a/app/content/home.ts b/app/content/home.ts
index fc4cb9d..9f592bf 100644
--- a/app/content/home.ts
+++ b/app/content/home.ts
@@ -4,274 +4,273 @@
import type { Locale } from "./locales";
import type { HomeText } from "./types";
-export const projectSample = `project {
- name = "Example"
- version = "0.1.0"
-}
-
-compiler {
- buildMode = BuildMode.RELEASE
- warnings = Warnings.ALL
-}
-
-sources {
- executable {
- entry = "Example.Program"
- }
+export const projectSample = `// app/BUILD.kts
+cpp.bin("greeter") {
+ sources(glob("src/*.cpp"))
+ depends("//core/:core")
+ standard = CppStandard.CPP20
}`;
-export const terminalSample = `$ tazel build
- Compiling Example (Example, 12 sources)
- Finished build in 4.21s
-$ tazel build
- Fresh Example (Example, 12 sources)
- Finished build in 0.31s
-$ tazel run -- --port 8080`;
+// The output of Tazel 0.1.0 in development on the greeter of the first project.
+export const terminalSample = `$ tazel build //app/:greeter
+ Compiling //core/:core src/greet.c
+ Archiving //core/:core
+ Compiling //app/:greeter src/main.cpp
+ Linking //app/:greeter
+ Built 2 target(s) for x86_64-unknown-linux-gnu, debug; 4 command(s) run
+$ tazel build //app/:greeter
+ Built 2 target(s) for x86_64-unknown-linux-gnu, debug; 0 command(s) run
+$ tazel run //app/:greeter -- Ada
+ Built 2 target(s) for x86_64-unknown-linux-gnu, debug; 0 command(s) run
+Hello, Ada!`;
export const home: Record<Locale, HomeText> = {
"en-US": {
- title: "Tazel — The build system of Tala",
+ title: "Tazel — A build system for C, C++, Objective-C, Objective-C++ and Zig",
description:
- "Tazel builds, runs, tests, formats and lints Tala projects from one Kotlin project file, and keeps their dependencies in a lockfile.",
- eyebrow: "The build system of Tala",
- headline: "One project file. One command for each job.",
- lead: "Tazel reads a Kotlin project file, starts Talac, talafmt and talalint for you, and records every dependency in a lockfile. The name joins Tala and Bazel.",
+ "Tazel builds, runs, tests, formats and lints C, C++, Objective-C, Objective-C++ and Zig from project files written in Kotlin.",
+ eyebrow: "C, C++, Objective-C, Objective-C++ and Zig",
+ headline: "Kotlin project files. Builds that redo only what changed.",
+ lead: "Tazel reads a MODULE.kts at the root of a module and a BUILD.kts in each package, calls the compilers it finds, and runs again only the commands whose inputs changed.",
start: "Get started",
commands: "Commands",
- release: "Tazel {version}",
+ release: "Tazel {version} in development",
featuresHeading: "What Tazel does",
featuresLead:
- "One program for the whole life of a Tala project, from the first build to the published package.",
+ "One program for building, running, testing, formatting and linting native code, whatever the language of each target.",
features: [
{
- title: "A project file in Kotlin",
- text: "BUILD.kts is a Kotlin script with a typed DSL, so an editor completes and checks it. Tazel runs it with its own scripting host: a JRE 25 is all a machine needs.",
+ title: "Project files in Kotlin",
+ text: "MODULE.kts and BUILD.kts are Kotlin scripts with a typed DSL, so an editor completes and checks them. A setting a language or a kind of target does not have is a compile error of the project file.",
},
{
- title: "Only what changed",
- text: "A target compiles again only when its sources, its settings or the compiler changed. Everything else is reported as fresh and left alone.",
+ title: "Five languages, one graph",
+ text: "Targets of C, C++, Objective-C, Objective-C++ and Zig are programs, static or shared libraries and tests. Each target has one language; targets meet through depends.",
},
{
- title: "The whole machine",
- text: "Plugin steps, compilations and test suites are units of one graph and run side by side. --jobs, --cpus and --memory set the limits, and --profile writes a trace.",
+ title: "Only what changed",
+ text: "Each compile, archive and link runs again only when its command line, its environment or the content of a file it read changed. Touching a file reruns nothing.",
},
{
- title: "Cache and remote builds",
- text: "Build results go into a cache that a team can share. --remote-executor compiles on a trusted machine that runs tazel remote serve.",
+ title: "For every triple",
+ text: "A target names its LLVM target triples, and its block runs for each triple and build mode. Clang and zig cc build for other machines; --triple picks one.",
},
{
- title: "A lockfile you can read",
- text: "LOCK.sqlite3 records what a project depends on, LOCK.dump writes it as text for review, and tazel lock graph shows who uses what.",
+ title: "Tests as targets",
+ text: "Tests have sizes, timeouts, shards and tags, are retried when flaky, and are not run again while their program, data and arguments are the same.",
},
{
- title: "Plugins in Kotlin",
- text: "A plugin is a JAR, local or from ViGet, that extends the project file. Tazel checks its descriptor and its SHA-256 before it loads it.",
+ title: "Formatting and linting",
+ text: "tazel fmt runs clang-format and zig fmt on the sources of the selected targets; tazel lint writes compile_commands.json and runs clang-tidy.",
},
],
- stepsHeading: "From project file to program",
+ stepsHeading: "From project files to program",
steps: [
{
title: "Describe",
- text: "Name the project and its targets in BUILD.kts. Sources are the .tala files below Sources/.",
+ text: "MODULE.kts names the module; each BUILD.kts names the targets of its package, such as //app/:greeter.",
},
{
title: "Build",
- text: "tazel build starts Talac with the options of the project and writes the program to build/debug or build/release.",
+ text: "tazel build calls Clang, GCC or zig cc and writes the outputs to .tazel/out, by triple and build mode.",
},
{
title: "Run and test",
- text: "tazel run builds one executable and starts it; tazel test builds and runs the test suites.",
+ text: "tazel