SPIP

Utiliser Rector

bricebou — 2025-03-20T13:43:48Z

Rector est un outil de refactoring et d'amélioration automatisé de code PHP ; SPIP s'est doté d'un jeu de règles : https://git.spip.net/spip-league/rector.

Sommaire

Préalable

Il faut un fichier composer.json à la racine du plugin, dans lequel on déclare le dépôt composer propre à SPIP :

{ "repositories": { "spip": { "type": "composer", "url": "https://get.spip.net/composer" } } }

Installation

composer require --dev rector/rector spip-league/rector:"dev-main"

Configuration

La configuration se fait dans le fichier rector.php à la racine de votre plugin :

withPaths([__DIR__]) ->withRootFiles() ->withSets([SpipSetList::SPIP_41, LevelSetList::UP_TO_PHP_74]) ->withSkip([ __DIR__ . '/lang', __DIR__ . '/vendor', ]) ;

On peut configurer des scripts dans le fichier composer.json :

 "scripts": { "rector": "vendor/bin/rector process --ansi", "rector-dry-run": "vendor/bin/rector process --dry-run --ansi" }

Usage

composer rector-dry-run composer rector composer rector dossier/fichier

Utiliser ECS

bricebou — 2025-03-20T13:40:49Z

SPIP propose un jeu de règles pour Easy Coding Standard (https://github.com/easy-coding-standard/easy-coding-standard) via le dépôt spip-league/easy-coding-standard.

L'utiliser permet de s'assurer de respecter les conventions d'écriture PHP utilisées dans la communauté SPIP.

Sommaire

Préalable

Il faut un fichier composer.json à la racine du plugin, dans lequel on déclare le dépôt composer propre à SPIP :

{ "repositories": { "spip": { "type": "composer", "url": "https://get.spip.net/composer" } } }

Installation

L'installation se fait avec la commande :

composer require --dev spip-league/easy-coding-standard

Configuration

Créez le fichier ecs.php à la racine de votre plugin :

withSets([SetList::SPIP]) ->withPaths([__DIR__]) ->withRootFiles() ->withSkip([__DIR__ . '/lang', __DIR__ . '/vendor']) ;

Usage

Pour en faciliter l'usage, on peut ajouter des "alias" dans les scripts du fichier composer.json :

 "scripts": { "check-cs": "vendor/bin/ecs check --ansi", "fix-cs": "vendor/bin/ecs check --fix --ansi" }

composer fix-cs composer fix-cs inc/inc.inc

Les outils utilisés pour le développement

bricebou, b_b, James, Maïeul, Matthieu Marcillaud, placido, tofulm — 2025-01-14T06:58:03Z

L'équipe de maintenance utilise ces outils pour maintenir et développer SPIP. Cet article résume succinctement le rôle des outils et les liens de documentation.

Nom de l'outil	Rôle	Documentation spécifique à la communauté SPIP

Développement côté serveur ou back-end
PHP	Langage dans lequel SPIP est écrit côté serveur
PHPdoc	Commentaire du code
Composer	Installer les bibliothèques de code (library) dont le projet principal a besoin
Qualité de code
Easy Coding Standard	Automatiser le respect des régles de codages	Utiliser ECS
Rector	Corriger du code historique pour le rendre plus durable	Utiliser Rector
PSR	Bonne pratiques de codage	Conventions
PHPUnit	Tester le code
PHPStan	Analyser le code
Refactoring Guru	Inspiration pour transformer le code procédural historique en code POO et pour gagner en robustesse
The Twelve-Factor App	Inspiration : une méthodologie pour concevoir des logiciels en tant que service

Développement côté navigateur ou front-end
Javascript	Langage pour l'affichage dynamique de fragments de page (front-end)
jQuery	Bibliothèque longtemps restée comme référence (en voie de migration)
npm + Bun	Installer des modules ou bibliothèques de code (library)
Qualité de code
bun:test	Tester le code
biomejs	Normaliser le code (linter)

Versionnage
Git	Suivi de version de code	Consulter un livre en français
Gitlab	Plateforme de développement
Sémantique	Comment fonctionnent les versions de SPIP et de ses dépendances
Conventionnel commit	Des messages des commits signifiants, lisibles pour l'humain	Voir aussi Écrire un message de commit
Changelog	Permettre de voir précisément quels changements notables ont été faits entre chaque publication (release) d'un projet	Voir aussi Tenir un CHANGELOG

Nous développons et utilisons aussi nos propres outils :

- spip-releases
- spip-league/ecs
- spip-league/rector
- spip-league/sdk