+
+
+ + {{ repo.name }} + {%- if repo.featured %} ★{% endif %} +
+ {{ category.emoji }} {{ category.label }} +{{ repo.description }}
+ + {%- if gh_url or repo.homepage %} +
+ {%- if gh_url %}
+ 
{{ page.title | default: site.title }}
+{{ page.description | default: site.description }}
+ {% include nav.html %} +
+ {% include repo-card.html repo=repo %}
+
+{%- endif %}
+
+
+{{ content }}
+
+
+← Retour à la liste des projets
diff --git a/_projects/mp-psi-algorithmique.md b/_projects/mp-psi-algorithmique.md new file mode 100644 index 0000000..27bec9c --- /dev/null +++ b/_projects/mp-psi-algorithmique.md @@ -0,0 +1,18 @@ +--- +# Page détaillée facultative : les métadonnées (lien, badges, tags, date…) +# proviennent de _data/repositories.yml (entrée dont le slug = nom du fichier). +title: "Informatique MP : algorithmique" +description: Cours, notebooks et exercices pour la 2ᵉ année MP. +--- + +## Présentation + +Ressources d'algorithmique pour la seconde année de classes préparatoires (MP) : +cours, notebooks Jupyter et exercices, conçus pour préparer les épreuves +d'informatique des concours. + +## Utilisation + +1. Cloner le dépôt : `git clone https://github.com/Hatatri/MP-PSI-Algorithmique.git` +2. Ouvrir les notebooks avec Jupyter (ou directement sur + [Elprepa](https://elprepa.online)). diff --git a/assets/css/style.scss b/assets/css/style.scss new file mode 100644 index 0000000..ef1d45f --- /dev/null +++ b/assets/css/style.scss @@ -0,0 +1,198 @@ +--- +# Front matter vide obligatoire : Jekyll compile ce fichier en assets/css/style.css +--- + +// Styles du thème Cayman, puis personnalisations du site. +@import "{{ site.theme }}"; + +$accent: #157878; +$accent-dark: #003366; +$muted: #606c71; +$border: #dce6f0; +$surface: #f8fbfd; + +// ------------------------------------------------------------- Accessibilité +.visually-hidden { + position: absolute !important; + width: 1px; height: 1px; + overflow: hidden; + clip: rect(0 0 0 0); + white-space: nowrap; +} + +// ---------------------------------------------------------------- Navigation +.site-nav { + margin-top: 1rem; + .btn { margin-bottom: .5rem; } + .btn-active { + background-color: rgba(255, 255, 255, .3); + border-color: rgba(255, 255, 255, .5); + } +} + +// ------------------------------------------------------------------- Profil +.profile { + display: flex; + align-items: center; + flex-wrap: wrap; + gap: 20px; + margin-bottom: 20px; + img { border-radius: 50%; width: 150px; } + p { margin: 5px 0; color: #555; } +} + +.btn-cv { + display: inline-block; + background: #fff; + color: #004080; + padding: 10px 20px; + border: 2px solid #004080; + border-radius: 20px; + text-decoration: none; + font-weight: bold; + &:hover { background: #004080; color: #fff; text-decoration: none; } +} + +// ------------------------------------------------------------------- Chips +.chip { + display: inline-block; + padding: .1rem .55rem; + border-radius: 999px; + font-size: .8rem; + line-height: 1.6; + background: #eef3f7; + color: $muted; + border: 1px solid transparent; + white-space: nowrap; +} +.chip--category { background: rgba($accent, .1); color: $accent; font-weight: 600; } +.chip--lang { background: #fff4e5; color: #8a4b00; } +.chip--status { background: #fdecea; color: #a12622; } +.chip--filter { + cursor: pointer; + font: inherit; + font-size: .85rem; + border-color: $border; + &:hover { border-color: $accent; } + &.is-active { background: $accent; color: #fff; border-color: $accent; } +} + +// ------------------------------------------------------------- Statistiques +.stats { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(140px, 1fr)); + gap: 1rem; + margin-bottom: 1.5rem; +} +.stat { + display: flex; + flex-direction: column; + align-items: center; + padding: 1rem; + border: 1px solid $border; + border-radius: .5rem; + background: $surface; + text-align: center; +} +.stat__value { font-size: 2rem; font-weight: 700; color: $accent; line-height: 1.2; } +.stat__value--small { font-size: 1rem; padding: .6rem 0; } +.stat__label { color: $muted; font-size: .9rem; } + +.stats-detail { + display: grid; + grid-template-columns: repeat(auto-fit, minmax(260px, 1fr)); + gap: 1.5rem; + h3 { margin-top: 0; } +} +.bars { + list-style: none; + padding: 0; + margin: 0; + li { display: flex; align-items: center; gap: .5rem; margin: .35rem 0; } +} +.bars__label { flex: 0 0 9rem; font-size: .9rem; } +.bars__track { flex: 1; height: .6rem; border-radius: 999px; background: #eef3f7; overflow: hidden; } +.bars__fill { display: block; height: 100%; background: linear-gradient(90deg, $accent, #159957); } +.bars__count { flex: 0 0 2rem; text-align: right; font-weight: 600; } + +// ------------------------------------------------------------------ Filtres +.filters { + margin-bottom: 1.5rem; + input[type="search"] { + width: 100%; + padding: .6rem .8rem; + font: inherit; + border: 1px solid $border; + border-radius: .4rem; + box-sizing: border-box; + } +} +.filters__group { display: flex; flex-wrap: wrap; gap: .4rem; margin-top: .75rem; } +.filters__count, .filters__empty { color: $muted; font-size: .9rem; } + +// --------------------------------------------------------- Cartes de projet +.repo-grid { + display: grid; + grid-template-columns: repeat(auto-fill, minmax(280px, 1fr)); + gap: 1.25rem; +} +.repo-card { + display: flex; + flex-direction: column; + padding: 1.1rem 1.2rem; + border: 1px solid $border; + border-radius: .6rem; + background: #fff; + transition: box-shadow .2s, transform .2s; + scroll-margin-top: 1rem; + &:hover { box-shadow: 0 6px 18px rgba(0, 0, 0, .08); transform: translateY(-2px); } + &:target { outline: 3px solid rgba($accent, .5); } + &[hidden] { display: none; } +} +.repo-card--featured { border-top: 4px solid $accent; } +.repo-card__head { display: flex; justify-content: space-between; align-items: flex-start; gap: .5rem; } +.repo-card__title { margin: 0 0 .5rem; font-size: 1.15rem; color: $accent-dark; } +.repo-featured { color: #e3a008; } +.repo-card__desc { flex: 1; margin-bottom: .75rem; } +.repo-card__badges { display: flex; flex-wrap: wrap; gap: .3rem; margin-bottom: .5rem; img { height: 20px; } } +.repo-card__meta { list-style: none; padding: 0; margin: 0 0 .75rem; display: flex; flex-wrap: wrap; gap: .3rem; } +.repo-card__foot { + display: flex; + flex-wrap: wrap; + justify-content: space-between; + gap: .5rem; + padding-top: .6rem; + border-top: 1px solid $border; + font-size: .85rem; + color: $muted; +} + +.repo-detail { margin-bottom: 2rem; } + +// --------------------------------------------------------------- Chronologie +.timeline { + list-style: none; + padding-left: 1.5rem; + border-left: 3px solid rgba($accent, .3); +} +.timeline__period { position: relative; margin-bottom: 1.5rem; } +.timeline__period::before { + content: ""; + position: absolute; + left: calc(-1.5rem - 8px); + top: .45rem; + width: 13px; height: 13px; + border-radius: 50%; + background: $accent; + border: 3px solid #fff; +} +.timeline__date { margin-top: 0; font-size: 1.2rem; } +.timeline__items { list-style: none; padding: 0; } +.timeline__item { + margin: .6rem 0; + > time { display: inline-block; min-width: 2rem; font-weight: 700; color: $accent; } +} +.timeline__desc { display: block; margin-left: 2rem; color: $muted; font-size: .9rem; } + +// ------------------------------------------------- Liste de projets (accueil) +.featured-list { padding-left: 1.2rem; } diff --git a/assets/favicon.svg b/assets/favicon.svg new file mode 100644 index 0000000..bf9a583 --- /dev/null +++ b/assets/favicon.svg @@ -0,0 +1 @@ + diff --git a/assets/js/projects.js b/assets/js/projects.js new file mode 100644 index 0000000..9ba7349 --- /dev/null +++ b/assets/js/projects.js @@ -0,0 +1,88 @@ +/* + * Filtres de la page /projets/ : recherche plein texte, catégorie et tags. + * Amélioration progressive : sans JavaScript, tous les projets restent visibles. + * Les filtres sont reflétés dans l'URL (?q=…&categorie=…&tag=…) pour être partageables. + */ +(function () { + "use strict"; + + var panel = document.getElementById("filters"); + var grid = document.getElementById("repo-grid"); + if (!panel || !grid) return; + + var cards = Array.prototype.slice.call(grid.querySelectorAll(".repo-card")); + var search = document.getElementById("filter-search"); + var count = document.getElementById("filter-count"); + var empty = document.getElementById("filter-empty"); + var categoryButtons = panel.querySelectorAll("[data-filter-category]"); + var tagButtons = panel.querySelectorAll("[data-filter-tag]"); + + var state = { q: "", category: "", tags: [] }; + + function readUrl() { + var params = new URLSearchParams(window.location.search); + state.q = params.get("q") || ""; + state.category = params.get("categorie") || ""; + state.tags = params.getAll("tag"); + } + + function writeUrl() { + var params = new URLSearchParams(); + if (state.q) params.set("q", state.q); + if (state.category) params.set("categorie", state.category); + state.tags.forEach(function (t) { params.append("tag", t); }); + var query = params.toString(); + window.history.replaceState(null, "", window.location.pathname + (query ? "?" + query : "") + window.location.hash); + } + + function render() { + var q = state.q.trim().toLowerCase(); + var visible = 0; + cards.forEach(function (card) { + var tags = (card.dataset.tags || "").split(" "); + var ok = (!state.category || card.dataset.category === state.category) && + state.tags.every(function (t) { return tags.indexOf(t) !== -1; }) && + (!q || (card.dataset.search || "").indexOf(q) !== -1); + card.hidden = !ok; + if (ok) visible += 1; + }); + count.textContent = visible; + empty.hidden = visible !== 0; + + Array.prototype.forEach.call(categoryButtons, function (b) { + var active = b.dataset.filterCategory === state.category; + b.classList.toggle("is-active", active); + b.setAttribute("aria-pressed", active); + }); + Array.prototype.forEach.call(tagButtons, function (b) { + var active = state.tags.indexOf(b.dataset.filterTag) !== -1; + b.classList.toggle("is-active", active); + b.setAttribute("aria-pressed", active); + }); + writeUrl(); + } + + Array.prototype.forEach.call(categoryButtons, function (b) { + b.addEventListener("click", function () { + state.category = b.dataset.filterCategory; + render(); + }); + }); + Array.prototype.forEach.call(tagButtons, function (b) { + b.addEventListener("click", function () { + var t = b.dataset.filterTag; + var i = state.tags.indexOf(t); + if (i === -1) state.tags.push(t); else state.tags.splice(i, 1); + render(); + }); + }); + search.addEventListener("input", function () { + state.q = search.value; + render(); + }); + + readUrl(); + search.value = state.q; + panel.hidden = false; + render(); +})(); diff --git a/index.md b/index.md index 2bf2abe..fc9f0c1 100644 --- a/index.md +++ b/index.md @@ -1,29 +1,9 @@ - - - +--- +layout: default +---
- 
+ 
@@ -60,10 +40,14 @@
## Projets
-- **[Elprepa](https://elprepa.online)** : plateforme pédagogique des classes préparatoires (cours, séquences, notebooks Python interactifs, rendus, corrections et suivi des élèves).
-- **[Informatique MP : algorithmique](https://github.com/Hatatri/MP-PSI-Algorithmique)** : cours, notebooks et exercices pour la 2ᵉ année MP.
-- **[Mosquée du douar Kariz](https://hatatri.github.io/mosque-ennour/)** : site de collecte de dons pour l’association Al Karama.
-- Tous mes projets publics : [github.com/Hatatri](https://github.com/Hatatri)
+{% assign featured = site.data.repositories | where: "featured", true | sort: "added" | reverse -%}
+{% for repo in featured -%}
+{% assign gh = "https://github.com/" | append: repo.repo -%}
+{% if repo.repo %}{% assign link = repo.homepage | default: repo.url | default: gh %}{% else %}{% assign link = repo.homepage | default: repo.url %}{% endif -%}
+- **[{{ repo.name }}]({{ link }})** : {{ repo.description }}
+{% endfor -%}
+- 👉 **[Voir tous les projets]({{ '/projets/' | relative_url }})** ({{ site.data.repositories | size }} projets, avec statistiques, filtres et [chronologie]({{ '/projets/chronologie/' | relative_url }}))
+- Tous mes dépôts publics : [github.com/Hatatri](https://github.com/Hatatri)
---
@@ -112,13 +96,4 @@
---
-
+
+ {{ site.title | xml_escape }} — nouveaux projets
+ {{ '/projets/' | absolute_url }}
+ Derniers dépôts et projets ajoutés sur {{ site.url | remove: "https://" }}
+ fr-fr
+ {{ site.time | date_to_rfc822 }}
+ {{ last.added | date_to_rfc822 }}
+ {%- for repo in repos limit: 30 %}
+ {%- assign category = site.data.categories | where: "id", repo.category | first %}
+ {%- assign detail = site.projects | where: "slug", repo.slug | first %}
+ {%- if detail %}{% assign link = detail.url | absolute_url %}{% else %}{% assign link = '/projets/' | absolute_url | append: '#' | append: repo.slug %}{% endif %}
+ -
+
{{ repo.name | xml_escape }}
+ {{ link }}
+ {{ site.url }}/projets/{{ repo.slug }}
+ {{ repo.added | date_to_rfc822 }}
+ {{ category.label | xml_escape }}
+ {%- for tag in repo.tags %}
+ {{ tag | xml_escape }}
+ {%- endfor %}
+ {{ repo.description | xml_escape }}{% if repo.repo %} — https://github.com/{{ repo.repo }}{% endif %}
+
+ {%- endfor %}
+
+
diff --git a/projets/index.md b/projets/index.md
new file mode 100644
index 0000000..ef7d7e3
--- /dev/null
+++ b/projets/index.md
@@ -0,0 +1,83 @@
+---
+title: Projets
+description: Dépôts et projets validés — enseignement, recherche, web et outils.
+permalink: /projets/
+---
+{%- assign repos = site.data.repositories | sort: "added" | reverse -%}
+{%- assign total = repos | size -%}
+{%- assign languages = repos | where_exp: "r", "r.language" | group_by: "language" | sort: "size" | reverse -%}
+{%- assign categories = repos | group_by: "category" | sort: "size" | reverse -%}
+{%- assign last = repos | first -%}
+
+## En chiffres
+
+
+
📍 Rabat, Maroc | ✉️ hichamatatri@gmail.com
- - 📄 Télécharger le CV (PDF) - -
---- - - -© Hicham ATATRI + diff --git a/projets/chronologie.md b/projets/chronologie.md new file mode 100644 index 0000000..2bcb22b --- /dev/null +++ b/projets/chronologie.md @@ -0,0 +1,29 @@ +--- +title: Chronologie des projets +description: Les projets ajoutés au site, du plus récent au plus ancien. +permalink: /projets/chronologie/ +--- +{%- assign mois = "janvier,février,mars,avril,mai,juin,juillet,août,septembre,octobre,novembre,décembre" | split: "," -%} +{%- assign repos = site.data.repositories | sort: "added" | reverse -%} +{%- assign by_month = repos | group_by_exp: "r", "r.added | date: '%Y-%m'" %} + +-
+{%- for group in by_month %}
+ {%- assign first = group.items | first %}
+ {%- assign m = first.added | date: "%-m" | minus: 1 %}
+
-
+
+
-
+ {%- for repo in group.items %}
+ {%- assign category = site.data.categories | where: "id", repo.category | first %}
+
- + + {{ repo.name }} + {{ category.emoji }} {{ category.label }} + {{ repo.description }} + + {%- endfor %} +
+{%- endfor %}
+
+
+
+{{ total }}projets
+ {{ languages | size }}langages
+ {{ categories | size }}catégories
+ {% include date-fr.html date=last.added %}dernier ajout
+
+
+
+
+
+
+
+## Tous les projets
+
+{%- assign all_tags = "" | split: "" -%}
+{%- for r in repos -%}{%- assign all_tags = all_tags | concat: r.tags -%}{%- endfor -%}
+{%- assign all_tags = all_tags | compact | uniq | sort %}
+
+Langages
+ +Catégories
+ +
+
+
+
+
+
+
+ {%- for cat in site.data.categories %}
+ {%- assign n = repos | where: "category", cat.id | size %}
+ {%- if n > 0 %}
+
+ {%- endif %}
+ {%- endfor %}
+
+
+ {%- for tag in all_tags %}
+
+ {%- endfor %}
+
+ {{ total }} projet(s) affiché(s)
+
+{%- for repo in repos %}
+ {% include repo-card.html repo=repo %}
+{%- endfor %}
+
+
+Aucun projet ne correspond à ces critères.
+ +--- + +💡 Un dépôt à proposer ? [Remplir le formulaire de proposition]({{ site.proposal_url }}) · +📰 [S'abonner au flux RSS]({{ '/projets/feed.xml' | relative_url }}) · +🗓️ [Voir la chronologie]({{ '/projets/chronologie/' | relative_url }}) + + diff --git a/scripts/add_repository.py b/scripts/add_repository.py new file mode 100644 index 0000000..6265ffd --- /dev/null +++ b/scripts/add_repository.py @@ -0,0 +1,191 @@ +#!/usr/bin/env python3 +"""Ajoute un dépôt GitHub validé dans _data/repositories.yml. + +Les métadonnées (nom, description, langage, site web, topics) sont lues via +l'API GitHub ; les valeurs passées en option sont prioritaires. + +Exemples : + python3 scripts/add_repository.py Hatatri/mon-depot --category enseignement --tags python,cpge + python3 scripts/add_repository.py Hatatri/mon-depot --category recherche --featured --dry-run + python3 scripts/add_repository.py --from-issue corps_issue.md # utilisé par la CI + +Variable d'environnement facultative : GITHUB_TOKEN (évite la limite de 60 requêtes/h). +Si GITHUB_OUTPUT est défini (GitHub Actions), le script y écrit slug=… et name=…. +""" + +from __future__ import annotations + +import argparse +import datetime as dt +import json +import os +import re +import sys +import urllib.error +import urllib.request +from pathlib import Path + +import yaml + +ROOT = Path(__file__).resolve().parent.parent +DATA_FILE = ROOT / "_data" / "repositories.yml" +CATEGORIES_FILE = ROOT / "_data" / "categories.yml" +REPO_RE = re.compile(r"^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})/[A-Za-z0-9._-]{1,100}$") +TAG_RE = re.compile(r"^[a-z0-9][a-z0-9+#.-]*$") + + +def fail(message: str) -> None: + print(f"::error::{message}" if os.environ.get("GITHUB_ACTIONS") else f"ERREUR — {message}") + sys.exit(1) + + +def slugify(text: str) -> str: + return re.sub(r"[^a-z0-9]+", "-", text.lower()).strip("-") + + +def parse_issue_form(body: str) -> dict[str, str]: + """Extrait les champs d'une issue créée avec .github/ISSUE_TEMPLATE/nouveau-projet.yml. + + Le formulaire est rendu en Markdown sous la forme « ### Libellé\\n\\nvaleur ». + """ + fields: dict[str, str] = {} + for block in re.split(r"^###\s+", body, flags=re.MULTILINE)[1:]: + title, _, value = block.partition("\n") + value = value.strip() + fields[title.strip().lower()] = "" if value == "_No response_" else value + mapping = { + "dépôt github": "repo", + "catégorie": "category", + "tags": "tags", + "nom affiché": "name", + "description": "description", + } + result = {mapping[k]: v for k, v in fields.items() if k in mapping} + # « Projet phare » est une case à cocher : « - [X] Afficher ce projet… » + result["featured"] = "true" if re.search(r"- \[[xX]\]", fields.get("projet phare", "")) else "" + return result + + +def github_api(full_name: str) -> dict: + request = urllib.request.Request( + f"https://api.github.com/repos/{full_name}", + headers={"Accept": "application/vnd.github+json", "User-Agent": "hatatri-site"}, + ) + token = os.environ.get("GITHUB_TOKEN") or os.environ.get("GH_TOKEN") + if token: + request.add_header("Authorization", f"Bearer {token}") + try: + with urllib.request.urlopen(request, timeout=20) as response: + return json.load(response) + except urllib.error.HTTPError as exc: + if exc.code == 404: + fail(f"le dépôt {full_name} est introuvable (ou privé)") + fail(f"API GitHub : HTTP {exc.code} {exc.reason}") + except urllib.error.URLError as exc: + fail(f"API GitHub injoignable : {exc.reason}") + return {} + + +def build_entry(args: argparse.Namespace, existing: list[dict]) -> dict: + full_name = args.repo.strip().removeprefix("https://github.com/").strip("/") + if not REPO_RE.match(full_name): + fail(f"« {args.repo} » n'est pas au format propriétaire/nom") + + if any(str(r.get("repo", "")).lower() == full_name.lower() for r in existing): + fail(f"le dépôt {full_name} figure déjà dans {DATA_FILE.name}") + + categories = {c["id"] for c in yaml.safe_load(CATEGORIES_FILE.read_text(encoding="utf-8"))} + if args.category not in categories: + fail(f"catégorie « {args.category} » inconnue (choix : {', '.join(sorted(categories))})") + + meta = github_api(full_name) + if meta.get("private"): + fail(f"le dépôt {full_name} est privé : il ne peut pas être publié sur le site") + if meta.get("archived"): + print(f"⚠ le dépôt {full_name} est archivé : statut « archive » appliqué") + + full_name = meta.get("full_name", full_name) # casse officielle + name = " ".join((args.name or meta.get("name") or full_name.split("/")[1]).split()) + description = " ".join((args.description or meta.get("description") or "").split()) + if not description: + fail("aucune description : en ajouter une sur GitHub ou utiliser --description") + + tags = [t.strip().lower() for t in (args.tags or "").replace(";", ",").split(",") if t.strip()] + if not tags: + tags = list(meta.get("topics") or [])[:8] + bad = [t for t in tags if not TAG_RE.match(t)] + if bad: + fail(f"tags invalides : {', '.join(bad)} (minuscules, sans espace)") + + slug = args.slug or slugify(full_name.split("/")[1]) + taken = {str(r.get("slug")) for r in existing} + base, n = slug, 2 + while slug in taken: + slug, n = f"{base}-{n}", n + 1 + + entry: dict = { + "slug": slug, + "name": name, + "description": description, + "category": args.category, + "repo": full_name, + } + homepage = (meta.get("homepage") or "").strip() + if homepage.startswith("https://"): + entry["homepage"] = homepage + if meta.get("language"): + entry["language"] = meta["language"] + if tags: + entry["tags"] = tags + entry["added"] = dt.date.today() + entry["status"] = "archive" if meta.get("archived") else "actif" + if args.featured: + entry["featured"] = True + return entry + + +def main() -> None: + parser = argparse.ArgumentParser(description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter) + parser.add_argument("repo", nargs="?", help="dépôt GitHub au format propriétaire/nom") + parser.add_argument("--from-issue", metavar="FICHIER", help="lire les champs depuis le corps d'une issue « Nouveau projet »") + parser.add_argument("--category", help="id de catégorie (_data/categories.yml)") + parser.add_argument("--tags", help="tags séparés par des virgules (défaut : topics GitHub)") + parser.add_argument("--name", help="nom affiché (défaut : nom du dépôt)") + parser.add_argument("--description", help="description (défaut : description GitHub)") + parser.add_argument("--slug", help="identifiant (défaut : nom du dépôt en kebab-case)") + parser.add_argument("--featured", action="store_true", help="afficher le projet sur la page d'accueil") + parser.add_argument("--dry-run", action="store_true", help="afficher l'entrée sans modifier le fichier") + args = parser.parse_args() + + if args.from_issue: + fields = parse_issue_form(Path(args.from_issue).read_text(encoding="utf-8")) + args.repo = args.repo or fields.get("repo") + args.category = args.category or fields.get("category") + args.tags = args.tags or fields.get("tags") + args.name = args.name or fields.get("name") + args.description = args.description or fields.get("description") + args.featured = args.featured or fields.get("featured") == "true" + if not args.repo or not args.category: + parser.error("le dépôt et --category sont obligatoires") + + existing = yaml.safe_load(DATA_FILE.read_text(encoding="utf-8")) or [] + entry = build_entry(args, existing) + block = yaml.safe_dump([entry], allow_unicode=True, sort_keys=False, default_flow_style=None, width=1000) + + if args.dry_run: + print(block) + return + + # Ajout en fin de fichier : préserve les commentaires et la mise en forme existants. + content = DATA_FILE.read_text(encoding="utf-8").rstrip("\n") + DATA_FILE.write_text(f"{content}\n\n{block}", encoding="utf-8") + print(f"✔ « {entry['name']} » ajouté à {DATA_FILE.relative_to(ROOT)} :\n\n{block}") + + if os.environ.get("GITHUB_OUTPUT"): + with open(os.environ["GITHUB_OUTPUT"], "a", encoding="utf-8") as out: + name = " ".join(str(entry["name"]).split()) + out.write(f"slug={entry['slug']}\nname={name}\nrepo={entry['repo']}\n") + + +if __name__ == "__main__": + main() diff --git a/scripts/requirements.txt b/scripts/requirements.txt new file mode 100644 index 0000000..4452804 --- /dev/null +++ b/scripts/requirements.txt @@ -0,0 +1,2 @@ +PyYAML==6.0.3 +html5validator==0.4.2 diff --git a/scripts/validate_data.py b/scripts/validate_data.py new file mode 100644 index 0000000..df85aac --- /dev/null +++ b/scripts/validate_data.py @@ -0,0 +1,276 @@ +#!/usr/bin/env python3 +"""Valide les fichiers YAML et les données du site avant le build Jekyll. + +Contrôles effectués : + 1. Syntaxe YAML : _config.yml, _data/*.yml, .github/**/*.yml + 2. Syntaxe du front matter de toutes les pages (.md, .html, .xml) + 3. Schéma de _data/categories.yml et _data/repositories.yml + (champs obligatoires, types, formats, unicité des slugs, catégories connues…) + 4. Cohérence de la collection _projects/ avec _data/repositories.yml + 5. Cohérence des catégories proposées par le workflow « Ajouter un projet » + et par le formulaire d'issue « Proposer un projet » + +Les erreurs sont affichées au format des annotations GitHub Actions +(::error file=…::message) : elles apparaissent directement dans l'onglet +« Files changed » d'une pull request et dans le résumé du workflow. + +Usage : python3 scripts/validate_data.py (code de sortie 1 si erreur) +""" + +from __future__ import annotations + +import datetime as dt +import os +import re +import sys +from pathlib import Path + +try: + import yaml +except ImportError: # pragma: no cover + sys.exit("PyYAML est requis : pip install -r scripts/requirements.txt") + +ROOT = Path(__file__).resolve().parent.parent +DATA = ROOT / "_data" +IN_CI = os.environ.get("GITHUB_ACTIONS") == "true" + +SLUG_RE = re.compile(r"^[a-z0-9]+(?:-[a-z0-9]+)*$") +REPO_RE = re.compile(r"^[A-Za-z0-9](?:[A-Za-z0-9-]{0,38})/[A-Za-z0-9._-]{1,100}$") +TAG_RE = re.compile(r"^[a-z0-9][a-z0-9+#.-]*$") +URL_RE = re.compile(r"^https://[^\s]+$") +STATUSES = {"actif", "en-developpement", "archive"} +# Slugs interdits : ils entreraient en conflit avec les pages de /projets/ +RESERVED_SLUGS = {"chronologie", "feed", "index"} +FRONT_MATTER_RE = re.compile(r"\A---\s*\n(.*?)\n---\s*(?:\n|\Z)", re.DOTALL) +SKIP_DIRS = {".git", "_site", "vendor", "node_modules", ".jekyll-cache", ".bundle"} + +errors: list[str] = [] +warnings: list[str] = [] + + +def rel(path: Path) -> str: + return str(path.relative_to(ROOT)) + + +def error(path: Path, message: str, line: int | None = None) -> None: + loc = f"file={rel(path)}" + (f",line={line}" if line else "") + errors.append(f"::error {loc}::{message}" if IN_CI else f"ERREUR {rel(path)}{':' + str(line) if line else ''} — {message}") + + +def warning(path: Path, message: str) -> None: + warnings.append(f"::warning file={rel(path)}::{message}" if IN_CI else f"ATTENTION {rel(path)} — {message}") + + +def load_yaml(path: Path, text: str | None = None): + """Charge un document YAML ; enregistre une erreur (avec la ligne) si invalide.""" + try: + return yaml.safe_load(path.read_text(encoding="utf-8") if text is None else text) + except yaml.YAMLError as exc: + line = exc.problem_mark.line + 1 if getattr(exc, "problem_mark", None) else None + error(path, f"YAML invalide : {getattr(exc, 'problem', exc)}", line) + except UnicodeDecodeError: + error(path, "le fichier n'est pas encodé en UTF-8") + return None + + +def iter_files(*patterns: str): + for pattern in patterns: + for path in sorted(ROOT.glob(pattern)): + if path.is_file() and not SKIP_DIRS.intersection(path.relative_to(ROOT).parts): + yield path + + +# --------------------------------------------------------------------------- 1 +def check_yaml_files() -> None: + for path in iter_files("_config.yml", "_data/*.yml", "_data/*.yaml", ".github/**/*.yml"): + load_yaml(path) + + +# --------------------------------------------------------------------------- 2 +def check_front_matter() -> dict[str, dict]: + """Vérifie le front matter des pages et renvoie celui des documents _projects/.""" + projects: dict[str, dict] = {} + for path in iter_files("**/*.md", "**/*.html", "**/*.xml"): + if path.name == "README.md" or path.parts[-2:-1] == ("ISSUE_TEMPLATE",): + continue + text = path.read_text(encoding="utf-8") + if not text.startswith("---"): + if path.parent.name == "_projects": + error(path, "front matter manquant (le fichier doit commencer par ---)") + continue + match = FRONT_MATTER_RE.match(text) + if not match: + error(path, "front matter non fermé (ligne --- manquante)", 1) + continue + data = load_yaml(path, match.group(1)) + if data is not None and not isinstance(data, dict): + error(path, "le front matter doit être un dictionnaire clé: valeur", 1) + continue + if path.parent.name == "_projects": + projects[path.stem] = (data or {}) | {"__path__": path} + return projects + + +# --------------------------------------------------------------------------- 3 +def check_categories() -> set[str]: + path = DATA / "categories.yml" + cats = load_yaml(path) + if not isinstance(cats, list) or not cats: + error(path, "doit contenir une liste non vide de catégories") + return set() + ids: set[str] = set() + for i, cat in enumerate(cats, 1): + if not isinstance(cat, dict): + error(path, f"catégorie n°{i} : un dictionnaire est attendu") + continue + for key in ("id", "label"): + if not cat.get(key): + error(path, f"catégorie n°{i} : champ « {key} » obligatoire") + cid = str(cat.get("id", "")) + if cid and not SLUG_RE.match(cid): + error(path, f"catégorie « {cid} » : l'id doit être en kebab-case (ex. mon-id)") + if cid in ids: + error(path, f"catégorie « {cid} » déclarée deux fois") + ids.add(cid) + return ids + + +def check_repositories(categories: set[str]) -> set[str]: + path = DATA / "repositories.yml" + repos = load_yaml(path) + if repos is None: + return set() + if not isinstance(repos, list): + error(path, "doit contenir une liste de projets (chaque entrée commence par « - slug: … »)") + return set() + + slugs: set[str] = set() + github_repos: set[str] = set() + today = dt.date.today() + allowed = {"slug", "name", "description", "category", "added", "repo", "url", + "homepage", "language", "tags", "status", "featured"} + + for i, repo in enumerate(repos, 1): + if not isinstance(repo, dict): + error(path, f"entrée n°{i} : un dictionnaire est attendu") + continue + label = f"projet « {repo.get('slug', f'n°{i}')} »" + + for key in ("slug", "name", "description", "category", "added"): + if repo.get(key) in (None, ""): + error(path, f"{label} : champ « {key} » obligatoire") + for key in sorted(set(repo) - allowed): + warning(path, f"{label} : champ inconnu « {key} » (faute de frappe ?)") + + slug = repo.get("slug") + if slug is not None: + slug = str(slug) + if not SLUG_RE.match(slug): + error(path, f"{label} : slug invalide (minuscules, chiffres et tirets uniquement)") + if slug in RESERVED_SLUGS: + error(path, f"{label} : le slug « {slug} » est réservé") + if slug in slugs: + error(path, f"{label} : slug déjà utilisé par un autre projet") + slugs.add(slug) + + for key in ("name", "description", "language"): + if key in repo and not isinstance(repo[key], str): + error(path, f"{label} : « {key} » doit être une chaîne de caractères") + + if repo.get("category") and repo["category"] not in categories: + error(path, f"{label} : catégorie « {repo['category']} » inconnue " + f"(valeurs possibles : {', '.join(sorted(categories))})") + + added = repo.get("added") + if added is not None: + if not isinstance(added, dt.date) or isinstance(added, dt.datetime): + error(path, f"{label} : « added » doit être une date AAAA-MM-JJ sans guillemets") + elif added > today + dt.timedelta(days=1): + error(path, f"{label} : la date d'ajout {added} est dans le futur") + + if not repo.get("repo") and not repo.get("url"): + error(path, f"{label} : renseigner « repo » (propriétaire/nom) ou « url »") + if repo.get("repo"): + full = str(repo["repo"]) + if not REPO_RE.match(full): + error(path, f"{label} : « repo » doit être au format propriétaire/nom") + if full.lower() in github_repos: + error(path, f"{label} : le dépôt {full} est déjà référencé") + github_repos.add(full.lower()) + for key in ("url", "homepage"): + if repo.get(key) and not URL_RE.match(str(repo[key])): + error(path, f"{label} : « {key} » doit être une URL https://") + + tags = repo.get("tags", []) + if not isinstance(tags, list): + error(path, f"{label} : « tags » doit être une liste, ex. [python, cpge]") + else: + for tag in tags: + if not isinstance(tag, str) or not TAG_RE.match(tag): + error(path, f"{label} : tag « {tag} » invalide (minuscules, sans espace)") + if len(tags) != len(set(tags)): + warning(path, f"{label} : tags en double") + + if repo.get("status", "actif") not in STATUSES: + error(path, f"{label} : « status » doit valoir {' | '.join(sorted(STATUSES))}") + if "featured" in repo and not isinstance(repo["featured"], bool): + error(path, f"{label} : « featured » doit valoir true ou false") + + print(f"✔ {len(repos)} projet(s) lu(s) dans {rel(path)}") + return slugs + + +# --------------------------------------------------------------------------- 4 +def check_project_pages(projects: dict[str, dict], slugs: set[str]) -> None: + for name, front in projects.items(): + path = front["__path__"] + if name not in slugs: + error(path, f"aucune entrée « slug: {name} » dans _data/repositories.yml pour cette page") + if not front.get("title"): + error(path, "champ « title » obligatoire dans le front matter") + + +# --------------------------------------------------------------------------- 5 +def check_category_choices(categories: set[str]) -> None: + """Les listes de catégories du workflow et du formulaire doivent suivre categories.yml.""" + workflow_path = ROOT / ".github" / "workflows" / "add-repository.yml" + if workflow_path.exists(): + workflow = load_yaml(workflow_path) or {} + # PyYAML (YAML 1.1) lit la clé « on » comme le booléen True + triggers = workflow.get("on", workflow.get(True)) or {} + options = (((triggers.get("workflow_dispatch") or {}).get("inputs") or {}) + .get("category", {}).get("options")) + if options is not None and set(options) != categories: + error(workflow_path, "les options de l'entrée « category » doivent correspondre " + f"aux id de _data/categories.yml ({', '.join(sorted(categories))})") + + form_path = ROOT / ".github" / "ISSUE_TEMPLATE" / "nouveau-projet.yml" + if form_path.exists(): + form = load_yaml(form_path) or {} + for field in form.get("body", []): + if field.get("id") == "category": + options = (field.get("attributes") or {}).get("options") or [] + if set(options) != categories: + error(form_path, "les options du champ « Catégorie » doivent correspondre " + f"aux id de _data/categories.yml ({', '.join(sorted(categories))})") + + +def main() -> int: + check_yaml_files() + projects = check_front_matter() + categories = check_categories() + slugs = check_repositories(categories) + check_project_pages(projects, slugs) + check_category_choices(categories) + + for line in warnings + errors: + print(line) + if errors: + print(f"\n✘ {len(errors)} erreur(s), {len(warnings)} avertissement(s).") + return 1 + print(f"✔ Données valides ({len(warnings)} avertissement(s)).") + return 0 + + +if __name__ == "__main__": + sys.exit(main())