Compare commits
10 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1e10feba95 | |||
| ec3a101d9b | |||
| 47114fa96b | |||
| dee864e22b | |||
| 584a0d1586 | |||
| 8ad4987d38 | |||
| b3230b4da9 | |||
| a8dd8ae349 | |||
| 883e20e3c5 | |||
| 3472fe7094 |
10
CHANGELOG.md
10
CHANGELOG.md
@@ -1,5 +1,5 @@
|
||||
<!-- file: CHANGELOG.md -->
|
||||
<!-- version: 3 -->
|
||||
<!-- version: 5 -->
|
||||
|
||||
# Changelog Project Governance Rules
|
||||
|
||||
@@ -7,6 +7,14 @@ Ce fichier décrit les changements utiles aux utilisateurs ou intégrateurs des
|
||||
|
||||
Les tranches `alpha`, `beta`, `rc`, fixes, validations, audits et détails de développement appartiennent aux plans, deltas et historiques. Ils ne sont pas recopiés ici par défaut.
|
||||
|
||||
## 0.0.3
|
||||
|
||||
- fournit cinq fichiers modèles Rust/Cargo : `rustfmt.toml`, `clippy.toml`, `.cargo/config.toml`, un manifest workspace et un manifest de crate membre, avec instructions d'adaptation ;
|
||||
- explicite l'héritage des métadonnées et lints Cargo, ainsi que les exceptions locales motivées ;
|
||||
- ajoute deux audits facultatifs et ciblés du style Rust, pour l'espacement des lignes vides et les blocs de constantes racine sans ordre sémantique, sans remplacer Rustfmt ni Clippy ;
|
||||
- ajoute un audit read-only des headers `file` et `version` des fichiers Markdown gouvernés par PGR ;
|
||||
- fournit une spécification courte pour rédiger le message manuel de reprise après publication d'une stable.
|
||||
|
||||
## 0.0.2
|
||||
|
||||
- introduit le modèle de profils PGR avec ownership normatif, applicabilité, composition du général vers le spécifique et overrides bornés ;
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: README.md -->
|
||||
<!-- version: 4 -->
|
||||
<!-- version: 6 -->
|
||||
|
||||
# Project Governance Rules
|
||||
|
||||
@@ -13,7 +13,7 @@ Le dépôt officiel est `https://git.sasedev.com/Sasedev/pgr`.
|
||||
|
||||
PGR est actuellement en phase de fondation `0.0.x`.
|
||||
|
||||
La version courante est définie par [`VERSION`](VERSION). La release `0.0.1` établit la gouvernance normative et documentaire de PGR lui-même. La release `0.0.2` ajoute le premier modèle de profils réutilisables, les profils Rust/Cargo, Java/Maven/Gradle et Android, ainsi que deux audits Markdown génériques monotâches. Les releases suivantes de la série `0.0.x` poursuivent avec templates techniques et spécifications de skeletons.
|
||||
La version courante est définie par [`VERSION`](VERSION). La release `0.0.1` établit la gouvernance normative et documentaire de PGR lui-même. La release `0.0.2` ajoute les premiers profils réutilisables Rust/Cargo, Java/Maven/Gradle et Android, ainsi que deux audits Markdown. La release `0.0.3` fournit les premiers modèles Rust/Cargo, deux audits de style Rust facultatifs, l'audit des headers Markdown et la spécification du message manuel de reprise. La série `0.0.x` se poursuit avec les spécifications de skeletons prévues pour `0.0.4`.
|
||||
|
||||
## Entrées principales
|
||||
|
||||
@@ -26,6 +26,7 @@ La version courante est définie par [`VERSION`](VERSION). La release `0.0.1` é
|
||||
- [`docs/architecture/002-GOVERNANCE_ARCHITECTURE.md`](docs/architecture/002-GOVERNANCE_ARCHITECTURE.md) — architecture du référentiel ;
|
||||
- [`docs/plans/001-V0_0_1_FOUNDATION_PLAN.md`](docs/plans/001-V0_0_1_FOUNDATION_PLAN.md) — plan historique de fondation `0.0.1` ;
|
||||
- [`docs/plans/002-V0_0_2_RULE_PROFILES_PLAN.md`](docs/plans/002-V0_0_2_RULE_PROFILES_PLAN.md) — plan historique des premiers profils `0.0.2` ;
|
||||
- [`docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md`](docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md) — plan historique des templates et audits `0.0.3` ;
|
||||
- [`docs/validation/001-VALIDATION_MATRIX.md`](docs/validation/001-VALIDATION_MATRIX.md) — matrice de validation.
|
||||
|
||||
## Langue et nomenclature
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: ROADMAP.md -->
|
||||
<!-- version: 3 -->
|
||||
<!-- version: 4 -->
|
||||
|
||||
# Roadmap Project Governance Rules
|
||||
|
||||
@@ -11,7 +11,7 @@ Statuts : `( )` planifié, `(x)` terminé, `(d)` différé, `(c)` annulé.
|
||||
|
||||
- `(x) 0.0.1` — fondation normative et documentaire : gouvernance, lifecycle des releases, rôles documentaires, workflow delta/history/handoff et validation proportionnée ;
|
||||
- `(x) 0.0.2` — premiers profils de règles réutilisables : Rust/Cargo, Java/Maven/Gradle et Android, avec modèle de composition et audits Markdown initiaux ;
|
||||
- `( ) 0.0.3` — templates techniques initiaux et premiers patterns d'audit réutilisables issus de besoins réels ;
|
||||
- `(x) 0.0.3` — templates techniques initiaux et premiers patterns d'audit réutilisables issus de besoins réels ;
|
||||
- `( ) 0.0.4` — spécifications Markdown de skeletons et règles de composition des profils/templates ;
|
||||
- `( ) 0.0.5` — réconciliation réelle de PGR avec `khadhroony-solana-project` et `sasedev-games`.
|
||||
|
||||
|
||||
122
deltas/0.0.3/alpha.1.fix.1.md
Normal file
122
deltas/0.0.3/alpha.1.fix.1.md
Normal file
@@ -0,0 +1,122 @@
|
||||
<!-- file: deltas/0.0.3/alpha.1.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.1.fix.1 — périmètre Rust/Cargo du plan
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : tranche `0.0.3-alpha.1` validée par l'opérateur, avec `history/0.0.3/alpha.1.md` appliqué et committé. Ce fix ne doit pas être appliqué sur un état où le history `alpha.1` n'est pas encore dans le commit de base.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.1
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.1.fix.1
|
||||
```
|
||||
|
||||
## Motif et observations
|
||||
|
||||
Le delta `alpha.1` a passé sa gate mécanique. La revue du plan ensuite a montré que la tranche Rust prévue autour du seul `rustfmt.toml` n'intégrait pas les réglages Clippy et les deux manifests Cargo communs déjà décrits dans `510-RUST_CARGO.md` et pratiqués dans KSP et Games.
|
||||
|
||||
Les archives de référence supplémentaires inspectées sont :
|
||||
|
||||
```text
|
||||
khadhroony-solana-project-v0.3.16.zip SHA-256 db3cc1b3fc3fb07ee864b02e2a7346c673d4cf63b33e8e872aca6c6458856ca0
|
||||
games-v0.3.5.zip SHA-256 5f5fdee1a271386766d059657d6eaa831acdc263b3e722fed738808335c0a105
|
||||
```
|
||||
|
||||
Les deux projets centralisent lints et métadonnées Cargo, et conservent `rustfmt.toml` ainsi qu'un `clippy.toml`. Les scripts Rust des projets mêlent plusieurs politiques ; le plan corrigé en tire des candidats de propriétés isolées sans les recopier. La seule exception de lints locaux constatée parmi les `45` crates inspectées concerne la frontière Android de Games.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
deltas/0.0.3/alpha.1.fix.1.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
Le plan passe de `<!-- version: 1 -->` à `<!-- version: 2 -->` pour sa révision réelle. Les snapshots `deltas/0.0.3/alpha.1.md` et `history/0.0.3/alpha.1.md` restent inchangés. Aucun template, script, règle normative ou manifest de suppression n'est ajouté dans ce fix.
|
||||
|
||||
## Contenu corrigé
|
||||
|
||||
- le template Rust prévu couvre `rustfmt.toml`, les niveaux de lint Rust/Clippy dans Cargo, les manifests workspace/membre et, seulement si justifié, des paramètres distincts dans `clippy.toml` ;
|
||||
- le plan compare les deux corpus réels, relève l'héritage explicite des lints et son exception Android bornée, distingue les options communes des seuils ou dépendances propres à un projet ;
|
||||
- les tranches sont redimensionnées : `alpha.2` formatage/Clippy, `alpha.3` manifests Cargo, `alpha.4` audit de headers Markdown, puis décision conditionnelle sur un template de workflow ;
|
||||
- les scripts Rust KSP/Games servent de corpus de comparaison pour des audits futurs read-only et monotâches, sans transfert direct de leurs règles locales vers PGR.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Après application sur le commit `alpha.1` :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.1.fix.1'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.1.md
|
||||
test -f deltas/0.0.3/alpha.1.fix.1.md
|
||||
test -f history/0.0.3/alpha.1.md
|
||||
test ! -e history/0.0.3/alpha.1.fix.1.md
|
||||
|
||||
grep -Fx '<!-- version: 2 -->' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F 'Les `22` crates KSP héritent des lints workspace' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F '### alpha.2 — formatage et configuration Clippy' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F '### alpha.3 — manifests Cargo workspace et crate membre' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F '### alpha.4 — audit de headers Markdown' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
files = [Path(name) for name in ('README.md', 'RULES.md', 'ROADMAP.md', 'CHANGELOG.md')]
|
||||
for directory in ('docs', 'deltas', 'history', 'prompts'):
|
||||
files.extend(Path(directory).rglob('*.md'))
|
||||
files = sorted(set(files))
|
||||
for path in files:
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert len(lines) >= 2 and lines[0] == f'<!-- file: {path.as_posix()} -->', path
|
||||
assert re.fullmatch(r'<!-- version: [1-9][0-9]* -->', lines[1]), path
|
||||
print(f'Markdown header audit: clean ({len(files)} file(s))')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md deltas/0.0.3/alpha.1.fix.1.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Avant ajout du history du fix, le scope indexé attendu est :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.1.fix.1.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
Revue complémentaire : confirmer que la correction ne copie pas de version de dépendance, de path Cargo ou de seuil Clippy arbitraire ; vérifier que le plan reste une prévision et que `alpha.1` demeure un snapshot historique inchangé.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire et appliquer séparément `history/0.0.3/alpha.1.fix.1.md` avec les résultats réellement observés, puis committer ce fix avant tout delta `alpha.2`.
|
||||
|
||||
### FAIL
|
||||
|
||||
Consigner le résultat réel dans le history du fix et poursuivre par `alpha.1.fix.2` limité au cadrage, ou engager un REPLAN explicite si le scope Rust doit changer davantage.
|
||||
101
deltas/0.0.3/alpha.1.md
Normal file
101
deltas/0.0.3/alpha.1.md
Normal file
@@ -0,0 +1,101 @@
|
||||
<!-- file: deltas/0.0.3/alpha.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.1 — audit de baseline et cadrage
|
||||
|
||||
## Baseline
|
||||
|
||||
Archive fournie `pgr-v0.0.2.zip`, déclarée téléchargée du tag Gitea `v0.0.2`, vérifiée avec SHA-256 :
|
||||
|
||||
```text
|
||||
8dc5c979a4d722b4ef6ec84b6227c8cbfffb3f865f4ea9063c03ecb1e365cdc4
|
||||
```
|
||||
|
||||
Le rapport post-tag externe `pgr-0.0.2-publish.001-report.md` indique `PASS` et le même hash. Il n'est pas ajouté rétroactivement à la stable. Aucun `.git` n'est attendu dans l'archive source.
|
||||
|
||||
Version avant application : `0.0.2`.
|
||||
|
||||
Version après application : `0.0.3-alpha.1`.
|
||||
|
||||
## Objet
|
||||
|
||||
Exécuter le cadrage demandé par `prompts/003-V0_0_3_START_PROMPT.md` : audit complet de la stable, vérification des règles et de la chaîne historique, inventaire des sujets utiles, choix d'un scope initial et découpage proportionné dans un plan actif.
|
||||
|
||||
Le résultat détaillé de l'audit, ses limites et les décisions de scope sont consignés dans `docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md`. L'archive est cohérente dans les contrôles réalisés ; aucune correction rétroactive de `0.0.2` n'est nécessaire avant cette tranche.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
deltas/0.0.3/alpha.1.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive delta contient exactement les fichiers complets ci-dessus, avec les mêmes chemins relatifs. Aucun manifest de suppression, history, nouveau template ou script d'audit n'appartient à cette tranche.
|
||||
|
||||
Les index et les documents historiques restent conformes sans mise à jour cérémonielle : la roadmap annonce déjà `0.0.3`, le changelog conserve les releases stables et les index documentaires pointent vers les collections existantes.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Appliquer l'archive delta à la copie de travail du dépôt fondée sur `v0.0.2`. Depuis sa racine :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.1'
|
||||
test -f docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
test -f deltas/0.0.3/alpha.1.md
|
||||
test ! -e history/0.0.3/alpha.1.md
|
||||
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
files = [Path(name) for name in ('README.md', 'RULES.md', 'ROADMAP.md', 'CHANGELOG.md')]
|
||||
for directory in ('docs', 'deltas', 'history', 'prompts'):
|
||||
files.extend(Path(directory).rglob('*.md'))
|
||||
files = sorted(set(files))
|
||||
for path in files:
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert len(lines) >= 2 and lines[0] == f'<!-- file: {path.as_posix()} -->', path
|
||||
assert re.fullmatch(r'<!-- version: [1-9][0-9]* -->', lines[1]), path
|
||||
print(f'Markdown header audit: clean ({len(files)} file(s))')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md deltas/0.0.3/alpha.1.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Avant d'ajouter le history, le scope attendu des fichiers indexés est :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
A deltas/0.0.3/alpha.1.md
|
||||
```
|
||||
|
||||
L'opérateur confirme également que la baseline provient bien du tag déclaré, que le hash concorde avec la preuve post-tag, que les `24` couples historiques antérieurs sont conservés, que les profils différés ne sont pas matérialisés, et que le plan ne fait pas passer une prévision pour une règle déjà active.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Rédiger et livrer séparément `history/0.0.3/alpha.1.md` avec les résultats réellement observés ; l'appliquer et committer la tranche. Préparer seulement ensuite `0.0.3-alpha.2`.
|
||||
|
||||
### FAIL
|
||||
|
||||
Enregistrer le résultat réellement observé dans le history de `alpha.1`, puis corriger le cadrage dans `0.0.3-alpha.1.fix.1` ou produire un REPLAN motivé. Aucune implémentation `alpha.2` ne doit être absorbée dans le fix.
|
||||
123
deltas/0.0.3/alpha.2.md
Normal file
123
deltas/0.0.3/alpha.2.md
Normal file
@@ -0,0 +1,123 @@
|
||||
<!-- file: deltas/0.0.3/alpha.2.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.2 — outillage Rust/Cargo partagé
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-alpha.1.fix.1` avec `history/0.0.3/alpha.1.fix.1.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.1.fix.1
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.2
|
||||
```
|
||||
|
||||
## Objet
|
||||
|
||||
Matérialiser trois configurations Rust/Cargo directement issues des pratiques éprouvées dans KSP et Games, avec des instructions explicites d'adaptation. L'opérateur a précisé après le gate de `alpha.1.fix.1` que la sortie Cargo est généralement déportée vers `../builds/<projet>/target/` et que Rustfmt/Clippy constituent des conventions de départ qu'il réutilise avec des adaptations mineures.
|
||||
|
||||
Le `clippy.toml` livré conserve les réglages communs utiles aux deux corpus, sans copier leurs listes d'identifiants propres ni leurs entrées vides. Les niveaux des lints appartiendront aux templates `Cargo.toml` de `alpha.3`, conformément au profil `510`.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
docs/000-README.md
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
templates/rust-cargo/rustfmt.toml
|
||||
templates/rust-cargo/clippy.toml
|
||||
templates/rust-cargo/.cargo/config.toml
|
||||
docs/templates/001-RUST_CARGO_TOOLING.md
|
||||
deltas/0.0.3/alpha.2.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
Les fichiers complets sont livrés dans l'archive delta. Aucun history `alpha.2`, manifest de suppression, crate PGR ou script d'audit nouveau n'y est inclus.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Depuis la racine du dépôt après application du delta :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.2'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.1.fix.1.md
|
||||
test ! -e history/0.0.3/alpha.2.md
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import tomllib
|
||||
|
||||
root = Path('templates/rust-cargo')
|
||||
rustfmt = tomllib.loads((root / 'rustfmt.toml').read_text(encoding='utf-8'))
|
||||
clippy = tomllib.loads((root / 'clippy.toml').read_text(encoding='utf-8'))
|
||||
cargo = tomllib.loads((root / '.cargo/config.toml').read_text(encoding='utf-8'))
|
||||
assert rustfmt['edition'] == '2024'
|
||||
assert rustfmt['max_width'] == 160
|
||||
assert clippy['allow-unwrap-in-tests'] is True
|
||||
assert clippy['allowed-idents-below-min-chars'] == ['id']
|
||||
assert cargo['build']['target-dir'] == '../builds/project-name/target'
|
||||
assert cargo['build']['build-dir'] == cargo['build']['target-dir']
|
||||
for path in (root / 'rustfmt.toml', root / 'clippy.toml', root / '.cargo/config.toml'):
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert lines[0] == f'# file: {path.as_posix()}', path
|
||||
assert lines[1] == '# version: 1', path
|
||||
print('Rust/Cargo template TOML audit: clean (3 file(s))')
|
||||
PY
|
||||
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
files = [Path(name) for name in ('README.md', 'RULES.md', 'ROADMAP.md', 'CHANGELOG.md')]
|
||||
for directory in ('docs', 'deltas', 'history', 'prompts'):
|
||||
files.extend(Path(directory).rglob('*.md'))
|
||||
files = sorted(set(files))
|
||||
for path in files:
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert len(lines) >= 2 and lines[0] == f'<!-- file: {path.as_posix()} -->', path
|
||||
assert re.fullmatch(r'<!-- version: [1-9][0-9]* -->', lines[1]), path
|
||||
print(f'Markdown header audit: clean ({len(files)} file(s))')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/000-README.md docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md \
|
||||
docs/templates/001-RUST_CARGO_TOOLING.md deltas/0.0.3/alpha.2.md \
|
||||
templates/rust-cargo/rustfmt.toml templates/rust-cargo/clippy.toml \
|
||||
templates/rust-cargo/.cargo/config.toml
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : les trois `REPLACE` et les cinq `ADD` énumérés ci-dessus, sans modification des deltas ou histories précédents.
|
||||
|
||||
Revue opérateur : confirmer que la convention de sortie Cargo vers un dossier frère est expliquée avec son chemin relatif réel, que `project-name` est à remplacer avant copie et que les lints de niveau Cargo et les manifests restent bien au scope de `alpha.3`. La gate de cette tranche reste documentaire/TOML : PGR ne contient aucun workspace Rust à compiler.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire séparément `history/0.0.3/alpha.2.md` avec les sorties réellement observées, l'appliquer et committer avant de préparer `alpha.3` consacré aux manifests Cargo.
|
||||
|
||||
### FAIL
|
||||
|
||||
Enregistrer la défaillance réelle puis corriger ces seuls templates ou instructions dans `alpha.2.fix.1`, sauf besoin de REPLAN justifié.
|
||||
118
deltas/0.0.3/alpha.3.md
Normal file
118
deltas/0.0.3/alpha.3.md
Normal file
@@ -0,0 +1,118 @@
|
||||
<!-- file: deltas/0.0.3/alpha.3.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.3 — audits de style Rust ciblés
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-alpha.2`, avec `history/0.0.3/alpha.2.md` appliqué et committé. Ce delta MUST NOT être appliqué tant que ce commit n'existe pas.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.2
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.3
|
||||
```
|
||||
|
||||
## Objet et REPLAN
|
||||
|
||||
Après la gate PASS de `alpha.2`, l'opérateur a signalé les audits Python de style Rust de KSP et Games et demandé leur découpage en scripts plus petits et monotâches. L'examen de leurs `audit_rust_general_rules.py` montre qu'ils combinent blancs, constantes, ordre de modules, headers, rustdoc et règles de façade. Résultat REPLAN : `SPLIT`. Les deux contrôles de style apportant une preuve autonome passent à `alpha.3` ; les manifests Cargo initialement prévus ici passent à `alpha.4`, l'audit des headers Markdown à `alpha.5` et la décision workflow à `alpha.6`.
|
||||
|
||||
Ajouter un contrôle facultatif d'espacement des lignes vides et un contrôle facultatif des blocs de constantes racine, avec un helper lexical commun sans politique autonome. Le profil `510` possède leurs conventions optionnelles, la documentation de validation explicite leur adoption et leurs limites ; la matrice répertorie leur test ciblé. Rustfmt reste propriétaire du tri interne qu'il effectue déjà ; Clippy garde ses lints. Aucun script KSP/Games complet ni gate Rust obligatoire n'est copié dans PGR.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
docs/rules/510-RUST_CARGO.md
|
||||
docs/templates/001-RUST_CARGO_TOOLING.md
|
||||
docs/validation/001-VALIDATION_MATRIX.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
docs/validation/002-RUST_STYLE_AUDITS.md
|
||||
scripts/_rust_audit_common.py
|
||||
scripts/audit_rust_blank_lines.py
|
||||
scripts/audit_rust_const_blocks.py
|
||||
tests/test_rust_audits.py
|
||||
deltas/0.0.3/alpha.3.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
Les fichiers complets figurent dans l'archive delta. Aucun history `alpha.3`, changement rétroactif de delta/history, manifest Cargo, suppression ou modification des corpus de référence n'est inclus.
|
||||
|
||||
## Limites et prévalidation
|
||||
|
||||
Les audits sont read-only, sélectionnent explicitement des fichiers `.rs` et signalent les violations avec chemin et ligne. La prévalidation hors dépôt PGR a porté sur `300` sources KSP et `59` sources Games : l'audit des blancs est propre sur les deux ; l'audit des constantes est propre sur Games mais affiche `17` signaux KSP lorsqu'il est lancé globalement. Des séquences KSP portent un ordre métier ou de schéma ; l'ordre alphabétique ne leur est pas imposé. La sélection du projet doit donc exclure les fichiers ayant une sémantique d'ordre incompatible. Les scripts ne parsèrent pas intégralement Rust et ne remplacent ni Rustfmt ni Clippy.
|
||||
|
||||
Cette prévalidation de corpus n'est pas une validation opérateur de la tranche. Le dépôt PGR ne contient ni crate Rust ni fichiers Rust sujets à un audit produit. Les cas de test Python du delta vérifient les contrats réellement livrés, y compris échecs attendus et statut CLI.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Après application sur le commit `alpha.2` :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.3'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.2.md
|
||||
test -f history/0.0.3/alpha.2.md
|
||||
test -f deltas/0.0.3/alpha.3.md
|
||||
test ! -e history/0.0.3/alpha.3.md
|
||||
|
||||
grep -Fx '<!-- version: 4 -->' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F '### alpha.4 — manifests Cargo workspace et crate membre' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F '### alpha.5 — audit de headers Markdown' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
|
||||
python3 -B -m unittest discover -s tests -p test_rust_audits.py -v
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
files = [Path(name) for name in ('README.md', 'RULES.md', 'ROADMAP.md', 'CHANGELOG.md')]
|
||||
for directory in ('docs', 'deltas', 'history', 'prompts'):
|
||||
files.extend(Path(directory).rglob('*.md'))
|
||||
files = sorted(set(files))
|
||||
for path in files:
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert len(lines) >= 2 and lines[0] == f'<!-- file: {path.as_posix()} -->', path
|
||||
assert re.fullmatch(r'<!-- version: [1-9][0-9]* -->', lines[1]), path
|
||||
print(f'Markdown header audit: clean ({len(files)} file(s))')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md \
|
||||
docs/rules/510-RUST_CARGO.md docs/templates/001-RUST_CARGO_TOOLING.md \
|
||||
docs/validation/001-VALIDATION_MATRIX.md docs/validation/002-RUST_STYLE_AUDITS.md \
|
||||
scripts/_rust_audit_common.py scripts/audit_rust_blank_lines.py \
|
||||
scripts/audit_rust_const_blocks.py tests/test_rust_audits.py \
|
||||
deltas/0.0.3/alpha.3.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : cinq `REPLACE` et six `ADD` exactement comme ci-dessus. Revue opérateur : vérifier le rôle facultatif des deux scripts, leur dépendance commune, la sélection des fichiers Rust et la priorité de l'ordre sémantique ; confirmer que les manifests Cargo restent prévus en `alpha.4`.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire séparément `history/0.0.3/alpha.3.md` avec les résultats réellement exécutés, l'appliquer et committer cette tranche avant tout delta `alpha.4`.
|
||||
|
||||
### FAIL
|
||||
|
||||
Consigner le diagnostic dans le history `alpha.3`, puis corriger ce scope dans `alpha.3.fix.1` ou engager un nouveau REPLAN si la séparation des contrôles n'est plus adaptée.
|
||||
191
deltas/0.0.3/alpha.4.md
Normal file
191
deltas/0.0.3/alpha.4.md
Normal file
@@ -0,0 +1,191 @@
|
||||
<!-- file: deltas/0.0.3/alpha.4.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.4 — manifests Cargo workspace et membre
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-alpha.3`, avec `history/0.0.3/alpha.3.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.3
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.4
|
||||
```
|
||||
|
||||
## Objet
|
||||
|
||||
Fournir les deux manifests Cargo prévus dans le plan après son REPLAN `SPLIT` : un workspace virtuel à release commune et une crate bibliothèque membre. Les sections d'héritage, les lints Rust/Clippy communs, la version de release et le périmètre des dépendances doivent être compréhensibles sans figer les identités KSP/Games ni une liste de dépendances tierces.
|
||||
|
||||
Le manifest racine reprend les trois lints Rust et les `18` niveaux Clippy effectivement communs aux deux projets. Il déclare un bloc `[workspace.dependencies]` initialement vide. Le membre hérite explicitement des métadonnées présentes et des lints par `[lints] workspace = true`. La documentation distingue l'adaptation ordinaire d'une exception FFI locale, qui ne peut combiner cet héritage avec des lints locaux dans une même crate. La version `0.1.0` et le nom `project-core-lib` sont des exemples à remplacer, pas des valeurs de PGR ou d'un projet tiers.
|
||||
|
||||
Le plan vivant reçoit deux corrections factuelles : PGR possède désormais plus de deux utilitaires Python et la famille énumère cinq responsabilités, et non quatre. Ces corrections n'altèrent aucun delta ni history précédent.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
docs/templates/001-RUST_CARGO_TOOLING.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
templates/rust-cargo/Cargo.toml
|
||||
templates/rust-cargo/crates/project-core-lib/Cargo.toml
|
||||
docs/templates/002-CARGO_MANIFESTS.md
|
||||
deltas/0.0.3/alpha.4.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive contient uniquement ces fichiers complets. Aucun fichier source Rust, history `alpha.4`, suppression, dépendance de build de PGR ou version tierce n'est introduit.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Après application sur le commit `alpha.3` :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.4'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.3.md
|
||||
test -f history/0.0.3/alpha.3.md
|
||||
test ! -e history/0.0.3/alpha.4.md
|
||||
test -f deltas/0.0.3/alpha.4.md
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import json
|
||||
import shutil
|
||||
import subprocess
|
||||
import tempfile
|
||||
import tomllib
|
||||
|
||||
source = Path('templates/rust-cargo')
|
||||
root_file = source / 'Cargo.toml'
|
||||
member_file = source / 'crates/project-core-lib/Cargo.toml'
|
||||
root = tomllib.loads(root_file.read_text(encoding='utf-8'))
|
||||
member = tomllib.loads(member_file.read_text(encoding='utf-8'))
|
||||
assert root['workspace']['resolver'] == '3'
|
||||
assert root['workspace']['members'] == ['crates/project-core-lib']
|
||||
assert root['workspace']['package']['version'] == '0.1.0' # Explicit example.
|
||||
assert root['workspace']['package']['edition'] == '2024'
|
||||
assert root['workspace']['package']['publish'] is False
|
||||
assert root['workspace']['dependencies'] == {}
|
||||
assert root['workspace']['lints']['rust'] == {
|
||||
'missing_docs': 'warn', 'unreachable_pub': 'deny', 'unsafe_code': 'forbid'
|
||||
}
|
||||
clippy = root['workspace']['lints']['clippy']
|
||||
assert len(clippy) == 18 and clippy['implicit_return'] == 'deny'
|
||||
assert clippy['needless_return'] == 'allow' and clippy['unwrap_used'] == 'deny'
|
||||
assert member['package']['name'] == 'project-core-lib'
|
||||
for field in ('version', 'edition', 'publish'):
|
||||
assert member['package'][field] == {'workspace': True}, field
|
||||
assert member['dependencies'] == {} and member['lints'] == {'workspace': True}
|
||||
for path in (root_file, member_file):
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert lines[:2] == [f'# file: {path.as_posix()}', '# version: 1'], path
|
||||
print('Cargo manifest TOML audit: clean (2 file(s))')
|
||||
|
||||
if shutil.which('cargo') is None:
|
||||
print('Cargo workspace smoke: toolchain unavailable; TOML audit only')
|
||||
else:
|
||||
with tempfile.TemporaryDirectory(prefix='pgr-cargo-manifests-') as folder:
|
||||
workspace = Path(folder)
|
||||
crate = workspace / 'crates/project-core-lib'
|
||||
(crate / 'src').mkdir(parents=True)
|
||||
shutil.copy2(root_file, workspace / 'Cargo.toml')
|
||||
shutil.copy2(member_file, crate / 'Cargo.toml')
|
||||
(crate / 'src/lib.rs').write_text(
|
||||
'//! Minimal template check.\n\n/// Return one.\n'
|
||||
'pub fn value() -> u8 {\n return 1;\n}\n', encoding='utf-8'
|
||||
)
|
||||
command = ['cargo', 'metadata', '--manifest-path', str(workspace / 'Cargo.toml'),
|
||||
'--format-version', '1', '--no-deps', '--offline']
|
||||
result = subprocess.run(command, cwd=workspace, text=True,
|
||||
capture_output=True, check=True)
|
||||
package = json.loads(result.stdout)['packages'][0]
|
||||
assert package['name'] == 'project-core-lib'
|
||||
assert package['version'] == '0.1.0' and package['edition'] == '2024'
|
||||
subprocess.run(['cargo', 'check', '--workspace', '--offline'],
|
||||
cwd=workspace, check=True)
|
||||
if subprocess.run(['cargo', 'clippy', '--version'], capture_output=True).returncode == 0:
|
||||
subprocess.run(['cargo', 'clippy', '--workspace', '--all-targets',
|
||||
'--all-features', '--offline', '--', '-D', 'warnings'],
|
||||
cwd=workspace, check=True)
|
||||
|
||||
# Inherited forbid must reject unsafe code before a local FFI exception.
|
||||
(crate / 'src/lib.rs').write_text(
|
||||
'//! Minimal FFI exception check.\n\n/// Return one.\n'
|
||||
'pub fn value() -> u8 {\n'
|
||||
' let value: u8 = 1;\n let ptr: *const u8 = &value;\n'
|
||||
' unsafe { return *ptr; }\n}\n', encoding='utf-8'
|
||||
)
|
||||
rejected = subprocess.run(['cargo', 'check', '--workspace', '--offline'],
|
||||
cwd=workspace, capture_output=True, text=True)
|
||||
assert rejected.returncode != 0 and 'unsafe' in rejected.stderr
|
||||
|
||||
# Cargo must accept a local lint table in place of inheritance.
|
||||
local = member_file.read_text(encoding='utf-8').replace(
|
||||
'[lints]\nworkspace = true\n',
|
||||
'[lints.rust]\nmissing_docs = "warn"\n'
|
||||
'unreachable_pub = "deny"\nunsafe_code = "allow"\n\n'
|
||||
'[lints.clippy]\n' + ''.join(
|
||||
f'{name} = {json.dumps(level)}\n' for name, level in clippy.items()
|
||||
)
|
||||
)
|
||||
assert '[lints.rust]' in local and '[lints]\nworkspace = true' not in local
|
||||
(crate / 'Cargo.toml').write_text(local, encoding='utf-8')
|
||||
subprocess.run(['cargo', 'check', '--workspace', '--offline'],
|
||||
cwd=workspace, check=True)
|
||||
print('Cargo workspace smoke: clean (inherited and local lints)')
|
||||
PY
|
||||
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
files = [Path(name) for name in ('README.md', 'RULES.md', 'ROADMAP.md', 'CHANGELOG.md')]
|
||||
for directory in ('docs', 'deltas', 'history', 'prompts'):
|
||||
files.extend(Path(directory).rglob('*.md'))
|
||||
files = sorted(set(files))
|
||||
for path in files:
|
||||
lines = path.read_text(encoding='utf-8').splitlines()
|
||||
assert len(lines) >= 2 and lines[0] == f'<!-- file: {path.as_posix()} -->', path
|
||||
assert re.fullmatch(r'<!-- version: [1-9][0-9]* -->', lines[1]), path
|
||||
print(f'Markdown header audit: clean ({len(files)} file(s))')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md \
|
||||
docs/templates/001-RUST_CARGO_TOOLING.md docs/templates/002-CARGO_MANIFESTS.md \
|
||||
templates/rust-cargo/Cargo.toml templates/rust-cargo/crates/project-core-lib/Cargo.toml \
|
||||
deltas/0.0.3/alpha.4.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : les trois `REPLACE` et les quatre `ADD` ci-dessus. Revue opérateur : vérifier que le manifest membre hérite seulement des champs racine présents, que les lints Clippy sont ceux des deux corpus et que la version d'exemple ainsi que le nom de crate doivent être remplacés lors d'une adoption réelle. Si Cargo n'est pas disponible dans l'environnement de PGR, le smoke workspace est indiqué comme non exécuté et le parsing TOML reste la preuve locale ; l'adoption dans un projet Rust doit exécuter sa propre gate Cargo.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Fournir séparément `history/0.0.3/alpha.4.md` avec les sorties réellement observées, l'appliquer et committer la tranche avant le delta `alpha.5` relatif aux headers Markdown.
|
||||
|
||||
### FAIL
|
||||
|
||||
Consigner le défaut dans le history, puis corriger manifests ou instructions dans `alpha.4.fix.1` sauf besoin justifié d'un nouveau REPLAN.
|
||||
90
deltas/0.0.3/alpha.5.md
Normal file
90
deltas/0.0.3/alpha.5.md
Normal file
@@ -0,0 +1,90 @@
|
||||
<!-- file: deltas/0.0.3/alpha.5.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.5 — audit des headers Markdown
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-alpha.4`, avec `history/0.0.3/alpha.4.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.4
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.5
|
||||
```
|
||||
|
||||
## Objet
|
||||
|
||||
Extraire le contrôle des headers Markdown répété en Python inline dans les gates précédentes. `scripts/audit_markdown_headers.py` vérifie une seule propriété documentaire : les deux premières lignes de chaque fichier choisi doivent déclarer son chemin relatif canonique et une révision interne positive. Le script accepte des chemins explicites depuis la racine du projet, lit sans modifier, produit des erreurs déterministes avec chemin et ligne et distingue violation de sélection invalide.
|
||||
|
||||
`docs/rules/300-DOCUMENTATION.md` possède la convention pour le corpus Markdown de PGR. La matrice inscrit l'audit mécanique séparément de la revue des rôles documentaires, de l'audit des tableaux et de celui des liens. Une révision positive ne démontre pas qu'elle a été incrémentée à bon escient : cela reste une décision de revue.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
docs/rules/300-DOCUMENTATION.md
|
||||
docs/validation/001-VALIDATION_MATRIX.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
scripts/audit_markdown_headers.py
|
||||
tests/test_markdown_headers.py
|
||||
deltas/0.0.3/alpha.5.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive livre uniquement ces fichiers complets. Aucun history `alpha.5`, réécriture historique, nouveau profil de langage ou autre audit Markdown n'est inclus.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Après application sur le commit `alpha.4`, depuis la racine du dépôt :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.5'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.4.md
|
||||
test -f history/0.0.3/alpha.4.md
|
||||
test -f deltas/0.0.3/alpha.5.md
|
||||
test ! -e history/0.0.3/alpha.5.md
|
||||
|
||||
grep -Fx '<!-- version: 2 -->' docs/rules/300-DOCUMENTATION.md
|
||||
grep -Fx '<!-- version: 8 -->' docs/validation/001-VALIDATION_MATRIX.md
|
||||
|
||||
python3 -B -m unittest discover -s tests -p test_markdown_headers.py -v
|
||||
python3 -B scripts/audit_markdown_headers.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/rules/300-DOCUMENTATION.md \
|
||||
docs/validation/001-VALIDATION_MATRIX.md scripts/audit_markdown_headers.py \
|
||||
tests/test_markdown_headers.py deltas/0.0.3/alpha.5.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : trois `REPLACE` et trois `ADD`, sans toucher à un delta ou history antérieur. Vérifier que le nouveau script reste monotâche, traite les headers faux et les chemins absents, et ne remplace ni la revue des documents ni les deux autres audits Markdown.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire séparément `history/0.0.3/alpha.5.md` avec les preuves réellement observées, l'appliquer et committer avant la tranche `alpha.6`, consacrée à la décision conditionnelle sur le template de workflow.
|
||||
|
||||
### FAIL
|
||||
|
||||
Enregistrer la défaillance et corriger ce scope dans `alpha.5.fix.1`, sauf REPLAN explicitement justifié.
|
||||
92
deltas/0.0.3/alpha.6.md
Normal file
92
deltas/0.0.3/alpha.6.md
Normal file
@@ -0,0 +1,92 @@
|
||||
<!-- file: deltas/0.0.3/alpha.6.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-alpha.6 — prompt manuel de reprise
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-alpha.5`, avec `history/0.0.3/alpha.5.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.5
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.6
|
||||
```
|
||||
|
||||
## Décision et objet
|
||||
|
||||
La comparaison des prompts `002` et `003` et des règles `210-WORKFLOW.md` confirme une répétition utile : baseline taggée, version cible, première tranche et consigne d'audit à la reprise. `003` ajoute une preuve de vérification post-tag distincte et une phrase manuelle à remettre à l'opérateur. La décision conditionnelle de la tranche est donc **retenir** une spécification courte dans `docs/templates/003-NEW_SESSION_PROMPT.md`.
|
||||
|
||||
Ce document rassemble les champs à renseigner et une forme de message manuel, avec une branche claire lorsque le rapport post-tag manque ou n'est pas `PASS`. Il ne génère rien, ne fige aucun nom de projet ni preuve et ne prépare pas encore le prompt versionné de `0.0.4`. `docs/rules/210-WORKFLOW.md` reste propriétaire de la séquence delta/history/commit et de la publication après tag ; le plan vivant enregistre la décision.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
docs/rules/210-WORKFLOW.md
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
docs/templates/003-NEW_SESSION_PROMPT.md
|
||||
deltas/0.0.3/alpha.6.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive contient uniquement ces fichiers complets. Aucun history `alpha.6`, prompt `004`, générateur, modification de prompts historiques ou changement de configuration Rust/Cargo n'est inclus.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Après application sur le commit `alpha.5`, depuis la racine du dépôt :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.6'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.5.md
|
||||
test -f history/0.0.3/alpha.5.md
|
||||
test -f deltas/0.0.3/alpha.6.md
|
||||
test -f docs/templates/003-NEW_SESSION_PROMPT.md
|
||||
test ! -e history/0.0.3/alpha.6.md
|
||||
test ! -e prompts/004-V0_0_4_START_PROMPT.md
|
||||
|
||||
grep -Fx '<!-- version: 3 -->' docs/rules/210-WORKFLOW.md
|
||||
grep -Fx '<!-- version: 6 -->' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F '### Retenu : spécification courte du prompt manuel de nouvelle session' \
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
|
||||
python3 -B scripts/audit_markdown_headers.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
git diff --check
|
||||
git add VERSION docs/rules/210-WORKFLOW.md \
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md \
|
||||
docs/templates/003-NEW_SESSION_PROMPT.md deltas/0.0.3/alpha.6.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : trois `REPLACE` et deux `ADD`. Revue opérateur : confirmer que le message manuel est actionnable sans supposer un rapport `PASS`, que son contrat versionné est distinct, que les prompts `002`/`003` restent historiques et que la préparation de `0.0.4` n'est pas anticipée.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire séparément `history/0.0.3/alpha.6.md` d'après la gate exécutée, l'appliquer et committer avant de passer à `beta.1` pour la réconciliation de release.
|
||||
|
||||
### FAIL
|
||||
|
||||
Enregistrer le diagnostic puis corriger uniquement cette spécification et ses renvois dans `alpha.6.fix.1`, sauf REPLAN justifié.
|
||||
115
deltas/0.0.3/beta.1.md
Normal file
115
deltas/0.0.3/beta.1.md
Normal file
@@ -0,0 +1,115 @@
|
||||
<!-- file: deltas/0.0.3/beta.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-beta.1 — réconciliation documentaire
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-alpha.6`, avec `history/0.0.3/alpha.6.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.6
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-beta.1
|
||||
```
|
||||
|
||||
## Objet et résultat de la revue
|
||||
|
||||
Réconcilier la navigation, les propriétaires et les contrôles après les six tranches alpha et le fix documentaire. Les sept deltas `alpha.1` à `alpha.6`, fix inclus, ont chacun un history `PASS` fourni par la gate opérateur ; leur chaîne de versions est continue depuis `0.0.2`. La règle `210` possède le workflow ; la règle `300` possède les headers Markdown ; le profil `510` possède les conventions Rust facultatives. Les documents `docs/templates/` expliquent comment adapter les cinq fichiers Rust/Cargo et le message de reprise, tandis que les scripts restent de petits contrôles de propriétés délimitées.
|
||||
|
||||
La revue relève quatre corrections de documents vivants : exposer le plan actif depuis `README.md`, ouvrir la navigation directe depuis `docs/000-README.md` et décrire son template de workflow, actualiser dans le plan l'audit des headers déjà livré, et rendre dans la matrice l'audit des liens applicable à une tranche alpha qui modifie la navigation. La réconciliation n'ajoute aucune famille normative, audit, règle de version universelle, dépendance de build ou prompt `0.0.4`. Les versions et seuils du modèle Cargo restent des exemples ou choix adaptables, et les snapshots antérieurs restent intacts.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
README.md
|
||||
docs/000-README.md
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
docs/validation/001-VALIDATION_MATRIX.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
deltas/0.0.3/beta.1.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive contient exactement ces fichiers complets. Le history de `alpha.6` est livré séparément, celui de `beta.1` n'existe pas encore ; `CHANGELOG.md`, les règles, templates techniques, scripts, tests et prompts ne sont pas modifiés.
|
||||
|
||||
## Validation opérateur
|
||||
|
||||
Après application de `history/0.0.3/alpha.6.md` et son commit, appliquer ce delta puis exécuter à la racine :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-beta.1'
|
||||
git cat-file -e HEAD:history/0.0.3/alpha.6.md
|
||||
test -f history/0.0.3/alpha.6.md
|
||||
test -f deltas/0.0.3/beta.1.md
|
||||
test ! -e history/0.0.3/beta.1.md
|
||||
test ! -e prompts/004-V0_0_4_START_PROMPT.md
|
||||
|
||||
grep -Fx '<!-- version: 5 -->' README.md
|
||||
grep -Fx '<!-- version: 3 -->' docs/000-README.md
|
||||
grep -Fx '<!-- version: 7 -->' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -Fx '<!-- version: 9 -->' docs/validation/001-VALIDATION_MATRIX.md
|
||||
|
||||
python3 -B -m unittest discover -s tests -p 'test_*.py' -v
|
||||
python3 -B scripts/audit_markdown_headers.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
import tomllib
|
||||
|
||||
tranches = ['alpha.1', 'alpha.1.fix.1', 'alpha.2', 'alpha.3',
|
||||
'alpha.4', 'alpha.5', 'alpha.6']
|
||||
version = '0.0.2'
|
||||
for name in tranches:
|
||||
delta = Path(f'deltas/0.0.3/{name}.md').read_text(encoding='utf-8')
|
||||
history = Path(f'history/0.0.3/{name}.md').read_text(encoding='utf-8')
|
||||
assert re.search(r'## Statut\s+PASS\s', history), name
|
||||
assert f'Version avant application : `{version}`.' in delta or \
|
||||
f'Version avant application :\n\n```text\n{version}\n```' in delta, name
|
||||
version = f'0.0.3-{name}'
|
||||
assert f'Version après application : `{version}`.' in delta or \
|
||||
f'Version après application :\n\n```text\n{version}\n```' in delta, name
|
||||
for path in sorted(Path('templates/rust-cargo').rglob('*.toml')):
|
||||
tomllib.loads(path.read_text(encoding='utf-8'))
|
||||
print(f'Reconciliation audit: clean ({len(tranches)} PASS histories, 5 TOML files)')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION README.md docs/000-README.md \
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md \
|
||||
docs/validation/001-VALIDATION_MATRIX.md deltas/0.0.3/beta.1.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : cinq `REPLACE` et un `ADD` exactement comme ci-dessus. Revue opérateur : confirmer que les liens pointent vers les documents propriétaires et que les valeurs du template Cargo restent des exemples adaptables ; les gates alpha déjà observées ne sont pas réinterprétées et la RC n'est pas déclarée acquise par cette prévalidation.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire séparément `history/0.0.3/beta.1.md` avec les résultats réellement observés, l'appliquer et committer `beta.1` avant de préparer `rc.1`.
|
||||
|
||||
### FAIL
|
||||
|
||||
Enregistrer le diagnostic dans le history de `beta.1`, puis corriger la réconciliation dans `beta.1.fix.1` ou faire un REPLAN explicite si le scope a changé.
|
||||
117
deltas/0.0.3/rc.1.md
Normal file
117
deltas/0.0.3/rc.1.md
Normal file
@@ -0,0 +1,117 @@
|
||||
<!-- file: deltas/0.0.3/rc.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3-rc.1 — gel du scope et préparation de release
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-beta.1`, avec `history/0.0.3/beta.1.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-beta.1
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3-rc.1
|
||||
```
|
||||
|
||||
## Objet et gel
|
||||
|
||||
La gate de `beta.1` est `PASS`. La RC gèle le scope fonctionnel : cinq modèles Rust/Cargo adaptables, deux audits facultatifs de style Rust, un audit de headers Markdown et une spécification du message manuel de reprise. La candidate `0.0.3` du changelog décrit ces résultats sans détailler les fixes ; le plan enregistre le gel et l'état observé de beta.
|
||||
|
||||
Le prompt `004` prépare le cadrage de `0.0.4` consacré aux skeleton specifications Markdown et à la composition des profils/templates. Il demande un audit de la future archive taggée `v0.0.3` et traite son rapport post-tag comme une preuve conditionnelle, jamais acquise en RC. Son message manuel doit être ajusté et remis après la publication et son contrôle réel. Aucun skeleton complet, générateur, règle normative nouvelle, audit nouveau ni projet source modifié n'appartient à `rc.1`.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
CHANGELOG.md
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
prompts/004-V0_0_4_START_PROMPT.md
|
||||
deltas/0.0.3/rc.1.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive contient exactement ces fichiers complets. Le history `beta.1` est livré séparément ; le history `rc.1` sera produit après la gate opérateur. Les histories et deltas antérieurs, les règles, modèles techniques, scripts, tests et `ROADMAP.md` restent inchangés.
|
||||
|
||||
## Gate opérateur de release candidate
|
||||
|
||||
Après application sur le commit `beta.1`, depuis la racine du dépôt :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3-rc.1'
|
||||
git cat-file -e HEAD:history/0.0.3/beta.1.md
|
||||
test -f history/0.0.3/beta.1.md
|
||||
test -f deltas/0.0.3/rc.1.md
|
||||
test -f prompts/004-V0_0_4_START_PROMPT.md
|
||||
test ! -e history/0.0.3/rc.1.md
|
||||
|
||||
grep -Fx '<!-- version: 4 -->' CHANGELOG.md
|
||||
grep -Fx '## 0.0.3 (candidate)' CHANGELOG.md
|
||||
grep -Fx '<!-- version: 8 -->' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F 'La gate opérateur de `beta.1` est `PASS`' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F 'pgr-0.0.3-publish.001-report.md' prompts/004-V0_0_4_START_PROMPT.md
|
||||
grep -F "Si le rapport manque ou n'est pas PASS" prompts/004-V0_0_4_START_PROMPT.md
|
||||
|
||||
python3 -B -m unittest discover -s tests -p 'test_*.py' -v
|
||||
python3 -B scripts/audit_markdown_headers.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
import tomllib
|
||||
|
||||
names = ['alpha.1', 'alpha.1.fix.1', 'alpha.2', 'alpha.3',
|
||||
'alpha.4', 'alpha.5', 'alpha.6', 'beta.1']
|
||||
version = '0.0.2'
|
||||
for name in names:
|
||||
delta = Path(f'deltas/0.0.3/{name}.md').read_text(encoding='utf-8')
|
||||
history = Path(f'history/0.0.3/{name}.md').read_text(encoding='utf-8')
|
||||
assert re.search(r'## Statut\s+PASS\s', history), name
|
||||
assert f'Version avant application : `{version}`.' in delta or \
|
||||
f'Version avant application :\n\n```text\n{version}\n```' in delta, name
|
||||
version = f'0.0.3-{name}'
|
||||
assert f'Version après application : `{version}`.' in delta or \
|
||||
f'Version après application :\n\n```text\n{version}\n```' in delta, name
|
||||
assert {p.stem for p in Path('deltas/0.0.3').glob('*.md')} - \
|
||||
{p.stem for p in Path('history/0.0.3').glob('*.md')} == {'rc.1'}
|
||||
for path in Path('templates/rust-cargo').rglob('*.toml'):
|
||||
tomllib.loads(path.read_text(encoding='utf-8'))
|
||||
print(f'RC integration audit: clean ({len(names)} PASS histories, 5 TOML files)')
|
||||
PY
|
||||
|
||||
git diff --check
|
||||
git add VERSION CHANGELOG.md docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md \
|
||||
prompts/004-V0_0_4_START_PROMPT.md deltas/0.0.3/rc.1.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : trois `REPLACE` et deux `ADD`. Revue opérateur : contrôler que le changelog décrit la release et non les tranches, que les exemples Cargo restent adaptables, que `004` concerne exclusivement la future `0.0.4` et que sa preuve post-tag n'est pas présumée. Une gate RC PASS n'est pas un tag ni une vérification de l'archive publiée.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Produire séparément `history/0.0.3/rc.1.md` d'après la gate observée, l'appliquer puis committer la RC avant la promotion stable `rel.001`.
|
||||
|
||||
### FAIL
|
||||
|
||||
Consigner les échecs dans le history RC et corriger le scope gelé dans `rc.1.fix.1` ; réviser le plan si un changement fonctionnel plus large s'impose.
|
||||
116
deltas/0.0.3/rel.001.md
Normal file
116
deltas/0.0.3/rel.001.md
Normal file
@@ -0,0 +1,116 @@
|
||||
<!-- file: deltas/0.0.3/rel.001.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Delta 0.0.3 rel.001 — promotion stable pré-tag
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline : `0.0.3-rc.1`, avec `history/0.0.3/rc.1.md` appliqué et committé. Ce delta MUST NOT être appliqué avant ce commit.
|
||||
|
||||
Version avant application :
|
||||
|
||||
```text
|
||||
0.0.3-rc.1
|
||||
```
|
||||
|
||||
Version après application :
|
||||
|
||||
```text
|
||||
0.0.3
|
||||
```
|
||||
|
||||
`rel.001` identifie la clôture opérationnelle ; il ne fait pas partie de la version SemVer du produit.
|
||||
|
||||
## Objet
|
||||
|
||||
Promouvoir la RC validée vers la stable `0.0.3`. La tranche finalise la présentation de la release, marque la roadmap terminée, retire la mention « candidate » du changelog et clôt le plan comme référence historique. Le prompt `004`, les règles, les modèles, les audits et les tests sont ceux validés en RC : aucune fonctionnalité, règle ou preuve post-tag nouvelle n'est introduite.
|
||||
|
||||
La validation de cette tranche est **pré-tag**. Ni le tag `v0.0.3` ni une archive téléchargée depuis Gitea ni un rapport `publish.001` ne sont déclarés existants par ce delta. Ils suivent le history PASS, le commit stable et la publication du tag.
|
||||
|
||||
## Scope
|
||||
|
||||
REPLACE :
|
||||
|
||||
```text
|
||||
VERSION
|
||||
README.md
|
||||
ROADMAP.md
|
||||
CHANGELOG.md
|
||||
docs/000-README.md
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
ADD :
|
||||
|
||||
```text
|
||||
deltas/0.0.3/rel.001.md
|
||||
```
|
||||
|
||||
DELETE : aucun.
|
||||
|
||||
L'archive contient uniquement ces fichiers complets. `history/0.0.3/rc.1.md` arrive séparément ; le history de `rel.001` sera rédigé après sa gate. Le rapport post-tag sera hors de l'archive source taggée.
|
||||
|
||||
## Validation opérateur pré-tag
|
||||
|
||||
Après application sur le commit `rc.1`, depuis la racine du dépôt :
|
||||
|
||||
```bash
|
||||
test "$(cat VERSION)" = '0.0.3'
|
||||
git cat-file -e HEAD:history/0.0.3/rc.1.md
|
||||
test -f history/0.0.3/rc.1.md
|
||||
test -f deltas/0.0.3/rel.001.md
|
||||
test -f prompts/004-V0_0_4_START_PROMPT.md
|
||||
test ! -e history/0.0.3/rel.001.md
|
||||
|
||||
grep -Fx '<!-- version: 6 -->' README.md
|
||||
grep -Fx '<!-- version: 4 -->' ROADMAP.md
|
||||
grep -Fx '<!-- version: 5 -->' CHANGELOG.md
|
||||
grep -Fx '<!-- version: 4 -->' docs/000-README.md
|
||||
grep -Fx '<!-- version: 9 -->' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F 'La release `0.0.3` fournit les premiers modèles Rust/Cargo' README.md
|
||||
grep -F 'plan historique des templates et audits `0.0.3`' README.md
|
||||
grep -F -- '- `(x) 0.0.3`' ROADMAP.md
|
||||
grep -Fx '## 0.0.3' CHANGELOG.md
|
||||
grep -F 'La gate opérateur de `rc.1` est `PASS`' docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
grep -F "La vérification de l'archive" docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
|
||||
python3 -B - <<'PY'
|
||||
from pathlib import Path
|
||||
import re
|
||||
|
||||
names = ['alpha.1', 'alpha.1.fix.1', 'alpha.2', 'alpha.3',
|
||||
'alpha.4', 'alpha.5', 'alpha.6', 'beta.1', 'rc.1']
|
||||
for name in names:
|
||||
history = Path(f'history/0.0.3/{name}.md')
|
||||
assert Path(f'deltas/0.0.3/{name}.md').is_file(), name
|
||||
assert re.search(r'## Statut\s+PASS\s', history.read_text(encoding='utf-8')), name
|
||||
assert {p.stem for p in Path('deltas/0.0.3').glob('*.md')} - \
|
||||
{p.stem for p in Path('history/0.0.3').glob('*.md')} == {'rel.001'}
|
||||
print(f'Stable history audit: clean ({len(names)} PASS histories, rel.001 pending)')
|
||||
PY
|
||||
|
||||
python3 -B scripts/audit_markdown_headers.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_tables.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
python3 -B scripts/audit_markdown_links.py \
|
||||
README.md RULES.md ROADMAP.md CHANGELOG.md docs deltas history prompts
|
||||
|
||||
git diff --check
|
||||
git add VERSION README.md ROADMAP.md CHANGELOG.md docs/000-README.md \
|
||||
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md deltas/0.0.3/rel.001.md
|
||||
git diff --cached --check
|
||||
git status --short
|
||||
```
|
||||
|
||||
Scope attendu avant ajout du history : six `REPLACE` et un `ADD` exactement comme ci-dessus. Revue opérateur : confirmer que le scope RC ne change pas, que la présentation du dépôt, le changelog et la roadmap décrivent la même stable, que le prompt `004` reste conditionnel au rapport post-tag et que les snapshots historiques restent intacts. Les `15` tests et les cinq TOML validés en RC restent des preuves utilisables parce qu'aucun code, script, test ou template n'a changé dans cette promotion.
|
||||
|
||||
## Transition
|
||||
|
||||
### PASS
|
||||
|
||||
Rédiger et livrer séparément `history/0.0.3/rel.001.md` avec le résultat réellement observé ; l'appliquer et committer la stable. Ensuite seulement, créer et publier le tag canonique `v0.0.3`, télécharger son archive source depuis Gitea, vérifier cette archive et conserver séparément la preuve post-tag `publish.001`. Le texte manuel du prompt `004` n'est remis à l'opérateur qu'après vérification de l'archive et d'un rapport post-tag PASS réel.
|
||||
|
||||
### FAIL
|
||||
|
||||
Consigner le diagnostic dans le history de `rel.001`, ne pas tagger, puis corriger la clôture dans une tranche explicite avant publication.
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/000-README.md -->
|
||||
<!-- version: 1 -->
|
||||
<!-- version: 4 -->
|
||||
|
||||
# Documentation PGR
|
||||
|
||||
@@ -11,8 +11,16 @@ Ce fichier est l'index d'entrée de la documentation structurée de Project Gove
|
||||
- [`architecture/`](architecture/) — état architectural courant de PGR et profils applicables ;
|
||||
- [`plans/`](plans/) — plans vivants des releases en cours, puis références historiques après fermeture ;
|
||||
- [`rules/`](rules/) — règles normatives détaillées, organisées progressivement par scope ;
|
||||
- [`templates/`](templates/) — instructions d'adaptation des templates techniques et spécification du message manuel de reprise ;
|
||||
- [`validation/`](validation/) — matrices de validation et contrats de preuve.
|
||||
|
||||
D'autres collections telles que `ideas/`, `studies/`, `reference/`, `formats/` ou `templates/` ne sont créées que lorsqu'un premier artefact réel les justifie.
|
||||
D'autres collections telles que `ideas/`, `studies/`, `reference/` ou `formats/` ne sont créées que lorsqu'un premier artefact réel les justifie.
|
||||
|
||||
Les répertoires workflow de racine (`deltas/`, `history/`, `handoffs/`, `manifests/`, `prompts/`, `scripts/`) restent séparés de `docs/` parce qu'ils portent le processus de développement et de livraison lui-même.
|
||||
Les templates techniques copiables sous `templates/` restent séparés des instructions documentaires sous `docs/templates/`. Les répertoires workflow de racine (`deltas/`, `history/`, `handoffs/`, `manifests/`, `prompts/`, `scripts/`) restent séparés de `docs/` parce qu'ils portent le processus de développement et de livraison lui-même.
|
||||
|
||||
## Points d'entrée de 0.0.3
|
||||
|
||||
- [`plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md`](plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md) — périmètre et décisions de la release `0.0.3` ;
|
||||
- [`templates/001-RUST_CARGO_TOOLING.md`](templates/001-RUST_CARGO_TOOLING.md) et [`templates/002-CARGO_MANIFESTS.md`](templates/002-CARGO_MANIFESTS.md) — adaptation des cinq fichiers Rust/Cargo copiables ;
|
||||
- [`templates/003-NEW_SESSION_PROMPT.md`](templates/003-NEW_SESSION_PROMPT.md) — spécification du message manuel après une stable publiée ;
|
||||
- [`validation/001-VALIDATION_MATRIX.md`](validation/001-VALIDATION_MATRIX.md) et [`validation/002-RUST_STYLE_AUDITS.md`](validation/002-RUST_STYLE_AUDITS.md) — gates PGR et limites des audits de style Rust facultatifs.
|
||||
|
||||
159
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
Normal file
159
docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
Normal file
@@ -0,0 +1,159 @@
|
||||
<!-- file: docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md -->
|
||||
<!-- version: 9 -->
|
||||
|
||||
# Plan 0.0.3 — templates initiaux et audits réutilisables
|
||||
|
||||
## Statut et sources
|
||||
|
||||
Plan de cadrage créé dans `0.0.3-alpha.1` et corrigé dans `0.0.3-alpha.1.fix.1` après sa validation mécanique. `alpha.2` intègre la convention opérateur sur les fichiers d'outillage Rust et matérialise les premiers templates ; sa gate opérateur est PASS. Après cette gate, la demande de décomposer les audits de style Rust KSP/Games modifie le calendrier prévisionnel. Le résultat REPLAN de `alpha.3` est `SPLIT` : deux audits de style ciblés sont traités d'abord, les manifests Cargo puis les headers Markdown suivent dans des tranches distinctes. Les tranches suivantes restent une prévision, non un état validé.
|
||||
|
||||
La source autoritaire est l'archive Gitea fournie `pgr-v0.0.2.zip`, issue selon l'opérateur du tag `v0.0.2`. Son SHA-256 vérifié localement est :
|
||||
|
||||
```text
|
||||
8dc5c979a4d722b4ef6ec84b6227c8cbfffb3f865f4ea9063c03ecb1e365cdc4
|
||||
```
|
||||
|
||||
Le rapport séparé `pgr-0.0.2-publish.001-report.md` indique `PASS` et donne le même hash. Il atteste la publication post-tag sans appartenir au tag. L'archive sans `.git` ne peut prouver indépendamment le commit ni l'identité du tag ; ces éléments sont les déclarations et preuves de publication de l'opérateur.
|
||||
|
||||
Le contrat de démarrage est `prompts/003-V0_0_3_START_PROMPT.md`. Les règles applicables partent de `RULES.md`, puis des familles `200`, `210`, `300`, `400`, du modèle de profils `003` et des profils `500`/`510`, `520`, `600`/`610` selon leur scope. PGR reste un dépôt documentaire doté d'outils Python ; les toolchains Rust, Java et Android ne deviennent pas des prérequis du dépôt.
|
||||
|
||||
Deux corpus de comparaison supplémentaires, fournis après le gate initial de `alpha.1`, ont été inspectés pour ce fix documentaire :
|
||||
|
||||
```text
|
||||
khadhroony-solana-project-v0.3.16.zip SHA-256 db3cc1b3fc3fb07ee864b02e2a7346c673d4cf63b33e8e872aca6c6458856ca0
|
||||
games-v0.3.5.zip SHA-256 5f5fdee1a271386766d059657d6eaa831acdc263b3e722fed738808335c0a105
|
||||
```
|
||||
|
||||
Ce sont des sources de comparaison pour les décisions de templates et d'audits, non la baseline PGR et non des dépendances de build. Leur présence ne rend pas les conventions locales de KSP ou Games normatives pour tous les projets.
|
||||
|
||||
## Audit indépendant de la stable `v0.0.2`
|
||||
|
||||
L'inspection de l'archive, sa lecture et la comparaison des fichiers extraits avec les membres ZIP ont établi :
|
||||
|
||||
- ZIP lisible, `94` entrées : `78` fichiers et `16` répertoires, une seule racine `pgr/` ; aucun doublon, chemin absolu, traversée `..`, chemin Windows ambigu ou lien symbolique ;
|
||||
- exactement `78` fichiers extraits ; `VERSION` contient `0.0.2` avec un seul retour final à la ligne ; `.git` absent comme attendu ;
|
||||
- octets des fichiers distribués décodables en UTF-8, sans NUL, CR, espace de fin de ligne ou retour final manquant ;
|
||||
- `73` fichiers Markdown dont les deux premières lignes correspondent exactement au chemin relatif `file` et à une révision positive `version` ;
|
||||
- contrôle local des deux scripts existants : `Markdown table audit: clean (2 table(s), 73 file(s))` et `Markdown link audit: clean (50 local link(s), 73 file(s))` ;
|
||||
- aucun répertoire de build/cache ou fichier local sensible connu dans les chemins distribués ; seule la préférence Eclipse UTF-8 intentionnellement conservée est présente sous `.settings/`.
|
||||
|
||||
La vérification de structure et de gouvernance a constaté :
|
||||
|
||||
- `12` deltas et `12` histories appariés exactement dans chacune des séries `0.0.1` et `0.0.2`, y compris `rel.001` ; chaque history possède un statut explicite ;
|
||||
- les versions `avant`/`après` déclarées dans tous les deltas `0.0.2` forment une chaîne continue de `0.0.1` à `0.0.2` ; les deltas `0.0.1` au format homogène depuis `alpha.1.fix.2` forment également une chaîne continue jusqu'à la stable ;
|
||||
- dans `0.0.1`, les `FAIL` de `alpha.1`, `alpha.1.fix.1`, `alpha.4` et `rc.1` sont suivis d'une tranche corrective `PASS` ; dans `0.0.2`, même traitement pour `alpha.1`, `alpha.4`, `beta.1` et `rc.1` ; les deux `rel.001` sont `PASS` ;
|
||||
- `README.md`, `ROADMAP.md` et `CHANGELOG.md` présentent `0.0.2` comme terminé et `0.0.3` comme prévu ; les plans `001` et `002` restent historiques ; le prompt `003` nomme l'archive et la preuve post-tag fournies ;
|
||||
- séparation cohérente entre objectifs durables, architecture, règles normatives, validation, plans, deltas prospectifs, histories rétrospectifs et changelog stable ; les index pointent vers les familles et profils réellement présents ;
|
||||
- les profils réellement matérialisés sont `510` Rust/Cargo, `520` Java/Maven/Gradle et `610` Android ; les seuls scripts d'audit PGR sont ceux des tableaux et des liens Markdown locaux. Aucun skeleton, générateur ou profil différé n'est présent.
|
||||
|
||||
Aucun écart bloquant n'a été constaté dans ces contrôles. Les scripts Markdown ont chacun une portée volontairement limitée : le contrôle des liens vérifie l'existence des cibles inline locales, pas les ancres ; celui des tableaux vérifie leur structure source. Leur PASS n'atteste donc pas des propriétés hors de leur contrat.
|
||||
|
||||
## Comparaison réelle des corpus Rust
|
||||
|
||||
KSP `0.3.16` et Games `0.3.5` possèdent chacun un workspace Cargo virtuel avec `resolver = "3"` et centralisent réellement dans `[workspace.package]` `version`, `edition`, `license`, `repository`, `authors` et `publish`. Ils utilisent `[workspace.dependencies]` pour des dépendances tierces, mais avec respectivement `37` et `19` entrées propres à leur projet. Les deux racines déclarent les mêmes trois lints Rust de base (`missing_docs`, `unreachable_pub`, `unsafe_code`) et les mêmes `18` niveaux Clippy ; les éventuels `allow` doivent être revus un par un avant réemploi.
|
||||
|
||||
Les `22` crates KSP héritent des lints workspace par `[lints] workspace = true`. Parmi `23` crates Games, `22` utilisent ce même héritage ; l'entrée Android déclare des lints locaux pour ajuster `unsafe_code` à sa frontière FFI. La capacité d'exception locale est donc réelle et doit être expliquée sans rendre l'exception Android générale.
|
||||
|
||||
Les deux `rustfmt.toml` ont un contenu technique identique et seulement un numéro de révision de fichier différent. Les deux `clippy.toml` partagent leurs seuils principaux et divergent sur les identifiants courts autorisés et quelques entrées vides. L'opérateur confirme qu'il réutilise ces conventions comme baseline de départ, telles quelles ou avec de petites adaptations. Les deux `.cargo/config.toml` déplacent les artefacts de build vers `../builds/<projet>/target/` ; Games ajoute des flags Web propres à sa cible. La configuration générique de déplacement est donc retenue avec un nom de projet à remplacer.
|
||||
|
||||
## Sélection des templates
|
||||
|
||||
### Retenu : famille Rust/Cargo minimale
|
||||
|
||||
Le besoin concret n'est pas limité à `rustfmt.toml`. La première famille doit couvrir cinq responsabilités distinctes :
|
||||
|
||||
1. `rustfmt.toml` : options communes dont la valeur est justifiée ; alignement de `edition` avec le projet destinataire ; ne pas reprendre mécaniquement chaque préférence des deux sources ;
|
||||
2. configuration Clippy : niveaux de lint Rust/Clippy dans les sections Cargo `[workspace.lints.rust]` et `[workspace.lints.clippy]`, plus `clippy.toml` pour les seuils et réglages conservés dans le profil de départ éprouvé ; chaque projet peut adapter ces choix ;
|
||||
3. `.cargo/config.toml` : `target-dir` et `build-dir` vers un dossier frère `../builds/<projet>/target/`, après remplacement explicite du nom ; les flags Web et les autres particularités restent locaux ;
|
||||
4. `Cargo.toml` workspace : sections `[workspace]`, `[workspace.package]`, `[workspace.dependencies]` et `[workspace.lints.*]` avec les responsabilités et champs de décision explicités ; `VERSION` doit correspondre à `workspace.package.version` seulement pour une unité de release commune ;
|
||||
5. `Cargo.toml` d'une crate membre ordinaire : identité locale, héritage explicite des métadonnées communes et des lints, et dépendances/features limitées aux besoins de la crate. Une adaptation locale des lints doit être documentée comme exception ciblée ; elle ne devient pas un deuxième jeu de valeurs globales.
|
||||
|
||||
Ces fichiers ou extraits doivent être copiables et compréhensibles sans figer le nom de projet, la version, les dépendances, le layout de toutes les crates, la publication, la toolchain ni le minimum de plateforme. Lorsqu'un champ obligatoire ne peut pas avoir de valeur générique sûre, des instructions Markdown guident son remplacement avant l'usage ; un fichier TOML présenté comme prêt à l'emploi doit être valide. Les crates bibliothèque et application peuvent partager un tronc commun, leurs différences réelles restant documentées sans créer des dizaines de variantes.
|
||||
|
||||
Pour la validation, comparer les templates au profil `510`, parser les configs/manifests avec un parseur TOML et exercer sur un workspace d'essai les héritages et le cas d'une exception locale quand les toolchains sont disponibles. Tester `rustfmt` et Clippy pour les réglages réellement livrés dans un projet Rust concerné ; une compilation de KSP/Games n'est pas une gate de PGR.
|
||||
|
||||
### Retenu : spécification courte du prompt manuel de nouvelle session
|
||||
|
||||
Les prompts `002` et `003` répètent la transmission de la baseline taggée, de la cible et de la première tranche ; `003` ajoute le rapport post-tag et le texte manuel remis à l'opérateur. Après comparaison, `alpha.6` retient une courte spécification Markdown des champs et de la phrase de reprise. Elle facilite la prochaine clôture sans créer un générateur, un nouveau prompt versionné prématuré ou une copie du plan. Le rapport ne devient un champ rempli que s'il existe et que son résultat est réellement connu.
|
||||
|
||||
### Différés
|
||||
|
||||
Les fichiers Maven/Gradle complets, wrappers, Android `local.properties` ou signing, règles `.gitignore` universelles et versions de dépendances ne sont pas copiés par anticipation. Games fournit un exemple Android concret, mais sa matrice AGP/Gradle/JDK, son build natif et ses flags Cargo Web restent propres à ce projet. Les wrappers restent soumis aux outils officiels et à la décision du projet ; un `local.properties` entièrement régénéré ne justifie pas d'exemple.
|
||||
|
||||
Les spécifications complètes de skeleton restent réservées à `0.0.4` ; Rust/JNI, Web/WASM, Tauri et les autres profils différés n'entrent pas dans cette release par simple proximité technologique.
|
||||
|
||||
## Sélection des audits et patterns
|
||||
|
||||
Les trois audits Markdown (`headers`, `tables`, `liens locaux`) restent séparés : une propriété chacun, sélection explicite des chemins et lecture seule. L'audit des headers, livré en `alpha.5`, applique le contrat de `docs/rules/300-DOCUMENTATION.md` avec des cas positifs et négatifs ciblés ; il ne juge ni le rôle du document ni la pertinence de l'incrément de sa révision.
|
||||
|
||||
La comparaison des scripts Python KSP `0.3.16` et Games `0.3.5` montre que `audit_rust_general_rules.py` (~580 lignes dans chaque corpus) mélange headers et versions Rust, imports, rustdoc, structure des items, blancs, constantes et modules. `audit_rust_export_completeness.py` possède le contrat particulier des façades et réexports ; KSP ajoute `audit_ksp_workspace_rules.py` pour manifests/frontières/tracing, tandis que Games regroupe plusieurs intégrations Web/Android/Gradle dans `audit_distribution_layout.py`. `audit_rust_workspace_rules.py` est un orchestrateur ; il peut rester un lanceur sans devenir propriétaire de ces contrats.
|
||||
|
||||
| Propriété | Owner | Suite |
|
||||
|------------------------------------------|-------------------------|----------------------------------------|
|
||||
| Ordre interne des `use` et `mod` | Rustfmt | `cargo fmt --all -- --check` |
|
||||
| Diagnostics du langage et des lints | Rust/Clippy | Outils officiels du projet |
|
||||
| Espacement des lignes vides | Profil `510` facultatif | `audit_rust_blank_lines.py` |
|
||||
| Blocs de constantes racine | Profil `510` facultatif | `audit_rust_const_blocks.py` |
|
||||
| Headers, rustdoc, API, tests, plateforme | Profils locaux | Audits séparés uniquement si justifiés |
|
||||
|
||||
Le balayage préalable des vrais sources `crates/**/src/**/*.rs` donne `300` fichiers KSP et `59` Games. Le contrôle des blancs passe les deux corpus. Un tri naïf de toutes les constantes racine trouve `17` signaux dans KSP et zéro dans Games ; plusieurs listes KSP sont ordonnées par contrat de protocole ou de schéma. Cela interdit de déclarer le tri globalement obligatoire ou de corriger ces fichiers sans revue. Les scripts livrés sont des patrons facultatifs : le propriétaire d'un projet choisit le sous-ensemble de sources concerné, applique `cargo fmt` avant ces audits et conserve l'ordre sémantique là où il existe. Un petit helper lexical partagé masque commentaires et littéraux ; il n'est pas un troisième audit ni un parseur Rust exhaustif. Les limites et le mode d'emploi sont dans `docs/validation/002-RUST_STYLE_AUDITS.md`.
|
||||
|
||||
Les autres candidats demeurent conditionnels : miroir `VERSION`/`workspace.package.version` si une release unit est partagée, héritage explicite des lints dans les crates et façade publique seulement lorsqu'un projet possède ce contrat. Aucun audit spécialisé de ces domaines ni de layout Android/Web n'est justifié par le dépôt documentaire PGR lui-même.
|
||||
|
||||
## Trajectoire prévisionnelle
|
||||
|
||||
### alpha.1 — intake et dimensionnement
|
||||
|
||||
Enregistrer l'audit de la stable, confronter le prompt au dépôt réel, inventorier les candidats, fixer le scope et produire le présent plan ainsi que le delta. Aucune matérialisation technique importante. Attendre la validation opérateur, le history distinct et le commit avant tout delta suivant.
|
||||
|
||||
### alpha.1.fix.1 — correction documentaire du plan
|
||||
|
||||
Après le history et le commit de `alpha.1`, documenter la comparaison réelle de KSP/Games, élargir les templates Rust à Cargo et Clippy et redimensionner les tranches. Aucun template ou audit nouveau dans ce fix.
|
||||
|
||||
### alpha.2 — outillage Rust/Cargo partagé
|
||||
|
||||
Créer les templates `rustfmt.toml`, `clippy.toml` et `.cargo/config.toml` à partir du noyau éprouvé dans KSP et Games. Documenter les responsabilités distinctes : formatage, paramètres Clippy, sortie Cargo hors du dépôt. Le nom du projet, l'édition Rust et les seuils ajustables sont explicités au point de copie ; vérifier syntaxe et chemins relatifs. Les niveaux de lint dans `Cargo.toml` restent à `alpha.4` après le REPLAN, qui les reliera au profil Clippy retenu.
|
||||
|
||||
### alpha.3 — audits de style Rust découpés (REPLAN : SPLIT)
|
||||
|
||||
Suite à la demande post-gate `alpha.2`, isoler deux contrôles réutilisables des scripts composites KSP/Games : espacement des lignes vides et blocs de constantes racine sans ordre sémantique. Posséder leur convention facultative dans le profil `510`, documenter sélection/limites et exécuter des cas ciblés positifs et négatifs. Vérifier sur les corpus réels que les ordres contractuels ne deviennent pas de faux changements imposés. Les manifests initialement prévus ici passent à `alpha.4` : aucune validation anticipée n'est déduite du PASS de `alpha.2`.
|
||||
|
||||
### alpha.4 — manifests Cargo workspace et crate membre
|
||||
|
||||
Fournir des modèles minimaux de `Cargo.toml` racine et membre, incluant l'héritage des métadonnées et des lints et une explication des variations de scope. Vérifier les exemples sur un workspace d'essai lorsque la toolchain est disponible, sans recopier les listes de dépendances, versions et chemins de KSP/Games. Si les modèles exigent trop de décisions pour former des fichiers TOML valides, livrer des extraits complets avec procédure de substitution documentée, sans prétendre qu'un placeholder est prêt à compiler.
|
||||
|
||||
### alpha.5 — audit de headers Markdown
|
||||
|
||||
Extraire le contrôle récurrent en un script read-only monotâche, documenter sa portée dans la matrice et vérifier des cas positifs et négatifs utiles. Ne pas fusionner cet audit avec les deux audits Markdown existants.
|
||||
|
||||
### alpha.6 — décision sur le template de workflow
|
||||
|
||||
La comparaison des prompts `002` et `003` confirme une répétition utile à factoriser : baseline source, preuve post-tag éventuelle, prompt versionné et gate d'intake. Livrer une spécification courte de rédaction manuelle, détenue par `210-WORKFLOW.md`, sans générateur ni prompt de version suivante avant la clôture stable. Le template reste distinct des configurations Rust/Cargo et ne modifie pas les prompts historiques.
|
||||
|
||||
### beta.1 — réconciliation
|
||||
|
||||
Vérifier ownership, navigation, séparation règle/template/audit, absence de versions universelles arbitraires et proportion des contrôles. Aucun nouveau domaine majeur sans REPLAN.
|
||||
|
||||
La revue préparatoire de cette tranche a constaté que les sept deltas `0.0.3` de `alpha.1` à `alpha.6`, fix inclus, forment une chaîne de versions continue depuis `0.0.2` et possèdent chacun un history `PASS` fondé sur la gate opérateur. Les propriétaires restent distincts : profil `510` pour les conventions Rust facultatives, règles `210` et `300` pour workflow et headers, documents de `docs/templates/` pour l'adaptation, scripts monotâches pour les contrôles. Leurs validations ciblées avaient été acquises dans les tranches précédentes ; `beta.1` a vérifié leur intégration et la navigation sans exiger de nouveau build des projets sources.
|
||||
|
||||
Trois écarts documentaires justifiaient le delta : l'index de `docs/` présentait tous ses templates comme techniques alors que le troisième décrit la reprise de session ; le plan désignait toujours les headers Markdown comme candidat après leur livraison ; la matrice réservait l'audit de liens à `beta/RC/stable` alors que les gates `alpha` l'emploient également sur des changements de navigation. L'index racine ne pointait pas vers le plan actif. Ces renvois ont été corrigés dans les documents vivants sans modifier les snapshots ni les choix de version `0.1.0` et d'édition `2024` explicitement présentés comme exemples adaptables dans les manifests et instructions Rust/Cargo.
|
||||
|
||||
### rc.1 — gate de release candidate
|
||||
|
||||
Geler le scope, préparer le changelog et le prompt de la version suivante si la trajectoire est confirmée ; exécuter la gate documentaire et les vérifications ciblées des scripts réellement ajoutés.
|
||||
|
||||
La gate opérateur de `beta.1` est `PASS` : `15` tests ciblés, trois audits Markdown, chaîne des sept histories alpha et cinq TOML vérifiés. Son résultat détaillé appartient à `history/0.0.3/beta.1.md`. À l'entrée de `rc.1`, le scope est gelé sur les cinq fichiers Rust/Cargo avec leurs deux guides techniques, la spécification du message manuel, les deux audits de style Rust facultatifs et l'audit des headers Markdown. Les règles et scripts antérieurs restent en place ; aucun profil technologique nouveau, générateur ou skeleton complet n'entre dans cette release.
|
||||
|
||||
La RC a préparé une entrée candidate `0.0.3` dans le changelog et le prompt `004` de `0.0.4`. La gate opérateur de `rc.1` est `PASS` : `15` tests, trois audits Markdown, chaîne des huit histories précédents et cinq TOML vérifiés. Son résultat détaillé appartient à `history/0.0.3/rc.1.md`. La première tranche de `0.0.4` décidera des skeleton specifications réellement justifiées après audit de la stable publiée ; son rapport post-tag reste une preuve ultérieure distincte.
|
||||
|
||||
### stable — 0.0.3
|
||||
|
||||
Promouvoir la RC validée, produire le history de clôture pré-tag, committer et tagger, puis contrôler séparément l'archive du tag publiée.
|
||||
|
||||
Le delta `rel.001` prépare mécaniquement la version stable `0.0.3` : `VERSION`, statut de la roadmap, présentation du dépôt et des index, et conversion de l'entrée candidate du changelog en entrée stable. Ce plan devient une référence historique à la clôture, sans ajout de règle, profil, template ou audit. Le résultat réel de la gate pré-tag appartient à `history/0.0.3/rel.001.md`, fourni après exécution opérateur ; commit et tag `v0.0.3` suivent uniquement un PASS. La vérification de l'archive effectivement publiée depuis le tag constitue ensuite une preuve post-tag séparée, typiquement `publish.001`, et ne doit pas être présumée par le history pré-tag.
|
||||
|
||||
## Points de décision et validation
|
||||
|
||||
Le résultat `SPLIT` de `alpha.3` répond à la découverte post-gate de contrôles de style Rust utiles mais mêlés dans deux scripts de référence. Le plan doit encore être revu si les manifests Cargo exigent des choix de projet incompatibles avec un modèle minimal, si l'audit de headers ne peut rester fiable et monotâche, si le template de workflow duplique le plan, ou si un autre examen des corpus révèle des contraintes nouvelles. Un REPLAN explicite indique `CONTINUE`, `SPLIT`, `CONTINUE-NEXT-SESSION` ou `ABANDON` ; la durée d'une conversation ne crée pas une nouvelle version.
|
||||
|
||||
La validation `alpha.1` a porté sur l'identité de `VERSION`, la portée du delta, les headers et audits Markdown, l'absence de changement historique rétroactif et le contrôle Git du dépôt de l'opérateur. Ses résultats observés sont conservés dans `history/0.0.3/alpha.1.md`. Le fix documentaire décrit ci-dessus possède sa propre gate et son propre history : le PASS de `alpha.1` ne vaut pas validation anticipée de `alpha.1.fix.1`.
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/210-WORKFLOW.md -->
|
||||
<!-- version: 2 -->
|
||||
<!-- version: 3 -->
|
||||
|
||||
# Workflow artifact rules
|
||||
|
||||
@@ -193,6 +193,8 @@ Le prompt :
|
||||
|
||||
Une interruption au milieu d'une version MUST NOT produire artificiellement le prompt de la version suivante.
|
||||
|
||||
Lors d'une nouvelle session ouverte depuis une stable publiée, une courte consigne manuelle MAY identifier l'archive du tag, le rapport post-tag lorsqu'il existe réellement, le prompt versionné à lire et la première gate. [`../templates/003-NEW_SESSION_PROMPT.md`](../templates/003-NEW_SESSION_PROMPT.md) décrit une forme réutilisable ; elle ne remplace ni le prompt versionné ni la preuve de publication.
|
||||
|
||||
## Handoff
|
||||
|
||||
Un handoff est un snapshot de continuité utilisé lorsqu'un travail doit être repris sans changer artificiellement de version ou de tranche.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/300-DOCUMENTATION.md -->
|
||||
<!-- version: 1 -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Documentation rules
|
||||
|
||||
@@ -165,6 +165,8 @@ La syntaxe de commentaire dépend du format. Pour Markdown :
|
||||
<!-- version: 1 -->
|
||||
```
|
||||
|
||||
Dans le dépôt PGR, `README.md`, `RULES.md`, `ROADMAP.md`, `CHANGELOG.md` et les fichiers Markdown gouvernés sous `docs/`, `deltas/`, `history/` et `prompts/` MUST placer ces deux commentaires sur leurs deux premières lignes. Le `file` MUST être le chemin relatif depuis la racine du dépôt et `version` MUST être un entier positif sans zéro initial. `scripts/audit_markdown_headers.py` contrôle mécaniquement ces deux champs pour les chemins explicitement sélectionnés. Ce contrôle ne juge ni le contenu du document, ni si le numéro de révision a réellement été incrémenté lors d'un changement.
|
||||
|
||||
`file` identifie le chemin relatif canonique du fichier.
|
||||
|
||||
`version` est une révision interne du fichier. Elle est indépendante de `VERSION`, de SemVer produit, des versions de protocole, de schema ou de package.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/rules/510-RUST_CARGO.md -->
|
||||
<!-- version: 1 -->
|
||||
<!-- version: 2 -->
|
||||
|
||||
# Profil Rust / Cargo
|
||||
|
||||
@@ -129,7 +129,11 @@ L'édition de ce fichier MUST rester cohérente avec l'édition réellement util
|
||||
|
||||
Après une modification Rust, `cargo fmt --all` applique le formatage canonique puis `cargo fmt --all -- --check` vérifie l'état livré. Une modification produite uniquement par le formatter officiel ne crée pas artificiellement une nouvelle révision documentaire d'un fichier si aucun contenu réel n'a changé.
|
||||
|
||||
Les micro-règles de mise en page qui ne sont pas communes aux corpus ou qui sont déjà correctement possédées par `rustfmt` ne sont pas élevées automatiquement au niveau PGR.
|
||||
Le profil de style strict supplémentaire peut être adopté par un projet qui souhaite appliquer les conventions KSP/Games. Dans ce scope choisi, les lignes vides consécutives SHOULD être supprimées, ainsi que les lignes vides à l'intérieur des fonctions/méthodes et des définitions `struct`/`enum`. Ces propriétés ne sont pas entièrement possédées par Rustfmt. L'audit facultatif `scripts/audit_rust_blank_lines.py` contrôle ces deux formes d'espacement sur les seuls fichiers Rust sélectionnés.
|
||||
|
||||
Les constantes de module qui constituent un bloc homogène sans ordre sémantique SHOULD être regroupées dans l'ordre `pub`, `pub(crate)`, privé, puis par nom dans chaque visibilité : aucune ligne vide entre constantes d'une même visibilité et exactement une entre niveaux différents. `scripts/audit_rust_const_blocks.py` vérifie cette convention uniquement sur les constantes au niveau racine des fichiers choisis. Son exécution requiert une sélection explicite des fichiers pour lesquels cet ordre est réellement souhaité. Une table de protocole, une séquence de migrations ou tout autre ordre contractuel conserve son ordre propre ; le lecteur ne doit pas réordonner une telle séquence pour faire passer l'audit.
|
||||
|
||||
L'ordre des `use`, réexports et déclarations `mod` que Rustfmt sait réordonner dans ses groupes appartient au formatteur ; les modules de test après les modules de production et l'organisation d'une façade relèvent de leur contrat local, avec revue ou audit dédié seulement si celui-ci apporte une preuve fiable. Les règles rustdoc et d'API conservent leurs propriétaires ci-dessus. Les scripts PGR ne prétendent pas parser toutes les macros ou les items Rust : une décision sémantique reste une revue.
|
||||
|
||||
## Configuration Cargo et artefacts générés
|
||||
|
||||
@@ -188,4 +192,4 @@ Lorsqu'une règle Rust devient objectivement automatisable dans un projet ou ske
|
||||
|
||||
Un éventuel wrapper d'orchestration MAY appeler plusieurs audits, mais chaque audit propriétaire doit conserver une responsabilité identifiable et rester read-only.
|
||||
|
||||
Aucun nouvel audit Rust n'est imposé par cette tranche à PGR lui-même : le dépôt PGR courant ne contient pas de workspace Rust sur lequel une telle gate fournirait une preuve réelle.
|
||||
Les deux audits de style disponibles sont documentés dans [`../validation/002-RUST_STYLE_AUDITS.md`](../validation/002-RUST_STYLE_AUDITS.md). Ils restent optionnels et prennent un corpus Rust explicitement sélectionné ; le dépôt PGR lui-même ne contient pas de workspace Rust sur lequel une telle gate fournirait une preuve réelle.
|
||||
|
||||
45
docs/templates/001-RUST_CARGO_TOOLING.md
vendored
Normal file
45
docs/templates/001-RUST_CARGO_TOOLING.md
vendored
Normal file
@@ -0,0 +1,45 @@
|
||||
<!-- file: docs/templates/001-RUST_CARGO_TOOLING.md -->
|
||||
<!-- version: 3 -->
|
||||
|
||||
# Templates d'outillage Rust/Cargo
|
||||
|
||||
## Rôle et sélection
|
||||
|
||||
Ces trois fichiers fournissent une baseline de configuration issue des conventions réellement utilisées dans KSP et Games. Ils s'appliquent à un projet Rust/Cargo qui choisit ce profil d'outillage ; ils ne créent pas une dépendance vers PGR après copie.
|
||||
|
||||
- [`rustfmt.toml`](../../templates/rust-cargo/rustfmt.toml) — formatage canonique, avec notamment largeur `160` et édition `2024` dans l'exemple ;
|
||||
- [`clippy.toml`](../../templates/rust-cargo/clippy.toml) — paramètres de lints (seuils, exceptions de tests, identifiants courts) issus du noyau partagé des deux projets ;
|
||||
- [`.cargo/config.toml`](../../templates/rust-cargo/.cargo/config.toml) — emplacements des artefacts Cargo hors de la racine source.
|
||||
|
||||
Les niveaux `deny`, `allow`, `warn` et `forbid` des lints Rust/Clippy appartiennent au `Cargo.toml` du workspace, selon [`510-RUST_CARGO.md`](../rules/510-RUST_CARGO.md). `clippy.toml` règle des paramètres de lints, pas leur niveau. Les deux modèles Cargo et l'héritage `[lints] workspace = true` sont documentés dans [`002-CARGO_MANIFESTS.md`](002-CARGO_MANIFESTS.md).
|
||||
|
||||
## Copier et adapter
|
||||
|
||||
Copier ces fichiers aux chemins suivants dans le projet destinataire :
|
||||
|
||||
```text
|
||||
rustfmt.toml
|
||||
clippy.toml
|
||||
.cargo/config.toml
|
||||
```
|
||||
|
||||
Adapter le header `# file:` de chacun à son nouveau chemin relatif. Comme il s'agit de nouveaux fichiers locaux, leur révision interne commence à `1` si le projet suit cette convention. Vérifier les choix avant de les utiliser :
|
||||
|
||||
1. `rustfmt.toml` : aligner `edition` sur l'édition déclarée dans le manifeste du projet. La largeur et les autres options constituent la convention de départ de KSP/Games et peuvent être ajustées pour le projet ;
|
||||
2. `clippy.toml` : revoir les seuils au regard des types et API du projet ; adapter `allowed-idents-below-min-chars` à ses abréviations réelles. Les exceptions `allow-*-in-tests` sont une décision explicite du profil retenu ; elles ne relâchent pas les lints de production ;
|
||||
3. `.cargo/config.toml` : remplacer `project-name` par un identifiant propre au projet pour éviter la collision de deux workspaces sous `../builds/`. Depuis une configuration placée dans `<racine>/.cargo/`, Cargo résout ici les chemins relatifs par rapport à `<racine>/` : la sortie se trouve donc sous le dossier frère `<parent>/builds/<projet>/target/` ;
|
||||
4. conserver les deux entrées `target-dir` et `build-dir` lorsque cette politique est choisie. Elles ciblent volontairement le même dossier, même si Cargo utilise actuellement `target-dir` comme valeur par défaut de `build-dir` ;
|
||||
5. ajouter séparément les flags de cible, chemins particuliers ou ajustements Clippy nécessaires à un projet. Les flags Web présents dans Games ne sont pas un défaut de tous les projets Rust.
|
||||
|
||||
Le chemin de sortie sous `builds/` est externe au dépôt source ; il ne doit pas être inclus dans les archives du projet. Si l'environnement impose un autre emplacement, ajuster la configuration du projet au lieu de copier un chemin machine depuis KSP ou Games.
|
||||
|
||||
## Validation dans un projet Rust
|
||||
|
||||
Après adaptation, les contrôles utiles dépendent du code et des manifests effectivement présents :
|
||||
|
||||
```bash
|
||||
cargo fmt --all -- --check
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
Vérifier l'emplacement effectif des artefacts sur un build ou un check pertinent. La validation de PGR lui-même peut vérifier la syntaxe TOML et la cohérence des chemins sans demander de compiler un workspace Rust absent de son dépôt.
|
||||
47
docs/templates/002-CARGO_MANIFESTS.md
vendored
Normal file
47
docs/templates/002-CARGO_MANIFESTS.md
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
<!-- file: docs/templates/002-CARGO_MANIFESTS.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Modèles de manifests Cargo workspace et crate membre
|
||||
|
||||
## Rôle des deux fichiers
|
||||
|
||||
Le [manifest racine](../../templates/rust-cargo/Cargo.toml) est celui d'un workspace virtuel à une unité de release ; le [manifest membre](../../templates/rust-cargo/crates/project-core-lib/Cargo.toml) montre une crate bibliothèque ordinaire. Les deux fichiers forment un exemple TOML syntaxiquement valide. Après copie dans un nouveau projet, il faut aussi fournir le code source de la crate avant de demander à Cargo de la compiler. Le dépôt PGR ne devient pas lui-même un workspace Cargo.
|
||||
|
||||
Ces modèles prolongent les trois configurations de [`001-RUST_CARGO_TOOLING.md`](001-RUST_CARGO_TOOLING.md). Le propriétaire des choix normatifs reste [`510-RUST_CARGO.md`](../rules/510-RUST_CARGO.md). Les chemins `project-core-lib`, le nom du package et la version `0.1.0` sont des **valeurs d'exemple à remplacer** : cette version ne reflète pas `VERSION` de PGR et ne définit pas la version d'un autre projet.
|
||||
|
||||
## Adopter le manifest racine
|
||||
|
||||
Copier `templates/rust-cargo/Cargo.toml` vers `Cargo.toml` du projet, corriger son header `# file:` et commencer sa propre révision de fichier à `1`. Adapter `members` aux répertoires qui existent effectivement, puis choisir la version canonique de l'unité de release. Lorsque toutes les crates partagent une seule release, aligner `[workspace.package].version` sur le `VERSION` de ce projet ; plusieurs unités de release indépendantes ne doivent pas hériter d'une version fictive commune.
|
||||
|
||||
L'édition `2024` et `resolver = "3"` sont cohérents avec l'exemple [`rustfmt.toml`](../../templates/rust-cargo/rustfmt.toml). Pour un workspace virtuel, fixer explicitement le resolver souhaité ; adapter ensemble l'édition, Rustfmt et la toolchain compatible si le projet prend d'autres valeurs. `publish = false` est un défaut prudent pour cet exemple ; définir la politique de publication réelle avant de publier une crate.
|
||||
|
||||
`license`, `repository` et `authors` ne sont volontairement pas renseignés avec des identités fictives. Si ces métadonnées ont une valeur vraie et commune, les déclarer dans `[workspace.package]` et les hériter explicitement dans chaque crate concernée, par exemple `license.workspace = true` seulement après avoir déclaré `license` à la racine. Ne pas imposer un auteur, une licence ou une URL propres à KSP/Games.
|
||||
|
||||
Le bloc `[workspace.dependencies]` est vide tant qu'aucune dépendance concrète ne sert plusieurs crates. Déclarer à la racine seulement les contraintes et features réellement communes ; les features propres à un membre sont activées sur sa dépendance locale. Cargo ajoute les features demandées au membre à celles déjà sélectionnées au workspace ; éviter d'activer globalement une feature de test ou de plateforme par facilité. Les dépendances de test appartiennent à `[dev-dependencies]` du membre qui les utilise.
|
||||
|
||||
Les trois lints Rust et les `18` niveaux Clippy reprennent la politique partagée observée dans KSP et Games. Les `allow` retiennent leurs choix de style explicite, notamment `needless_return` malgré `implicit_return = "deny"`, et évitent qu'un lint de suggestion réécrive systématiquement ce style. Réviser leur pertinence pour le projet avant adoption. Les seuils et réglages supplémentaires appartiennent au [`clippy.toml`](../../templates/rust-cargo/clippy.toml) distinct : ce fichier ne définit aucun niveau de lint.
|
||||
|
||||
## Adopter le manifest membre
|
||||
|
||||
Copier le membre vers `crates/<nom>/Cargo.toml`, adapter `name`, son chemin dans `members` et le header `# file:`. `version.workspace = true`, `edition.workspace = true` et `publish.workspace = true` rendent visibles les héritages choisis ; ajouter séparément `license.workspace = true`, `repository.workspace = true` ou `authors.workspace = true` si les valeurs existent à la racine et concernent cette crate. `[lints] workspace = true` est requis pour reprendre les niveaux du workspace : leur présence à la racine ne suffit pas à les appliquer automatiquement aux membres.
|
||||
|
||||
Le bloc `[dependencies]` vide se remplit selon les besoins de la crate. Pour une dépendance déjà déclarée sous `[workspace.dependencies]`, utiliser localement `nom = { workspace = true }`, avec `features = [...]` au besoin. Pour une dépendance strictement locale, choisir sa contrainte directement dans ce membre ; aucune liste tierce arbitraire n'est copiée par ce modèle.
|
||||
|
||||
Une application binaire peut reprendre les mêmes héritages après adaptation du nom, du layout et de sa cible `src/main.rs` ; ne pas fabriquer un deuxième manifest quasi identique. Une crate à version ou politique de publication réellement indépendante doit déclarer ses valeurs locales et ne plus hériter ces champs par automatisme.
|
||||
|
||||
## Exception locale de lints
|
||||
|
||||
Une frontière FFI peut avoir besoin de `unsafe_code = "allow"` dans une crate particulière, comme l'entrée Android observée dans Games. Cette exception demande justification, portée étroite et validation du code `unsafe` concerné. Cargo ne permet pas de combiner `workspace = true` avec des définitions de lints locaux dans le même manifest membre : retirer l'héritage `[lints]` pour cette crate et déclarer localement `[lints.rust]` ainsi que `[lints.clippy]`, en recopiant les niveaux partagés réellement conservés puis en ajustant seulement l'exception motivée. Les autres membres continuent d'hériter des lints racine.
|
||||
|
||||
## Vérification dans le projet destinataire
|
||||
|
||||
Après avoir ajouté le code source nécessaire, vérifier d'abord la résolution des manifests et les héritages, puis les contrôles réellement applicables :
|
||||
|
||||
```bash
|
||||
cargo metadata --format-version 1 --no-deps
|
||||
cargo fmt --all -- --check
|
||||
cargo check --workspace
|
||||
cargo clippy --workspace --all-targets --all-features -- -D warnings
|
||||
```
|
||||
|
||||
Vérifier séparément le cas d'une crate à lints locaux lorsque le projet comporte réellement une exception. `Cargo.lock` et les artefacts créés par ces commandes suivent la politique du projet et la configuration Cargo de [`001-RUST_CARGO_TOOLING.md`](001-RUST_CARGO_TOOLING.md).
|
||||
29
docs/templates/003-NEW_SESSION_PROMPT.md
vendored
Normal file
29
docs/templates/003-NEW_SESSION_PROMPT.md
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
<!-- file: docs/templates/003-NEW_SESSION_PROMPT.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Spécification du prompt manuel de nouvelle session
|
||||
|
||||
## Usage
|
||||
|
||||
Cette spécification sert à préparer un court message de reprise après une stable publiée. Le prompt de démarrage propre à la version suivante reste un fichier `prompts/NNN-VX_Y_Z_START_PROMPT.md` finalisé selon [`210-WORKFLOW.md`](../rules/210-WORKFLOW.md). Le message manuel indique où commencer et quelles preuves fournir ; il ne copie ni ce prompt, ni le plan, ni le history de la release.
|
||||
|
||||
La comparaison des prompts PGR `002` et `003` montre une structure récurrente (baseline taggée, cible, première tranche et mission). `003` ajoute le rapport de vérification post-tag et un texte transmis explicitement à l'opérateur. Une forme courte commune réduit les oublis lors de la clôture suivante, sans rendre obligatoires des champs propres à PGR dans les autres projets.
|
||||
|
||||
## Champs à renseigner
|
||||
|
||||
1. **Baseline** : identifier le tag stable, le nom réel de l'archive source téléchargée depuis ce tag et la forge d'origine. Une archive sans `.git` demande une vérification interne ; elle ne prouve pas à elle seule le commit du tag.
|
||||
2. **Preuve post-tag** : si un rapport de publication/vérification distinct existe et est réellement `PASS`, indiquer son chemin exact et le joindre. Sinon, signaler explicitement qu'il est absent ou que son état n'est pas `PASS` ; ne jamais fabriquer cette preuve ni la confondre avec le tag.
|
||||
3. **Contrat de reprise** : indiquer le chemin du prompt `prompts/NNN-VX_Y_Z_START_PROMPT.md` existant dans la baseline, la version cible et la première tranche attendue. Le prompt versionné possède la mission détaillée et le scope de la release.
|
||||
4. **Intake** : demander la vérification de l'archive, des règles applicables, de la gouvernance, de la structure documentaire et des deltas/histories avant de préparer la première tranche. Adapter la liste aux artefacts effectivement présents et aux risques du projet.
|
||||
|
||||
## Forme à remplir et à remettre
|
||||
|
||||
Après vérification des chemins et de l'état réel du rapport, écrire **une seule phrase** adaptée au projet. Si le rapport est `PASS` et fourni :
|
||||
|
||||
```text
|
||||
Partir de l'archive <nom exact du ZIP issu du tag vX.Y.Z> et du rapport post-tag <chemin exact du rapport PASS>. Lire et exécuter <chemin du prompt de démarrage dans la baseline>. Vérifier l'archive, les règles, la gouvernance, la structure documentaire, les deltas/histories et la cohérence globale avant de préparer <version cible-alpha.1>.
|
||||
```
|
||||
|
||||
Si le rapport est absent ou non validé, retirer « et du rapport post-tag ... » de la phrase et préciser séparément son état réel à la nouvelle session. Conserver les noms exacts de la forge et des fichiers du projet : la forme `<nom exact du ZIP>` n'est qu'un champ de rédaction.
|
||||
|
||||
Rédiger le texte manuel à la clôture après le contrôle de l'archive publiée et le remettre à l'opérateur. Une interruption au milieu d'une prerelease suit le mécanisme de reprise de la tranche courante prévu dans `210-WORKFLOW.md` ; elle ne crée pas artificiellement un nouveau prompt de version.
|
||||
@@ -1,5 +1,5 @@
|
||||
<!-- file: docs/validation/001-VALIDATION_MATRIX.md -->
|
||||
<!-- version: 6 -->
|
||||
<!-- version: 9 -->
|
||||
|
||||
# Matrice de validation PGR
|
||||
|
||||
@@ -13,25 +13,34 @@ Les catégories et règles de sélection sont définies dans [`../rules/400-VALI
|
||||
|
||||
## Contrôles actifs
|
||||
|
||||
| ID | Catégorie | Commande / contrôle | Prérequis | Trigger | Phase | Coût | Acteur |
|
||||
|--------------------|-----------|--------------------------------------------------------------------------------------|------------------------|---------------------------------|----------------------|--------|-----------------|
|
||||
| `PGR-GIT-001` | `CHECK` | `git diff --check` ou `git diff --cached --check` selon l'état de l'index | Git | toute modification suivie | alpha/beta/RC/stable | faible | opérateur |
|
||||
| `PGR-VERSION-001` | `CHECK` | comparer `VERSION` à la version attendue par le delta courant | fichier `VERSION` | changement de tranche/version | alpha/beta/RC/stable | faible | opérateur |
|
||||
| `PGR-LAYOUT-001` | `AUDIT` | comparer les fichiers ajoutés/remplacés/supprimés au scope déclaré du delta | scope du delta | changement de structure | alpha/beta/RC/stable | faible | opérateur/revue |
|
||||
| `PGR-DOC-001` | `AUDIT` | vérifier headers `file/version`, chemins et responsabilités des documents touchés | fichiers documentaires | modification documentaire | alpha/beta/RC/stable | faible | opérateur/revue |
|
||||
| `PGR-MD-TABLE-001` | `AUDIT` | `python3 -B scripts/audit_markdown_tables.py <paths...>` | Python 3 | table Markdown ajoutée/modifiée | alpha/beta/RC/stable | faible | opérateur/CI |
|
||||
| `PGR-NAV-001` | `AUDIT` | `python3 -B scripts/audit_markdown_links.py <paths...>` | Python 3 | navigation ou réconciliation | beta/RC/stable | faible | opérateur/CI |
|
||||
| `PGR-SCOPE-001` | `AUDIT` | vérifier que les documents vivants pointent vers les propriétaires normatifs actuels | documents vivants | réconciliation de phase | beta/RC/stable | faible | revue |
|
||||
| `PGR-STATUS-001` | `CHECK` | `git status --short` | Git | avant fermeture d'une tranche | alpha/beta/RC/stable | faible | opérateur |
|
||||
| ID | Catégorie | Commande / contrôle | Prérequis | Trigger | Phase | Coût | Acteur |
|
||||
|---------------------|-----------|--------------------------------------------------------------------------------------|------------------------|---------------------------------|----------------------|--------|-----------------|
|
||||
| `PGR-GIT-001` | `CHECK` | `git diff --check` ou `git diff --cached --check` selon l'état de l'index | Git | toute modification suivie | alpha/beta/RC/stable | faible | opérateur |
|
||||
| `PGR-VERSION-001` | `CHECK` | comparer `VERSION` à la version attendue par le delta courant | fichier `VERSION` | changement de tranche/version | alpha/beta/RC/stable | faible | opérateur |
|
||||
| `PGR-LAYOUT-001` | `AUDIT` | comparer les fichiers ajoutés/remplacés/supprimés au scope déclaré du delta | scope du delta | changement de structure | alpha/beta/RC/stable | faible | opérateur/revue |
|
||||
| `PGR-DOC-001` | `AUDIT` | vérifier chemins, rôles et responsabilités des documents touchés | fichiers documentaires | modification documentaire | alpha/beta/RC/stable | faible | opérateur/revue |
|
||||
| `PGR-MD-HEADER-001` | `AUDIT` | `python3 -B scripts/audit_markdown_headers.py <paths...>` | Python 3 | Markdown gouverné modifié | alpha/beta/RC/stable | faible | opérateur/CI |
|
||||
| `PGR-MD-TABLE-001` | `AUDIT` | `python3 -B scripts/audit_markdown_tables.py <paths...>` | Python 3 | table Markdown ajoutée/modifiée | alpha/beta/RC/stable | faible | opérateur/CI |
|
||||
| `PGR-NAV-001` | `AUDIT` | `python3 -B scripts/audit_markdown_links.py <paths...>` | Python 3 | navigation ou réconciliation | alpha/beta/RC/stable | faible | opérateur/CI |
|
||||
| `PGR-SCOPE-001` | `AUDIT` | vérifier que les documents vivants pointent vers les propriétaires normatifs actuels | documents vivants | réconciliation de phase | beta/RC/stable | faible | revue |
|
||||
| `PGR-STATUS-001` | `CHECK` | `git status --short` | Git | avant fermeture d'une tranche | alpha/beta/RC/stable | faible | opérateur |
|
||||
|
||||
Un contrôle manuel peut rester dans la matrice lorsqu'aucun audit automatisé fiable n'existe encore. PGR SHOULD automatiser uniquement les propriétés stables et objectivement contrôlables.
|
||||
|
||||
`PGR-MD-TABLE-001` reste volontairement monotâche : il contrôle uniquement la structure et l'alignement source des tableaux Markdown.
|
||||
|
||||
`PGR-MD-HEADER-001` contrôle seulement les deux premières lignes des fichiers Markdown sélectionnés : chemin relatif depuis la racine et révision interne positive. La revue `PGR-DOC-001` reste responsable du rôle documentaire et de la pertinence réelle d'un incrément de révision.
|
||||
|
||||
`PGR-NAV-001` est automatisé séparément par `audit_markdown_links.py`. Il vérifie uniquement l'existence des cibles de liens Markdown locaux inline, sans contrôler les anchors, les headers, les responsabilités documentaires ou la forme des tableaux.
|
||||
|
||||
PGR préfère plusieurs audits simples avec une responsabilité identifiable à un script unique qui agrège des règles indépendantes.
|
||||
|
||||
## Contrôles Rust réutilisables, hors gate du dépôt PGR
|
||||
|
||||
[`002-RUST_STYLE_AUDITS.md`](002-RUST_STYLE_AUDITS.md) décrit deux audits facultatifs : `audit_rust_blank_lines.py` contrôle l'espacement des lignes vides, `audit_rust_const_blocks.py` contrôle l'ordre et l'espacement des blocs de constantes au niveau racine. Ils acceptent des chemins Rust sélectionnés et partagent un petit support lexical ; leur validation ciblée dans PGR est `python3 -B -m unittest discover -s tests -p test_rust_audits.py`.
|
||||
|
||||
Leur disponibilité ne transforme pas PGR en workspace Rust et ne rend pas automatiquement l'ordre alphabétique applicable à chaque fichier d'un projet. Lors d'une adoption, le projet propriétaire sélectionne ses chemins après `cargo fmt` et applique sa propre gate ; Rustfmt et Clippy conservent les contrôles qu'ils possèdent.
|
||||
|
||||
## Politique Eclipse actuelle
|
||||
|
||||
Les métadonnées Eclipse spécifiques à une machine restent ignorées, notamment `.project`, `.classpath` et les préférences non partagées.
|
||||
|
||||
34
docs/validation/002-RUST_STYLE_AUDITS.md
Normal file
34
docs/validation/002-RUST_STYLE_AUDITS.md
Normal file
@@ -0,0 +1,34 @@
|
||||
<!-- file: docs/validation/002-RUST_STYLE_AUDITS.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Audits facultatifs de style Rust
|
||||
|
||||
## Responsabilité et provenance
|
||||
|
||||
Les sources KSP `0.3.16` et Games `0.3.5` possèdent chacune un `audit_rust_general_rules.py` qui mêle plusieurs règles. Le découpage PGR fournit deux contrôles ciblés sans copier l'orchestrateur ni les règles propres aux deux projets. Le contrat de style facultatif est dans [`510-RUST_CARGO.md`](../rules/510-RUST_CARGO.md), et la sélection des preuves dans [`400-VALIDATION.md`](../rules/400-VALIDATION.md).
|
||||
|
||||
`scripts/audit_rust_blank_lines.py` contrôle les lignes vides consécutives et les lignes vides dans un corps de fonction/méthode, `struct` ou `enum`. `scripts/audit_rust_const_blocks.py` contrôle l'ordre `pub`, `pub(crate)`, privé, le tri naturel des noms dans chaque visibilité et l'espacement entre constantes consécutives au niveau racine du fichier. `scripts/_rust_audit_common.py` partage la sélection des chemins et le masquage des commentaires/littéraux : il ne définit aucune nouvelle politique.
|
||||
|
||||
## Adoption et commandes
|
||||
|
||||
Dans un projet Rust qui choisit ces conventions, copier les trois fichiers `scripts/*.py` concernés en gardant le helper à côté des deux audits. Adapter les headers `file` au chemin du projet et maintenir une révision de fichier propre à cette copie.
|
||||
|
||||
Choisir explicitement les fichiers concernés par chaque contrat. Après formatage :
|
||||
|
||||
```bash
|
||||
cargo fmt --all -- --check
|
||||
python3 -B scripts/audit_rust_blank_lines.py crates/example/src
|
||||
python3 -B scripts/audit_rust_const_blocks.py crates/example/src/constants.rs
|
||||
```
|
||||
|
||||
Une invocation sans chemin est une erreur, de même qu'un chemin absent ou aucun fichier Rust sélectionné. Un répertoire sélectionne récursivement les fichiers `.rs` hors répertoires générés habituels. Les audits ne modifient ni les fichiers inspectés ni l'arborescence de build. Les sorties utilisent le chemin et la ligne ; le code de sortie est `0` si propre, `1` pour violation, `2` pour sélection/lecture impossible.
|
||||
|
||||
Ne sélectionner pour l'audit des constantes que les fichiers dont les blocs racine sans sémantique d'ordre doivent effectivement suivre ce contrat. Un tri de table de protocole, des migrations, des champs de wire format ou de toute séquence métier peut casser le programme : sa revue appartient au projet. Ne pas utiliser la sortie du script comme justification pour les réordonner.
|
||||
|
||||
## Limites mesurées
|
||||
|
||||
La prévalidation des sources réels a porté sur `300` fichiers KSP et `59` Games sous `crates/**/src/`. L'audit des lignes vides n'y détecte aucun écart. L'audit de constantes détecte `17` signaux KSP et aucun Games lorsque tous ces fichiers lui sont soumis ; des fichiers KSP contiennent des séquences ordonnées selon le protocole ou le schéma, ce qui rend une gate globale du tri inappropriée. Ces observations ne sont pas une gate de validation opérateur PGR.
|
||||
|
||||
L'analyse lexicale masque littéraux et commentaires courants, y compris commentaires imbriqués et chaînes Rust brutes. Elle n'est pas un parseur Rust : les macros élaborées, syntaxe nouvelle, attributs complexes, items associés dans `impl` et constantes dans modules inline n'entrent pas dans le contrat garanti de l'audit des blocs racine. Les lignes vides à l'intérieur d'un littéral multilignes sont exclues. Les cas qui demandent une interprétation sémantique nécessitent la revue humaine ou les outils Rust du projet.
|
||||
|
||||
Rustfmt reste propriétaire de l'ordre qu'il réécrit déjà dans les groupes de `use`/`mod`. Clippy et le compilateur restent responsables de leurs diagnostics. La suite `tests/test_rust_audits.py` vérifie les propriétés ciblées avec des cas propres, des violations et des littéraux/commentaires qui contiennent des accolades.
|
||||
46
history/0.0.3/alpha.1.fix.1.md
Normal file
46
history/0.0.3/alpha.1.fix.1.md
Normal file
@@ -0,0 +1,46 @@
|
||||
<!-- file: history/0.0.3/alpha.1.fix.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.1.fix.1 — correction du plan Rust/Cargo
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate documentaire du fix a été exécutée par l'opérateur avec succès. La précision apportée ensuite sur `.cargo/config.toml` et sur la valeur des conventions Rustfmt/Clippy des projets constitue un apport au cadrage de `alpha.2`, sans invalider le résultat observé du fix.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
La présence de `history/0.0.3/alpha.1.md` dans `HEAD` a été vérifiée par l'opérateur avec `git cat-file -e`. La version contrôlée après application est :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.1.fix.1
|
||||
```
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
Le terminal fourni pour `~/Projects/pgr` le `2026-09-23` affiche la réussite des contrôles de version, de présence du delta et du history précédent, et d'absence du history courant. Les recherches dans le plan retrouvent sa révision `2`, les `22` crates KSP héritant des lints et les titres des tranches `alpha.2`, `alpha.3` et `alpha.4`.
|
||||
|
||||
Les trois audits ont produit :
|
||||
|
||||
```text
|
||||
Markdown table audit: clean (2 table(s), 77 file(s))
|
||||
Markdown link audit: clean (50 local link(s), 77 file(s))
|
||||
Markdown header audit: clean (77 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont émis aucun diagnostic. Après ajout des fichiers du delta, le scope observé est :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.1.fix.1.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
Le collage du terminal intercale une portion du futur script de contrôle près de la sortie de l'audit de liens, mais la commande Python, son résultat et les contrôles Git apparaissent ensuite séparément. Aucun résultat d'échec n'est présent dans les sorties fournies.
|
||||
|
||||
## Décision et transition
|
||||
|
||||
`alpha.1.fix.1` est validé `PASS`. Appliquer ce history et committer le fix avant toute application du delta `alpha.2`.
|
||||
|
||||
La clarification métier post-gate fixe une convention de départ pour `alpha.2` : `rustfmt.toml` et `clippy.toml` dérivent des configurations éprouvées des deux projets, avec adaptations mineures selon le projet, et `.cargo/config.toml` déplace ordinairement `target-dir` et `build-dir` vers `../builds/<nom-du-projet>/target/`. `alpha.2` peut adapter le plan vivant et livrer ces templates sans réécrire rétrospectivement le delta ou le présent history. Aucun commit de `alpha.1.fix.1` ni résultat de `alpha.2` n'est prétendu observé ici.
|
||||
55
history/0.0.3/alpha.1.md
Normal file
55
history/0.0.3/alpha.1.md
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- file: history/0.0.3/alpha.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.1 — cadrage initial
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
Les contrôles mécaniques demandés par le delta `alpha.1` ont été exécutés par l'opérateur et ont réussi. La revue complémentaire, après ce gate, demande d'élargir le plan des templates Rust à Cargo et Clippy en examinant les archives de référence KSP et Games. Cette précision documentaire sera une tranche `.fix.1` distincte, après application du présent history et commit de `alpha.1`.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
Baseline déclarée : archive issue du tag `v0.0.2`, accompagnée du rapport `pgr-0.0.2-publish.001-report.md` contrôlé pendant le cadrage. Version validée après application de `alpha.1` :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.1
|
||||
```
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
L'opérateur a fourni les sorties du `2026-09-23` à `16:41:08`–`16:41:09` depuis `~/Projects/pgr`. Les quatre contrôles de version, présence du plan et du delta, et absence du history courant ont terminé sans erreur :
|
||||
|
||||
```text
|
||||
test "$(cat VERSION)" = '0.0.3-alpha.1'
|
||||
test -f docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
test -f deltas/0.0.3/alpha.1.md
|
||||
test ! -e history/0.0.3/alpha.1.md
|
||||
```
|
||||
|
||||
Audits documentaires observés :
|
||||
|
||||
```text
|
||||
Markdown table audit: clean (2 table(s), 75 file(s))
|
||||
Markdown link audit: clean (50 local link(s), 75 file(s))
|
||||
Markdown header audit: clean (75 file(s))
|
||||
```
|
||||
|
||||
Les commandes `git diff --check` et `git diff --cached --check` n'ont émis aucun diagnostic. Après `git add` des trois chemins du delta, `git status --short` a affiché :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.1.md
|
||||
A docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
La copie fournie du terminal contient un fragment de collage `ck` après le heredoc Python ; les commandes Git et leur sortie apparaissent ensuite séparément et sans erreur. Ce fragment ne modifie pas les trois résultats d'audit ni le scope Git observé.
|
||||
|
||||
## Revue post-gate et décision
|
||||
|
||||
La revue du plan après réussite mécanique a relevé une lacune de dimensionnement : le profil PGR `510` et les deux projets de référence justifient d'examiner `Cargo.toml` racine, `Cargo.toml` de crate membre et les deux niveaux de configuration Clippy en plus de `rustfmt.toml`.
|
||||
|
||||
Les archives de référence ont été fournies après l'exécution de la gate initiale. Leur étude et la correction du plan constituent le scope documentaire de `alpha.1.fix.1` ; elles ne sont pas présentées rétroactivement comme des preuves exécutées par l'opérateur pendant `alpha.1`.
|
||||
|
||||
Appliquer le présent history puis committer `alpha.1` avant d'appliquer le delta `alpha.1.fix.1`. Aucun commit, push ou gate de fix n'est déclaré observé ici.
|
||||
55
history/0.0.3/alpha.2.md
Normal file
55
history/0.0.3/alpha.2.md
Normal file
@@ -0,0 +1,55 @@
|
||||
<!-- file: history/0.0.3/alpha.2.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.2 — outillage Rust/Cargo partagé
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate documentaire et TOML de `alpha.2` a été exécutée par l'opérateur avec succès. Une demande ultérieure complète le cadrage des audits Rust à partir des scripts KSP et Games ; elle concerne les tranches suivantes et ne modifie pas rétroactivement le résultat des templates de cette tranche.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
La présence de `history/0.0.3/alpha.1.fix.1.md` dans `HEAD` a été vérifiée par `git cat-file -e`. Version contrôlée après application :
|
||||
|
||||
```text
|
||||
0.0.3-alpha.2
|
||||
```
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
Les commandes fournies depuis `~/Projects/pgr` le `2026-09-23` à `22:29:19` confirment la version, la baseline committée et l'absence du history courant. Le contrôle TOML de `rustfmt.toml`, `clippy.toml` et `.cargo/config.toml` affiche :
|
||||
|
||||
```text
|
||||
Rust/Cargo template TOML audit: clean (3 file(s))
|
||||
```
|
||||
|
||||
Les audits documentaires affichent :
|
||||
|
||||
```text
|
||||
Markdown table audit: clean (2 table(s), 80 file(s))
|
||||
Markdown link audit: clean (55 local link(s), 80 file(s))
|
||||
Markdown header audit: clean (80 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont émis aucun diagnostic. Après `git add`, le scope observé est :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.2.md
|
||||
M docs/000-README.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
A docs/templates/001-RUST_CARGO_TOOLING.md
|
||||
A templates/rust-cargo/.cargo/config.toml
|
||||
A templates/rust-cargo/clippy.toml
|
||||
A templates/rust-cargo/rustfmt.toml
|
||||
```
|
||||
|
||||
Le collage du terminal intercale quelques lignes de la commande `git add` dans la zone de sortie des audits ; chaque commande et son résultat apparaissent ensuite séparément. Aucune erreur n'est signalée par les sorties fournies.
|
||||
|
||||
## Suite
|
||||
|
||||
Le travail approuvé après ce gate demande de comparer les contrôles de format Rust des scripts KSP et Games, de les répartir par propriété monotâche lorsqu'ils doivent être réutilisés, et de distinguer ce que Rustfmt/Clippy possèdent déjà de ce qui exige un audit dédié. Cette revue n'a pas été exécutée par l'opérateur pendant le gate `alpha.2` et ne constitue pas sa preuve PASS.
|
||||
|
||||
Appliquer le présent history et committer `alpha.2` avant tout nouveau delta. Aucun commit ou gate ultérieur n'est déclaré observé ici.
|
||||
48
history/0.0.3/alpha.3.md
Normal file
48
history/0.0.3/alpha.3.md
Normal file
@@ -0,0 +1,48 @@
|
||||
<!-- file: history/0.0.3/alpha.3.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.3 — audits de style Rust ciblés
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
L'opérateur a exécuté la gate prescrite pour `alpha.3` dans son dépôt le `2026-09-24`. Les neuf tests des audits Rust et les contrôles documentaires passent. Ce history constate les preuves fournies pour cette tranche, sans préjuger de la validation des manifests Cargo de `alpha.4`.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
`git cat-file -e HEAD:history/0.0.3/alpha.2.md` a confirmé la présence dans `HEAD` du history de la tranche précédente. L'opérateur a vérifié `VERSION = 0.0.3-alpha.3`, la présence du delta courant, celle du history précédent et l'absence de `history/0.0.3/alpha.3.md` avant sa livraison.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
Les recherches sur le plan ont confirmé sa révision `4`, la tranche Cargo prévue en `alpha.4` et l'audit des headers Markdown prévu en `alpha.5`.
|
||||
|
||||
La commande `python3 -B -m unittest discover -s tests -p test_rust_audits.py -v` a exécuté `9` cas, tous `ok` ; le résultat final est `OK`. Les contrôles documentaires ont affiché :
|
||||
|
||||
```text
|
||||
Markdown table audit: clean (3 table(s), 83 file(s))
|
||||
Markdown link audit: clean (59 local link(s), 83 file(s))
|
||||
Markdown header audit: clean (83 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont affiché aucun diagnostic. Après `git add`, le scope indexé fourni est :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.3.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
M docs/rules/510-RUST_CARGO.md
|
||||
M docs/templates/001-RUST_CARGO_TOOLING.md
|
||||
M docs/validation/001-VALIDATION_MATRIX.md
|
||||
A docs/validation/002-RUST_STYLE_AUDITS.md
|
||||
A scripts/_rust_audit_common.py
|
||||
A scripts/audit_rust_blank_lines.py
|
||||
A scripts/audit_rust_const_blocks.py
|
||||
A tests/test_rust_audits.py
|
||||
```
|
||||
|
||||
Le collage du terminal intercale le début de la commande de contrôle des headers avant la sortie des tests. Les neuf résultats des tests, les sorties des audits et les commandes Git apparaissent ensuite dans la transcription, sans échec signalé.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer ce history et committer la tranche `alpha.3` avant d'appliquer le delta `alpha.4`. Le commit lui-même n'est pas observé dans la preuve fournie. La suite conforme au plan est la livraison des deux templates `Cargo.toml` et de leur documentation d'adaptation, avec sa propre gate opérateur.
|
||||
54
history/0.0.3/alpha.4.md
Normal file
54
history/0.0.3/alpha.4.md
Normal file
@@ -0,0 +1,54 @@
|
||||
<!-- file: history/0.0.3/alpha.4.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.4 — manifests Cargo workspace et membre
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
L'opérateur a exécuté le `2026-09-24` la gate de `alpha.4` avec Cargo disponible. Les deux manifests sont valides ; la vérification en workspace temporaire couvre l'héritage des lints, une erreur `unsafe` attendue sous `forbid`, puis la réussite avec une exception locale déclarée dans la crate.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
`git cat-file -e HEAD:history/0.0.3/alpha.3.md` a confirmé la présence du history précédent dans `HEAD`. La version après application est `0.0.3-alpha.4`, le delta et le history `alpha.3` sont présents, et `history/0.0.3/alpha.4.md` était absent lors du contrôle.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
Le contrôle TOML a affiché :
|
||||
|
||||
```text
|
||||
Cargo manifest TOML audit: clean (2 file(s))
|
||||
```
|
||||
|
||||
Le smoke a effectué `cargo metadata` sur un workspace d'essai, puis `cargo check --workspace --offline` et `cargo clippy --workspace --all-targets --all-features --offline -- -D warnings` sur une crate minimale. Après insertion d'un bloc `unsafe`, le test attendu d'interdiction a été satisfait ; `cargo check` est redevenu propre après remplacement de l'héritage par les lints locaux ciblés. Résultat affiché :
|
||||
|
||||
```text
|
||||
Cargo workspace smoke: clean (inherited and local lints)
|
||||
```
|
||||
|
||||
Les audits documentaires affichent :
|
||||
|
||||
```text
|
||||
Markdown table audit: clean (3 table(s), 86 file(s))
|
||||
Markdown link audit: clean (67 local link(s), 86 file(s))
|
||||
Markdown header audit: clean (86 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont pas affiché de diagnostic. Après `git add`, l'état indexé fourni contient exactement :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.4.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
M docs/templates/001-RUST_CARGO_TOOLING.md
|
||||
A docs/templates/002-CARGO_MANIFESTS.md
|
||||
A templates/rust-cargo/Cargo.toml
|
||||
A templates/rust-cargo/crates/project-core-lib/Cargo.toml
|
||||
```
|
||||
|
||||
Le terminal intercale certains fragments de la commande de validation dans les sorties du smoke ; les résultats Cargo et les résultats finaux des audits restent identifiables. Aucun échec n'est signalé dans la transcription fournie.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer le présent history et committer la tranche `alpha.4` avant d'appliquer un delta `alpha.5`. La présence de ce futur commit n'est pas déduite des commandes fournies. La tranche suivante concerne le contrôle monotâche des headers Markdown déjà effectué manuellement dans les gates précédentes.
|
||||
41
history/0.0.3/alpha.5.md
Normal file
41
history/0.0.3/alpha.5.md
Normal file
@@ -0,0 +1,41 @@
|
||||
<!-- file: history/0.0.3/alpha.5.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.5 — audit des headers Markdown
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate de `alpha.5` exécutée par l'opérateur le `2026-09-24` a validé le script monotâche des headers Markdown, ses cas positifs et négatifs, et les audits documentaires de PGR.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
L'opérateur a confirmé `VERSION = 0.0.3-alpha.5`, la présence dans `HEAD` de `history/0.0.3/alpha.4.md` par `git cat-file -e`, l'existence du delta `alpha.5` et l'absence du history courant avant sa livraison. Les révisions internes attendues de `docs/rules/300-DOCUMENTATION.md` et de la matrice sont respectivement `2` et `8`.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
`python3 -B -m unittest discover -s tests -p test_markdown_headers.py -v` a exécuté `6` tests, tous `ok`, avec résultat final `OK`. Les audits ont affiché :
|
||||
|
||||
```text
|
||||
Markdown header audit: clean (88 file(s))
|
||||
Markdown table audit: clean (3 table(s), 88 file(s))
|
||||
Markdown link audit: clean (67 local link(s), 88 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont affiché aucun diagnostic. Après ajout des fichiers du delta, le statut indexé transmis est exactement :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.5.md
|
||||
M docs/rules/300-DOCUMENTATION.md
|
||||
M docs/validation/001-VALIDATION_MATRIX.md
|
||||
A scripts/audit_markdown_headers.py
|
||||
A tests/test_markdown_headers.py
|
||||
```
|
||||
|
||||
Le collage du terminal intercale un fragment d'une commande `git status --short` dans la sortie d'un test. Les six cas, le résumé `OK` et les résultats finaux des trois audits restent lisibles ; aucun échec n'est signalé.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer ce history puis committer `alpha.5` avant le delta `alpha.6`. Le commit futur n'est pas attesté par la transcription fournie. La suite prévue consiste à décider, après comparaison des prompts existants, si une courte spécification de prompt manuel améliore réellement la clôture stable.
|
||||
40
history/0.0.3/alpha.6.md
Normal file
40
history/0.0.3/alpha.6.md
Normal file
@@ -0,0 +1,40 @@
|
||||
<!-- file: history/0.0.3/alpha.6.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-alpha.6 — prompt manuel de reprise
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate de `alpha.6` exécutée par l'opérateur le `2026-09-24` valide la spécification courte du prompt manuel de nouvelle session et les renvois documentaires associés.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
L'opérateur a confirmé `VERSION = 0.0.3-alpha.6`, la présence dans `HEAD` de `history/0.0.3/alpha.5.md` par `git cat-file -e`, la présence de ce history dans le répertoire de travail, du delta `alpha.6` et du template `003`, ainsi que l'absence du history courant et de `prompts/004-V0_0_4_START_PROMPT.md` avant cette livraison. Les révisions internes du workflow et du plan sont respectivement `3` et `6` ; la décision de retenir une spécification manuelle figure bien dans le plan.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
Les trois audits ont affiché :
|
||||
|
||||
```text
|
||||
Markdown header audit: clean (91 file(s))
|
||||
Markdown table audit: clean (3 table(s), 91 file(s))
|
||||
Markdown link audit: clean (69 local link(s), 91 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont affiché aucun diagnostic. Après ajout des fichiers du delta, le statut indexé transmis est exactement :
|
||||
|
||||
```text
|
||||
M VERSION
|
||||
A deltas/0.0.3/alpha.6.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
M docs/rules/210-WORKFLOW.md
|
||||
A docs/templates/003-NEW_SESSION_PROMPT.md
|
||||
```
|
||||
|
||||
Le collage du terminal intercale un fragment de la commande `git add` dans la sortie de l'audit des liens ; son résultat final `clean` et les autres contrôles restent lisibles. Aucun échec n'est signalé.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer ce history puis committer `alpha.6` avant le delta `beta.1`. Le commit futur n'est pas attesté par la transcription fournie. La suite prévue est la réconciliation des responsabilités, de la navigation, des templates et des audits avant la RC.
|
||||
47
history/0.0.3/beta.1.md
Normal file
47
history/0.0.3/beta.1.md
Normal file
@@ -0,0 +1,47 @@
|
||||
<!-- file: history/0.0.3/beta.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-beta.1 — réconciliation documentaire
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate `beta.1` exécutée par l'opérateur le `2026-09-24` confirme la navigation des documents vivants, la chaîne des tranches alpha et les validations d'intégration prévues pour la réconciliation.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
L'opérateur a confirmé `VERSION = 0.0.3-beta.1`, la présence dans `HEAD` de `history/0.0.3/alpha.6.md` par `git cat-file -e`, la présence de ce history et du delta `beta.1`, ainsi que l'absence du history courant et du prompt `004` avant cette livraison. Les révisions attendues sont `5` pour `README.md`, `3` pour l'index documentaire, `7` pour le plan et `9` pour la matrice.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
`python3 -B -m unittest discover -s tests -p 'test_*.py' -v` a exécuté `15` tests, tous `ok`, avec résultat final `OK`. Les audits documentaires ont affiché :
|
||||
|
||||
```text
|
||||
Markdown header audit: clean (93 file(s))
|
||||
Markdown table audit: clean (3 table(s), 93 file(s))
|
||||
Markdown link audit: clean (76 local link(s), 93 file(s))
|
||||
```
|
||||
|
||||
La vérification de la chaîne et des modèles TOML a affiché :
|
||||
|
||||
```text
|
||||
Reconciliation audit: clean (7 PASS histories, 5 TOML files)
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont affiché aucun diagnostic. Après ajout des fichiers du delta, le statut indexé transmis est exactement :
|
||||
|
||||
```text
|
||||
M README.md
|
||||
M VERSION
|
||||
A deltas/0.0.3/beta.1.md
|
||||
M docs/000-README.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
M docs/validation/001-VALIDATION_MATRIX.md
|
||||
```
|
||||
|
||||
Le collage du terminal intercale des fragments de commandes et de sorties des tests ; leurs résumés `OK`, les résultats finaux des audits et le statut Git restent lisibles. Aucun échec n'est signalé.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer ce history et committer `beta.1` avant le delta `rc.1`. Le commit futur n'est pas attesté par la transcription fournie. La RC préparera l'entrée candidate du changelog et le prompt de `0.0.4`, puis exécutera sa propre gate ; le présent PASS ne valide pas cette RC par anticipation.
|
||||
41
history/0.0.3/rc.1.md
Normal file
41
history/0.0.3/rc.1.md
Normal file
@@ -0,0 +1,41 @@
|
||||
<!-- file: history/0.0.3/rc.1.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3-rc.1 — gel du scope et préparation de release
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate de release candidate `rc.1` exécutée par l'opérateur le `2026-09-24` confirme le gel du périmètre, l'entrée candidate du changelog, le prompt `004` et l'intégration documentaire.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
L'opérateur a confirmé `VERSION = 0.0.3-rc.1`, la présence dans `HEAD` de `history/0.0.3/beta.1.md` par `git cat-file -e`, la présence de ce history, du delta RC et du prompt `004`, ainsi que l'absence du history RC avant cette livraison. Les révisions internes attendues sont `4` pour `CHANGELOG.md` et `8` pour le plan. Le changelog porte l'intitulé `0.0.3 (candidate)` ; le prompt prévoit le rapport post-tag seulement si son résultat réel est PASS.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
`python3 -B -m unittest discover -s tests -p 'test_*.py' -v` a exécuté `15` tests, tous `ok`, et s'est terminé par `OK`. Les audits ont affiché :
|
||||
|
||||
```text
|
||||
Markdown header audit: clean (96 file(s))
|
||||
Markdown table audit: clean (3 table(s), 96 file(s))
|
||||
Markdown link audit: clean (79 local link(s), 96 file(s))
|
||||
RC integration audit: clean (8 PASS histories, 5 TOML files)
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont affiché aucun diagnostic. Le statut indexé observé après ajout des fichiers du delta est :
|
||||
|
||||
```text
|
||||
M CHANGELOG.md
|
||||
M VERSION
|
||||
A deltas/0.0.3/rc.1.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
A prompts/004-V0_0_4_START_PROMPT.md
|
||||
```
|
||||
|
||||
Le collage du terminal intercale des fragments de commandes et la sortie des tests ; les résumés `OK`, les résultats finaux des audits et le statut Git restent lisibles. Aucun échec n'est signalé.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer ce history puis committer `rc.1` avant le delta stable `rel.001`. Le commit futur n'est pas attesté par la transcription fournie. Ce PASS n'atteste ni la promotion stable, ni le tag `v0.0.3`, ni le contrôle de l'archive publiée après le tag.
|
||||
50
history/0.0.3/rel.001.md
Normal file
50
history/0.0.3/rel.001.md
Normal file
@@ -0,0 +1,50 @@
|
||||
<!-- file: history/0.0.3/rel.001.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# History 0.0.3 rel.001 — clôture stable pré-tag
|
||||
|
||||
## Statut
|
||||
|
||||
PASS
|
||||
|
||||
La gate stable pré-tag `rel.001` exécutée par l'opérateur le `2026-09-24` valide la promotion documentaire de `0.0.3`. Ce résultat porte sur l'état du dépôt avant le commit et le tag stables ; il ne valide pas l'archive téléchargée ensuite depuis Gitea.
|
||||
|
||||
## Baseline et version
|
||||
|
||||
L'opérateur a confirmé `VERSION = 0.0.3`, la présence dans `HEAD` de `history/0.0.3/rc.1.md` par `git cat-file -e`, la présence de ce history, du delta stable et du prompt `004`, ainsi que l'absence du présent history avant sa livraison. Les révisions attendues sont `6` pour `README.md`, `4` pour `ROADMAP.md`, `5` pour `CHANGELOG.md`, `4` pour l'index `docs/` et `9` pour le plan.
|
||||
|
||||
La présentation de la release dans `README.md`, le statut `(x)` de `0.0.3` dans la roadmap, l'entrée `## 0.0.3` du changelog, le statut historique du plan et la séparation du contrôle post-tag ont été vérifiés par les commandes de la gate.
|
||||
|
||||
## Validation opérateur observée
|
||||
|
||||
La vérification des deltas et histories antérieurs a affiché :
|
||||
|
||||
```text
|
||||
Stable history audit: clean (9 PASS histories, rel.001 pending)
|
||||
```
|
||||
|
||||
Les trois audits Markdown ont affiché :
|
||||
|
||||
```text
|
||||
Markdown header audit: clean (98 file(s))
|
||||
Markdown table audit: clean (3 table(s), 98 file(s))
|
||||
Markdown link audit: clean (79 local link(s), 98 file(s))
|
||||
```
|
||||
|
||||
`git diff --check` et `git diff --cached --check` n'ont affiché aucun diagnostic. Après ajout des fichiers du delta, le statut indexé transmis est :
|
||||
|
||||
```text
|
||||
M CHANGELOG.md
|
||||
M README.md
|
||||
M ROADMAP.md
|
||||
M VERSION
|
||||
A deltas/0.0.3/rel.001.md
|
||||
M docs/000-README.md
|
||||
M docs/plans/003-V0_0_3_TEMPLATES_AUDITS_PLAN.md
|
||||
```
|
||||
|
||||
Le collage du terminal intercale un fragment de commande dans la sortie de l'audit des tableaux ; son résultat final `clean` et les autres résultats restent lisibles. Les tests et la syntaxe des modèles TOML validés en RC n'ont pas été rejoués dans cette gate documentaire ; aucun code, script, test ni modèle technique ne change pendant `rel.001`.
|
||||
|
||||
## Transition
|
||||
|
||||
Appliquer ce history puis committer la stable. Ensuite seulement, créer et publier le tag `v0.0.3`, télécharger l'archive source associée depuis Gitea et exécuter une vérification post-tag séparée. Le commit stable, le tag, la publication et le résultat de cette vérification ne sont pas attestés par la transcription reçue ; aucun statut `publish.001` ne peut encore être consigné.
|
||||
44
prompts/004-V0_0_4_START_PROMPT.md
Normal file
44
prompts/004-V0_0_4_START_PROMPT.md
Normal file
@@ -0,0 +1,44 @@
|
||||
<!-- file: prompts/004-V0_0_4_START_PROMPT.md -->
|
||||
<!-- version: 1 -->
|
||||
|
||||
# Prompt de démarrage 0.0.4 — spécifications de skeletons
|
||||
|
||||
## Baseline et cible
|
||||
|
||||
Dépôt canonique : `https://git.sasedev.com/Sasedev/pgr`.
|
||||
|
||||
La baseline attendue au démarrage effectif de `0.0.4` est l'archive source téléchargée depuis le tag Gitea `v0.0.3`, dont le nom attendu est `pgr-v0.0.3.zip`. Une archive source peut légitimement ne pas contenir `.git` ; vérifier son contenu et ses artefacts de gouvernance sans lui attribuer une preuve Git qu'elle ne peut contenir.
|
||||
|
||||
Version cible : `0.0.4`. Première tranche attendue : `0.0.4-alpha.1`.
|
||||
|
||||
Si un rapport séparé `pgr-0.0.3-publish.001-report.md` a effectivement été produit et conclut `PASS`, le fournir avec l'archive. S'il est absent ou non validé, le signaler explicitement ; ne jamais présumer la publication ou un résultat PASS. Ce rapport ne fait pas partie du tag et ne remplace pas l'audit de la nouvelle session.
|
||||
|
||||
## Reprise manuelle après publication
|
||||
|
||||
Après vérification réelle de l'archive du tag et du rapport post-tag PASS, remettre spontanément à l'opérateur un message de reprise adapté selon [`docs/templates/003-NEW_SESSION_PROMPT.md`](../docs/templates/003-NEW_SESSION_PROMPT.md). Si les noms attendus ci-dessus sont confirmés et le rapport est PASS, le texte est :
|
||||
|
||||
```text
|
||||
Partir de l'archive pgr-v0.0.3.zip téléchargée depuis le tag Gitea v0.0.3 et du rapport post-tag pgr-0.0.3-publish.001-report.md. Lire et exécuter prompts/004-V0_0_4_START_PROMPT.md. Vérifier l'archive, les règles, la gouvernance, la structure documentaire, les deltas/histories et la cohérence globale avant de préparer 0.0.4-alpha.1.
|
||||
```
|
||||
|
||||
Si le rapport manque ou n'est pas PASS, supprimer sa mention de la phrase et transmettre son état réel séparément. Adapter les noms à ceux des fichiers effectivement téléchargés. Ce texte ne doit être remis qu'après clôture stable et vérification post-tag, jamais comme attestation anticipée au stade RC.
|
||||
|
||||
## Mission
|
||||
|
||||
Définir les premières skeleton specifications Markdown réutilisables et les règles pratiques de composition des profils, templates et choix propres au projet. Un skeleton décrit une procédure de sélection, les fichiers et profils applicables, les décisions à prendre et une validation proportionnée ; il ne génère pas automatiquement un projet et ne fixe pas son architecture pour toujours.
|
||||
|
||||
`alpha.1` MUST vérifier entièrement la stable `v0.0.3`, en particulier les règles `200` à `610`, les cinq modèles Rust/Cargo, les trois audits Markdown, les deux audits de style Rust facultatifs, la chaîne de deltas/histories et les limites annoncées. Elle doit établir quels skeletons répondent déjà à un besoin concret et lesquels exigent encore des templates ou des décisions préalables. Planifier ensuite les tranches proportionnées de `0.0.4` avant toute matérialisation importante.
|
||||
|
||||
## Principes de conception
|
||||
|
||||
- Conserver un propriétaire normatif unique par règle et une copie autonome des règles/configurations pertinentes dans chaque projet instancié.
|
||||
- Respecter la séparation : règles applicables sous `docs/rules/`, fichiers techniques copiables sous `templates/`, mode d'adaptation sous `docs/templates/`, spécifications de skeletons Markdown et audits read-only pour les propriétés réellement contrôlables.
|
||||
- Sélectionner seulement les profils et templates justifiés par le type de projet ; documenter explicitement le nom, la version, les cibles, les dépendances et les exceptions qui dépendent du destinataire.
|
||||
- Ne pas déclarer universelles les valeurs `0.1.0`, `2024`, les seuils Clippy ou les chemins d'exemple des templates Rust/Cargo.
|
||||
- Préserver les décisions d'ordre sémantique des constantes : l'audit correspondant n'est pas une gate globale de tout workspace Rust.
|
||||
- Différer les skeletons Java/Android, Web, JNI, Tauri et autres familles dont les pièces nécessaires ou les propriétaires manquent encore ; un nouveau domaine demande un cadrage justifié.
|
||||
- Garder les audits ciblés et non redondants avec les outils officiels ; les tests prouvent des comportements utiles, sans quota arbitraire de couverture.
|
||||
|
||||
## Workflow
|
||||
|
||||
Suivre `RULES.md`, [`docs/rules/210-WORKFLOW.md`](../docs/rules/210-WORKFLOW.md) et [`docs/rules/400-VALIDATION.md`](../docs/rules/400-VALIDATION.md). La séquence reste delta → gate opérateur → history constaté → application du history → commit → delta suivant. Un changement de session ne crée pas une version nouvelle. Un rapport de publication post-tag est séparé de la validation pré-tag.
|
||||
144
scripts/_rust_audit_common.py
Normal file
144
scripts/_rust_audit_common.py
Normal file
@@ -0,0 +1,144 @@
|
||||
# file: scripts/_rust_audit_common.py
|
||||
# version: 1
|
||||
|
||||
"""Small shared lexical and file-selection helpers for read-only Rust audits."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pathlib
|
||||
|
||||
_IGNORED = frozenset({".git", ".venv", "__pycache__", "target", "builds"})
|
||||
|
||||
|
||||
def selected_files(raw_paths: list[str]) -> tuple[list[pathlib.Path], list[str]]:
|
||||
"""Select explicit Rust files and directories, without following generated trees."""
|
||||
|
||||
files: set[pathlib.Path] = set()
|
||||
errors: list[str] = []
|
||||
for raw in raw_paths:
|
||||
path = pathlib.Path(raw)
|
||||
if path.is_dir():
|
||||
files.update(
|
||||
candidate
|
||||
for candidate in path.rglob("*.rs")
|
||||
if candidate.is_file() and not (set(candidate.parts) & _IGNORED)
|
||||
)
|
||||
elif path.is_file() and path.suffix == ".rs":
|
||||
files.add(path)
|
||||
else:
|
||||
errors.append(f"unsupported or missing Rust path: {path}")
|
||||
return sorted(files), errors
|
||||
|
||||
|
||||
def mask_source(text: str) -> tuple[str, set[int]]:
|
||||
"""Mask comments and literals, preserving offsets and structural punctuation.
|
||||
|
||||
Return line numbers whose first character is inside a multiline literal, so
|
||||
an empty line in a raw string cannot be mistaken for an empty code line.
|
||||
This is a lexical helper, not a full Rust parser or a compiler substitute.
|
||||
"""
|
||||
|
||||
output = list(text)
|
||||
protected: set[int] = set()
|
||||
index = 0
|
||||
line = 1
|
||||
state = "code"
|
||||
block_depth = 0
|
||||
raw_hashes = 0
|
||||
while index < len(text):
|
||||
char = text[index]
|
||||
nxt = text[index + 1] if index + 1 < len(text) else ""
|
||||
if char == "\n":
|
||||
line += 1
|
||||
if state in {"string", "raw_string"}:
|
||||
protected.add(line)
|
||||
if state == "line_comment":
|
||||
state = "code"
|
||||
index += 1
|
||||
continue
|
||||
if state == "code":
|
||||
if char == "/" and nxt in {"/", "*"}:
|
||||
output[index:index + 2] = [" ", " "]
|
||||
state = "line_comment" if nxt == "/" else "block_comment"
|
||||
block_depth = 1 if nxt == "*" else 0
|
||||
index += 2
|
||||
continue
|
||||
if char == '"':
|
||||
output[index] = " "
|
||||
state = "string"
|
||||
index += 1
|
||||
continue
|
||||
if char == "'":
|
||||
# Lifetimes have no nearby closing quote; char literals do.
|
||||
probe = index + 1
|
||||
escaped = False
|
||||
found = False
|
||||
while probe < min(len(text), index + 8) and text[probe] != "\n":
|
||||
if text[probe] == "'" and not escaped:
|
||||
found = True
|
||||
break
|
||||
escaped = text[probe] == "\\" and not escaped
|
||||
probe += 1
|
||||
if found:
|
||||
output[index] = " "
|
||||
state = "char"
|
||||
index += 1
|
||||
continue
|
||||
# Also covers r#"..."#, br#"..."# and cr#"..."#.
|
||||
if char == "r" and (index == 0 or text[index - 1] not in "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_"):
|
||||
probe = index + 1
|
||||
while probe < len(text) and text[probe] == "#":
|
||||
probe += 1
|
||||
if probe < len(text) and text[probe] == '"':
|
||||
output[index:probe + 1] = [" "] * (probe + 1 - index)
|
||||
raw_hashes = probe - index - 1
|
||||
state = "raw_string"
|
||||
index = probe + 1
|
||||
continue
|
||||
index += 1
|
||||
continue
|
||||
if state == "line_comment":
|
||||
output[index] = " "
|
||||
elif state == "block_comment":
|
||||
output[index] = " "
|
||||
if char == "/" and nxt == "*":
|
||||
output[index + 1] = " "
|
||||
block_depth += 1
|
||||
index += 2
|
||||
continue
|
||||
if char == "*" and nxt == "/":
|
||||
output[index + 1] = " "
|
||||
block_depth -= 1
|
||||
if block_depth == 0:
|
||||
state = "code"
|
||||
index += 2
|
||||
continue
|
||||
elif state in {"string", "char"}:
|
||||
output[index] = " "
|
||||
if char == "\\" and index + 1 < len(text):
|
||||
if text[index + 1] != "\n":
|
||||
output[index + 1] = " "
|
||||
index += 2
|
||||
continue
|
||||
if char == ('"' if state == "string" else "'"):
|
||||
state = "code"
|
||||
elif state == "raw_string":
|
||||
output[index] = " "
|
||||
if char == '"' and text.startswith("#" * raw_hashes, index + 1):
|
||||
output[index + 1:index + 1 + raw_hashes] = [" "] * raw_hashes
|
||||
index += 1 + raw_hashes
|
||||
state = "code"
|
||||
continue
|
||||
index += 1
|
||||
return "".join(output), protected
|
||||
|
||||
|
||||
def line_depths(masked: str) -> list[int]:
|
||||
"""Return brace depth at the start of each line, excluding literals."""
|
||||
|
||||
depths: list[int] = []
|
||||
depth = 0
|
||||
for line in masked.splitlines():
|
||||
depths.append(depth)
|
||||
depth = max(0, depth + line.count("{") - line.count("}"))
|
||||
return depths
|
||||
96
scripts/audit_markdown_headers.py
Normal file
96
scripts/audit_markdown_headers.py
Normal file
@@ -0,0 +1,96 @@
|
||||
#!/usr/bin/env python3
|
||||
# file: scripts/audit_markdown_headers.py
|
||||
# version: 1
|
||||
|
||||
"""Validate path and positive revision in selected Markdown file headers."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
_IGNORED_DIRECTORIES = frozenset({".git", ".idea", ".venv", "__pycache__", "dist", "node_modules", "target"})
|
||||
_VERSION = re.compile(r"<!-- version: [1-9][0-9]* -->")
|
||||
|
||||
|
||||
def _selected_files(raw_paths: list[str], root: pathlib.Path) -> tuple[list[pathlib.Path], list[str]]:
|
||||
files: set[pathlib.Path] = set()
|
||||
errors: list[str] = []
|
||||
|
||||
for raw_path in raw_paths:
|
||||
path = pathlib.Path(raw_path)
|
||||
if path.is_dir() or path.is_file():
|
||||
if not path.resolve().is_relative_to(root):
|
||||
errors.append(f"Markdown header audit: path outside project root: {path}")
|
||||
continue
|
||||
if path.is_dir():
|
||||
candidates = (
|
||||
candidate
|
||||
for candidate in path.rglob("*.md")
|
||||
if candidate.is_file() and not any(part in _IGNORED_DIRECTORIES for part in candidate.parts)
|
||||
)
|
||||
elif path.is_file() and path.suffix.lower() == ".md":
|
||||
candidates = iter((path,))
|
||||
else:
|
||||
errors.append(f"Markdown header audit: unsupported or missing path: {path}")
|
||||
continue
|
||||
|
||||
for candidate in candidates:
|
||||
canonical = candidate.resolve()
|
||||
if not canonical.is_relative_to(root):
|
||||
errors.append(f"Markdown header audit: path outside project root: {candidate}")
|
||||
else:
|
||||
files.add(canonical)
|
||||
|
||||
return sorted(files), errors
|
||||
|
||||
|
||||
def _audit_file(path: pathlib.Path, root: pathlib.Path) -> list[str]:
|
||||
relative = path.relative_to(root).as_posix()
|
||||
lines = path.read_text(encoding="utf-8").splitlines()
|
||||
errors: list[str] = []
|
||||
expected_file = f"<!-- file: {relative} -->"
|
||||
|
||||
if not lines or lines[0] != expected_file:
|
||||
errors.append(f"{relative}:1: expected `{expected_file}`")
|
||||
if len(lines) < 2 or _VERSION.fullmatch(lines[1]) is None:
|
||||
errors.append(f"{relative}:2: expected positive `<!-- version: N -->`")
|
||||
return errors
|
||||
|
||||
|
||||
def main() -> int:
|
||||
"""Run the read-only Markdown header audit from the project root."""
|
||||
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
parser.add_argument("paths", nargs="+", help="Markdown files or directories to audit")
|
||||
args = parser.parse_args()
|
||||
|
||||
root = pathlib.Path.cwd().resolve()
|
||||
files, selection_errors = _selected_files(args.paths, root)
|
||||
if selection_errors or not files:
|
||||
for error in selection_errors or ["Markdown header audit: no Markdown files selected"]:
|
||||
print(error, file=sys.stderr)
|
||||
return 2
|
||||
|
||||
errors: list[str] = []
|
||||
for path in files:
|
||||
try:
|
||||
errors.extend(_audit_file(path, root))
|
||||
except (OSError, UnicodeError) as error:
|
||||
print(f"Markdown header audit: cannot read {path}: {error}", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
for error in errors:
|
||||
print(error, file=sys.stderr)
|
||||
if errors:
|
||||
print(f"Markdown header audit: {len(errors)} error(s) across {len(files)} file(s)", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
print(f"Markdown header audit: clean ({len(files)} file(s))")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
83
scripts/audit_rust_blank_lines.py
Normal file
83
scripts/audit_rust_blank_lines.py
Normal file
@@ -0,0 +1,83 @@
|
||||
#!/usr/bin/env python3
|
||||
# file: scripts/audit_rust_blank_lines.py
|
||||
# version: 1
|
||||
|
||||
"""Audit blank-line spacing in explicitly selected Rust sources."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
from _rust_audit_common import line_depths, mask_source, selected_files
|
||||
|
||||
_BODY = re.compile(r"^\s*(?:(?:pub(?:\([^)]*\))?|async|const|unsafe|extern|default)\s+)*(fn|struct|enum)\b")
|
||||
|
||||
|
||||
def audit_file(path: pathlib.Path) -> list[str]:
|
||||
"""Check successive empty lines and empty function/struct/enum body lines."""
|
||||
|
||||
text = path.read_text(encoding="utf-8")
|
||||
lines = text.splitlines()
|
||||
masked, protected = mask_source(text)
|
||||
masked_lines = masked.splitlines()
|
||||
depths = line_depths(masked)
|
||||
errors: list[str] = []
|
||||
previous_blank = False
|
||||
pending: tuple[str, int] | None = None
|
||||
active: tuple[str, int] | None = None
|
||||
|
||||
for number, (original, code, depth) in enumerate(zip(lines, masked_lines, depths, strict=True), 1):
|
||||
blank = not original.strip() and number not in protected
|
||||
if blank and previous_blank:
|
||||
errors.append(f"{path}:{number}: consecutive blank Rust source lines")
|
||||
previous_blank = blank
|
||||
|
||||
if active is not None and depth <= active[1]:
|
||||
active = None
|
||||
if active is not None and blank:
|
||||
errors.append(f"{path}:{number}: blank line inside {active[0]} body")
|
||||
|
||||
if active is None and pending is None:
|
||||
match = _BODY.match(code)
|
||||
if match is not None:
|
||||
pending = (match.group(1), depth)
|
||||
if pending is not None:
|
||||
if "{" in code:
|
||||
active = pending
|
||||
pending = None
|
||||
elif ";" in code:
|
||||
pending = None
|
||||
return errors
|
||||
|
||||
|
||||
def main() -> int:
|
||||
"""Run the read-only spacing audit on explicitly selected Rust files."""
|
||||
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
parser.add_argument("paths", nargs="+", help="Rust files or directories to inspect")
|
||||
args = parser.parse_args()
|
||||
files, errors = selected_files(args.paths)
|
||||
if errors or not files:
|
||||
for error in errors or ["no Rust files selected"]:
|
||||
print(f"Rust blank-line audit: {error}", file=sys.stderr)
|
||||
return 2
|
||||
for path in files:
|
||||
try:
|
||||
errors.extend(audit_file(path))
|
||||
except (OSError, UnicodeError) as error:
|
||||
print(f"Rust blank-line audit: cannot read {path}: {error}", file=sys.stderr)
|
||||
return 2
|
||||
for error in errors:
|
||||
print(error, file=sys.stderr)
|
||||
if errors:
|
||||
print(f"Rust blank-line audit: {len(errors)} error(s) across {len(files)} file(s)", file=sys.stderr)
|
||||
return 1
|
||||
print(f"Rust blank-line audit: clean ({len(files)} file(s))")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
109
scripts/audit_rust_const_blocks.py
Normal file
109
scripts/audit_rust_const_blocks.py
Normal file
@@ -0,0 +1,109 @@
|
||||
#!/usr/bin/env python3
|
||||
# file: scripts/audit_rust_const_blocks.py
|
||||
# version: 1
|
||||
|
||||
"""Audit top-level Rust const blocks for visibility, names and spacing."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
from _rust_audit_common import line_depths, mask_source, selected_files
|
||||
|
||||
_CONST = re.compile(r"^\s*(?:(pub|pub\(crate\))\s+)?const\s+([A-Za-z_][A-Za-z0-9_]*)\s*:")
|
||||
|
||||
|
||||
def _natural_key(value: str) -> tuple[tuple[int, object], ...]:
|
||||
parts = re.findall(r"[A-Za-z_]+|[0-9]+", value)
|
||||
return tuple((1, int(part)) if part.isdigit() else (0, part) for part in parts)
|
||||
|
||||
|
||||
def _end_of_const(lines: list[str], start: int) -> int:
|
||||
"""Find the terminating semicolon outside brackets and initializer braces."""
|
||||
|
||||
brackets: list[str] = []
|
||||
closing = {"}": "{", ")": "(", "]": "["}
|
||||
for index in range(start, len(lines)):
|
||||
for char in lines[index]:
|
||||
if char in "{([":
|
||||
brackets.append(char)
|
||||
elif char in "})]" and brackets and brackets[-1] == closing[char]:
|
||||
brackets.pop()
|
||||
elif char == ";" and not brackets:
|
||||
return index
|
||||
return start
|
||||
|
||||
|
||||
def audit_file(path: pathlib.Path) -> list[str]:
|
||||
"""Compare adjacent top-level const declarations in homogeneous blocks."""
|
||||
|
||||
text = path.read_text(encoding="utf-8")
|
||||
lines = text.splitlines()
|
||||
masked, _ = mask_source(text)
|
||||
code_lines = masked.splitlines()
|
||||
depths = line_depths(masked)
|
||||
errors: list[str] = []
|
||||
previous: tuple[int, int, int, str] | None = None # end, line, visibility rank, name
|
||||
index = 0
|
||||
while index < len(lines):
|
||||
code = code_lines[index]
|
||||
if depths[index] != 0:
|
||||
index += 1
|
||||
continue
|
||||
match = _CONST.match(code)
|
||||
if match is not None:
|
||||
visibility, name = match.groups()
|
||||
rank = {"pub": 0, "pub(crate)": 1, None: 2}[visibility]
|
||||
if previous is not None:
|
||||
end, _, last_rank, last_name = previous
|
||||
if rank < last_rank:
|
||||
errors.append(f"{path}:{index + 1}: const visibility must be pub, pub(crate), private")
|
||||
if rank == last_rank and _natural_key(name) < _natural_key(last_name):
|
||||
errors.append(f"{path}:{index + 1}: const names out of alphabetical order: {last_name}, {name}")
|
||||
between = lines[end + 1:index]
|
||||
if all(not candidate.strip() for candidate in between):
|
||||
expected = 0 if rank == last_rank else 1
|
||||
if len(between) != expected:
|
||||
errors.append(f"{path}:{index + 1}: expected {expected} blank line(s) between const declarations")
|
||||
end = _end_of_const(code_lines, index)
|
||||
previous = (end, index + 1, rank, name)
|
||||
index = end + 1
|
||||
continue
|
||||
# Comments, attributes and whitespace attach to the surrounding block.
|
||||
if code.strip() and not lines[index].lstrip().startswith(("//", "/*", "*", "#[")):
|
||||
previous = None
|
||||
index += 1
|
||||
return errors
|
||||
|
||||
|
||||
def main() -> int:
|
||||
"""Run the read-only top-level const-block audit."""
|
||||
|
||||
parser = argparse.ArgumentParser(description=__doc__)
|
||||
parser.add_argument("paths", nargs="+", help="Rust files or directories to inspect")
|
||||
args = parser.parse_args()
|
||||
files, errors = selected_files(args.paths)
|
||||
if errors or not files:
|
||||
for error in errors or ["no Rust files selected"]:
|
||||
print(f"Rust const-block audit: {error}", file=sys.stderr)
|
||||
return 2
|
||||
for path in files:
|
||||
try:
|
||||
errors.extend(audit_file(path))
|
||||
except (OSError, UnicodeError) as error:
|
||||
print(f"Rust const-block audit: cannot read {path}: {error}", file=sys.stderr)
|
||||
return 2
|
||||
for error in errors:
|
||||
print(error, file=sys.stderr)
|
||||
if errors:
|
||||
print(f"Rust const-block audit: {len(errors)} error(s) across {len(files)} file(s)", file=sys.stderr)
|
||||
return 1
|
||||
print(f"Rust const-block audit: clean ({len(files)} file(s))")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
7
templates/rust-cargo/.cargo/config.toml
Normal file
7
templates/rust-cargo/.cargo/config.toml
Normal file
@@ -0,0 +1,7 @@
|
||||
# file: templates/rust-cargo/.cargo/config.toml
|
||||
# version: 1
|
||||
|
||||
# Replace project-name with a unique name before using this configuration.
|
||||
[build]
|
||||
target-dir = "../builds/project-name/target"
|
||||
build-dir = "../builds/project-name/target"
|
||||
41
templates/rust-cargo/Cargo.toml
Normal file
41
templates/rust-cargo/Cargo.toml
Normal file
@@ -0,0 +1,41 @@
|
||||
# file: templates/rust-cargo/Cargo.toml
|
||||
# version: 1
|
||||
|
||||
[workspace]
|
||||
resolver = "3"
|
||||
members = ["crates/project-core-lib"]
|
||||
|
||||
[workspace.package]
|
||||
# Replace this example with the release-unit version before adopting this template.
|
||||
version = "0.1.0"
|
||||
edition = "2024"
|
||||
publish = false
|
||||
# Add license, repository, and authors only with the project's real values.
|
||||
|
||||
[workspace.dependencies]
|
||||
# Add dependencies actually shared by multiple crates, with reviewed versions.
|
||||
|
||||
[workspace.lints.rust]
|
||||
missing_docs = "warn"
|
||||
unreachable_pub = "deny"
|
||||
unsafe_code = "forbid"
|
||||
|
||||
[workspace.lints.clippy]
|
||||
unwrap_used = "deny"
|
||||
expect_used = "deny"
|
||||
implicit_return = "deny"
|
||||
needless_return = "allow"
|
||||
useless_vec = "deny"
|
||||
question_mark = "deny"
|
||||
question_mark_used = "deny"
|
||||
needless_match = "allow"
|
||||
manual_ok_err = "allow"
|
||||
manual_unwrap_or = "allow"
|
||||
manual_map = "allow"
|
||||
match_like_matches_macro = "allow"
|
||||
single_match = "allow"
|
||||
manual_unwrap_or_default = "allow"
|
||||
manual_find = "allow"
|
||||
explicit_counter_loop = "allow"
|
||||
get_first = "allow"
|
||||
implicit_saturating_sub = "allow"
|
||||
23
templates/rust-cargo/clippy.toml
Normal file
23
templates/rust-cargo/clippy.toml
Normal file
@@ -0,0 +1,23 @@
|
||||
# file: templates/rust-cargo/clippy.toml
|
||||
# version: 1
|
||||
|
||||
# Baseline shared by the KSP and Games projects; adapt thresholds per project.
|
||||
too-many-arguments-threshold = 16
|
||||
type-complexity-threshold = 250
|
||||
single-char-binding-names-threshold = 3
|
||||
trivial-copy-size-limit = 16
|
||||
pass-by-value-size-limit = 256
|
||||
stack-size-threshold = 512000
|
||||
vec-box-size-threshold = 4096
|
||||
max-fn-params-bools = 2
|
||||
max-include-file-size = 1048576
|
||||
cognitive-complexity-threshold = 25
|
||||
too-large-for-stack = 2048
|
||||
enum-variant-size-threshold = 200
|
||||
large-error-threshold = 128
|
||||
avoid-breaking-exported-api = true
|
||||
allow-unwrap-in-tests = true
|
||||
allow-expect-in-tests = true
|
||||
allow-useless-vec-in-tests = true
|
||||
disallowed-names = ["foo", "bar", "baz", "tmp"]
|
||||
allowed-idents-below-min-chars = ["id"]
|
||||
14
templates/rust-cargo/crates/project-core-lib/Cargo.toml
Normal file
14
templates/rust-cargo/crates/project-core-lib/Cargo.toml
Normal file
@@ -0,0 +1,14 @@
|
||||
# file: templates/rust-cargo/crates/project-core-lib/Cargo.toml
|
||||
# version: 1
|
||||
|
||||
[package]
|
||||
name = "project-core-lib"
|
||||
version.workspace = true
|
||||
edition.workspace = true
|
||||
publish.workspace = true
|
||||
|
||||
[dependencies]
|
||||
# Inherit only the workspace dependencies this crate actually uses.
|
||||
|
||||
[lints]
|
||||
workspace = true
|
||||
23
templates/rust-cargo/rustfmt.toml
Normal file
23
templates/rust-cargo/rustfmt.toml
Normal file
@@ -0,0 +1,23 @@
|
||||
# file: templates/rust-cargo/rustfmt.toml
|
||||
# version: 1
|
||||
|
||||
edition = "2024"
|
||||
newline_style = "Unix"
|
||||
use_small_heuristics = "Default"
|
||||
hard_tabs = false
|
||||
tab_spaces = 4
|
||||
max_width = 160
|
||||
chain_width = 140
|
||||
fn_call_width = 140
|
||||
attr_fn_like_width = 140
|
||||
struct_lit_width = 100
|
||||
struct_variant_width = 100
|
||||
array_width = 140
|
||||
single_line_if_else_max_width = 120
|
||||
single_line_let_else_max_width = 120
|
||||
reorder_imports = true
|
||||
reorder_modules = true
|
||||
match_block_trailing_comma = true
|
||||
use_field_init_shorthand = true
|
||||
use_try_shorthand = false
|
||||
force_explicit_abi = true
|
||||
76
tests/test_markdown_headers.py
Normal file
76
tests/test_markdown_headers.py
Normal file
@@ -0,0 +1,76 @@
|
||||
# file: tests/test_markdown_headers.py
|
||||
# version: 1
|
||||
|
||||
"""Exercise the Markdown header audit's real file and CLI contracts."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pathlib
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
_SCRIPT = pathlib.Path(__file__).resolve().parents[1] / "scripts/audit_markdown_headers.py"
|
||||
|
||||
|
||||
class MarkdownHeaderAuditTests(unittest.TestCase):
|
||||
def setUp(self) -> None:
|
||||
temporary = tempfile.TemporaryDirectory(prefix="pgr-headers-")
|
||||
self.addCleanup(temporary.cleanup)
|
||||
self.root = pathlib.Path(temporary.name)
|
||||
|
||||
def source(self, name: str, contents: str) -> pathlib.Path:
|
||||
path = self.root / name
|
||||
path.parent.mkdir(parents=True, exist_ok=True)
|
||||
path.write_text(contents, encoding="utf-8")
|
||||
return path
|
||||
|
||||
def run_audit(self, *paths: str) -> subprocess.CompletedProcess[str]:
|
||||
return subprocess.run(
|
||||
[sys.executable, "-B", str(_SCRIPT), *paths],
|
||||
cwd=self.root, capture_output=True, text=True, check=False,
|
||||
)
|
||||
|
||||
def test_valid_root_and_nested_files_are_deduplicated(self) -> None:
|
||||
self.source("README.md", "<!-- file: README.md -->\n<!-- version: 1 -->\n")
|
||||
self.source("docs/page.md", "<!-- file: docs/page.md -->\n<!-- version: 27 -->\n")
|
||||
result = self.run_audit("README.md", "docs", "docs/page.md")
|
||||
self.assertEqual(result.returncode, 0, result.stderr)
|
||||
self.assertIn("clean (2 file(s))", result.stdout)
|
||||
|
||||
def test_wrong_path_and_nonpositive_revision_report_both_lines(self) -> None:
|
||||
self.source("docs/page.md", "<!-- file: docs/other.md -->\n<!-- version: 0 -->\n")
|
||||
result = self.run_audit("docs/page.md")
|
||||
self.assertEqual(result.returncode, 1)
|
||||
self.assertIn("docs/page.md:1:", result.stderr)
|
||||
self.assertIn("docs/page.md:2:", result.stderr)
|
||||
self.assertIn("2 error(s)", result.stderr)
|
||||
|
||||
def test_leading_zero_revision_is_rejected(self) -> None:
|
||||
self.source("README.md", "<!-- file: README.md -->\n<!-- version: 01 -->\n")
|
||||
result = self.run_audit("README.md")
|
||||
self.assertEqual(result.returncode, 1)
|
||||
self.assertIn("README.md:2:", result.stderr)
|
||||
|
||||
def test_missing_path_is_a_selection_error(self) -> None:
|
||||
result = self.run_audit("missing.md")
|
||||
self.assertEqual(result.returncode, 2)
|
||||
self.assertIn("unsupported or missing path", result.stderr)
|
||||
|
||||
def test_empty_directory_is_a_selection_error(self) -> None:
|
||||
(self.root / "docs").mkdir()
|
||||
result = self.run_audit("docs")
|
||||
self.assertEqual(result.returncode, 2)
|
||||
self.assertIn("no Markdown files selected", result.stderr)
|
||||
|
||||
def test_generated_directory_is_skipped(self) -> None:
|
||||
self.source("docs/visible.md", "<!-- file: docs/visible.md -->\n<!-- version: 1 -->\n")
|
||||
self.source("docs/target/skip.md", "incorrect\n")
|
||||
result = self.run_audit("docs")
|
||||
self.assertEqual(result.returncode, 0, result.stderr)
|
||||
self.assertIn("clean (1 file(s))", result.stdout)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
137
tests/test_rust_audits.py
Normal file
137
tests/test_rust_audits.py
Normal file
@@ -0,0 +1,137 @@
|
||||
# file: tests/test_rust_audits.py
|
||||
# version: 1
|
||||
|
||||
"""Targeted contracts for the two optional Rust style audits."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pathlib
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import unittest
|
||||
|
||||
sys.path.insert(0, str(pathlib.Path(__file__).resolve().parents[1] / "scripts"))
|
||||
|
||||
from audit_rust_blank_lines import audit_file as audit_blanks # noqa: E402
|
||||
from audit_rust_const_blocks import audit_file as audit_consts # noqa: E402
|
||||
from _rust_audit_common import selected_files # noqa: E402
|
||||
|
||||
|
||||
class RustAuditTests(unittest.TestCase):
|
||||
def setUp(self) -> None:
|
||||
self.temporary = tempfile.TemporaryDirectory()
|
||||
self.addCleanup(self.temporary.cleanup)
|
||||
self.root = pathlib.Path(self.temporary.name)
|
||||
|
||||
def source(self, text: str) -> pathlib.Path:
|
||||
path = self.root / "source.rs"
|
||||
path.write_text(text, encoding="utf-8")
|
||||
return path
|
||||
|
||||
def test_clean_body_and_const_visibility_groups(self) -> None:
|
||||
path = self.source("""pub const ALPHA: u8 = 1;
|
||||
pub const BETA: u8 = 2;
|
||||
|
||||
pub(crate) const GAMMA: u8 = 3;
|
||||
|
||||
const OMEGA: u8 = 4;
|
||||
|
||||
fn sample() {
|
||||
let value = r#"{\n\n}"#;
|
||||
println!("{value}");
|
||||
}
|
||||
""")
|
||||
self.assertEqual(audit_blanks(path), [])
|
||||
self.assertEqual(audit_consts(path), [])
|
||||
|
||||
def test_blank_body_and_repeated_blank_lines(self) -> None:
|
||||
path = self.source("""fn sample() {
|
||||
let value = 1;
|
||||
|
||||
|
||||
println!("{value}");
|
||||
}
|
||||
""")
|
||||
issues = audit_blanks(path)
|
||||
self.assertTrue(any("consecutive" in issue for issue in issues))
|
||||
self.assertTrue(any("inside fn body" in issue for issue in issues))
|
||||
|
||||
def test_blank_string_and_nested_comment_braces_are_ignored(self) -> None:
|
||||
path = self.source('''fn sample() {
|
||||
let data = r#"{
|
||||
|
||||
|
||||
}"#;
|
||||
/* outer { /* inner } */ outer } */
|
||||
println!("{data}");
|
||||
}
|
||||
''')
|
||||
self.assertEqual(audit_blanks(path), [])
|
||||
|
||||
def test_struct_body_and_tuple_struct(self) -> None:
|
||||
path = self.source("""struct Payload {
|
||||
x: u8,
|
||||
|
||||
y: u8,
|
||||
}
|
||||
|
||||
struct Pair(u8, u8);
|
||||
""")
|
||||
self.assertEqual(len(audit_blanks(path)), 1)
|
||||
self.assertIn("struct body", audit_blanks(path)[0])
|
||||
|
||||
def test_const_order_and_multiline_initializer(self) -> None:
|
||||
path = self.source("""const BETA: [u8; 2] = [
|
||||
1,
|
||||
2,
|
||||
];
|
||||
const ALPHA: u8 = 1;
|
||||
|
||||
pub const GAMMA: u8 = 3;
|
||||
""")
|
||||
issues = audit_consts(path)
|
||||
self.assertTrue(any("alphabetical" in issue for issue in issues))
|
||||
self.assertTrue(any("visibility" in issue for issue in issues))
|
||||
|
||||
def test_const_spacing(self) -> None:
|
||||
path = self.source("""pub const ALPHA: u8 = 1;
|
||||
|
||||
pub const BETA: u8 = 2;
|
||||
pub(crate) const GAMMA: u8 = 3;
|
||||
""")
|
||||
issues = audit_consts(path)
|
||||
self.assertEqual(sum("blank line(s)" in issue for issue in issues), 2)
|
||||
|
||||
def test_const_function_does_not_join_const_block(self) -> None:
|
||||
path = self.source("""const ZETA: u8 = 1;
|
||||
|
||||
const fn compute() -> u8 {
|
||||
1
|
||||
}
|
||||
|
||||
const ALPHA: u8 = 2;
|
||||
""")
|
||||
self.assertEqual(audit_consts(path), [])
|
||||
|
||||
def test_scope_and_missing_path(self) -> None:
|
||||
self.source("fn sample() {}\n")
|
||||
selected, errors = selected_files([str(self.root), str(self.root / "absent.rs")])
|
||||
self.assertEqual(len(selected), 1)
|
||||
self.assertEqual(len(errors), 1)
|
||||
|
||||
def test_cli_status_for_success_violation_and_invalid_selection(self) -> None:
|
||||
path = self.source("const ALPHA: u8 = 1;\nconst BETA: u8 = 2;\n")
|
||||
script = pathlib.Path(__file__).resolve().parents[1] / "scripts" / "audit_rust_const_blocks.py"
|
||||
|
||||
def run(subject: pathlib.Path) -> subprocess.CompletedProcess[str]:
|
||||
return subprocess.run([sys.executable, "-B", str(script), str(subject)], capture_output=True, text=True, check=False)
|
||||
|
||||
self.assertEqual(run(path).returncode, 0)
|
||||
path.write_text("const BETA: u8 = 1;\nconst ALPHA: u8 = 2;\n", encoding="utf-8")
|
||||
self.assertEqual(run(path).returncode, 1)
|
||||
self.assertEqual(run(self.root / "missing.rs").returncode, 2)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user