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

SPIP 3.2

Matthieu Marcillaud, peetdu, tofulm — 2017-10-13T12:56:56Z

SPIP 3.2 est une version améliorée de SPIP 3.1, qui comprend une mise à jour des bibliothèques JavaScript embarquées, une meilleure ergonomie de l'espace privé ainsi que de nombreuses améliorations.

Sommaire

Voici le détail des évolutions

Javascript

jQuery

Mise à jour de jQuery en version 3.2 (dans SPIP 3.1 c'est jQuery 1.12). https://jquery.com/upgrade-guide/3.0
intégration de jQuery-migrate-3.0.1.js pour faciliter les migrations des scripts utilisant jQuery. https://github.com/jquery/jquery-migrate/#README

Note importante : Ces changements impliquent qu'il est fortement conseillé de mettre à jour les scripts utilisant jQuery. Cela concerne principalement les modifications suivantes :

bind() => on()
unbind() => off()
load() => on('load', ...)
unload() => on('unload', ...)
jQuery.isArray() => Array.isArray()

jQuery UI

Mise à jour de jQuery UI en version 1.12 (dans SPIP 3.0 c'est jQuery UI 1.11). http://jqueryui.com/upgrade-guide/1.12/ . Changement d'implémentation au passage :
- tout jQuery UI est chargé dans l'espace privé par défaut.
- Dans l'espace public, dès lors qu'un élément de jQuery UI est demandé via le pipeline "jqueryui_plugins", tout le JS / CSS de jQuery UI est également chargé.

Note importante : Ces changements impliquent que les usages de javascript qui chargeaient des modules de jQuery UI avec $.getScript() ne fonctionneront plus. Vous pouvez soit charger globalement jQuery UI dans votre squelette, ou via le pipeline jqueryui_plugins pour un plugin, soit utiliser $.getScript() sur le chemin du fichier "jquery-ui.js" directement.

Ainsi :
$.getScript("#CHEMIN{prive/javascript/ui/core.js}", function(){ $.getScript("#CHEMIN{prive/javascript/ui/widget.js}", function(){ $.getScript("#CHEMIN{prive/javascript/ui/mouse.js}", function(){ $.getScript("#CHEMIN{prive/javascript/ui/sortable.js}", function(){ // ... })})})}); 
Pourrait devenir :
$.getScript("#CHEMIN{prive/javascript/ui/jquery-ui.js}", function(){ // ... }); 

JS Cookie

La librairie JS Cookies est intégrée en version 2.1.4. Elle remplace jQuery.cookie. https://github.com/js-cookie/js-cookie
L'ancienne écriture $.cookie() fonctionne encore dans la plupart des usages mais il est conseillé de migrer :
- $.cookie(key) devient Cookies.get(key)
- $.cookie(key, value) devient Cookies.set(key, value)
- $.cookie(key, value, options) devient Cookies.set(key, value, options)

PHP

Nombreuses notices PHP enlevées encore.
Compatibilité PHP 7.4 maximum

Core

Tri des items de navigation & entrées favorites
Le fonctionnement du plugin « Menu privé alphabétique » est intégré :

les sous-menus de navigation (au survol des menus « Édition », « Publication », « Activité », ...) sont maintenant triés par ordre alphabétique [1].
dans ses préférences personnelles, il est maintenant possible de cocher des entrées de menus « favorites », qui s'afficheront alors en tête dans les sous-menus de navigation concernés.
si un sous-menu contient plus de 20 entrées, il est alors affiché en 2 colonnes.

Simplification du « cookie de correspondance »

Le bouton pour activer ce cookie dans l'espace privé n'était pas explicite. Par ailleurs, le cookie se désactivait à terme si un auteur se connectait régulièrement sur un même site. La solution retenue est de supprimer la notion (et le bouton) de « cookie de correspondance », et de créer le cookie (dit d'admin) systématiquement lorsqu'un auteur se loge et a les droits d'accès à l'espace privé. Le cookie d'admin est renouvelé en même temps que le cookie de session. Et s'enlève en se déconnectant.
Tickets associés : #1740, #1710.

Dépendances des plugins à des extensions PHP

Il est maintenant possible d'indiquer dans un paquet.xml qu'un plugin a besoin d'une extension PHP pour fonctionner. Ticket #3829. Une erreur sera affichée dans le cas contraire à l'activation du plugin. Syntaxe :

Formulaire
La balise #FORMULAIRE_INSCRIPTION s'enrichie de deux nouvelles possibilités :

elle accepte un 3e argument pour indiquer la page vers laquelle on redirige la personne lorsqu'elle confirme son inscription ;
Il est possible de forcer l'utilisation du lien de confirmation contenu dans l'email.

Les explications détaillées dans l'article FORMULAIRE_INSCRIPTION

Critères

le critère {par champ} a été réécrit et tolère mieux les noms de champs provenant de tables de jointures, en harmonisant avec {par num champ} et {par multi champ} le fonctionnement. Des expressions {par expr champ} peuvent maintenant être créées sans surcharger tout le critère, à toutes fins utiles.
ajout de {par sinum champ} qui met en premier les éléments ayant des numéros (hors 0.). Ainsi {par sinum titre, num titre, titre} mettra les titres avec des numéros avant ceux n'en ayant pas (contrairement à {par num titre, titre}), puis triera par numéro. Et contrairement à {par titre, num titre}, le numéro 100 sera bien placé après le numéro 20.

Pipelines

formulaire_receptionner : pipeline appelé au moment où un formulaire est posté par un visiteur, mais avant l'analyse des données postées par la fonction de vérification. https://core.spip.net/projects/spip/repository/revisions/23308

Divers tickets

Inclusions, connect & pagination (Tickets #3823 et #3899) : les paginations ajax prennent en compte le paramètre connect qui était utilisé. Le connect explicité sur une inclusion est prioritaire sur celui provenant de l'URL.
Limiter le nombre de fichiers de session d'un auteur (Ticket #3807)
Permettre d'envoyer un nouveau mot de passe à un auteur depuis l'interface privée (Ticket #2250)

Fichiers supprimés

ecrire/inc/aider.php (déplacé dans plugins-dist/aide/inc/aide.php)
ecrire/inc/pclzip.php (déplacé dans plugins-dist/archiviste/inc/pclzip.php)

Déplacements

les filtres de dates sont maintenant dans inc/filtres_dates.php (déplacés depuis inc/filtres.php) (Ticket #3583).

Suppression

les fonctions dépréciées afficher_plus(), debut_cadre_couleur_foncee(), fin_cadre_couleur_foncee() sont passées dans le plugin Grenier.

Plugins

Aide

Nouveau plugin qui intègre la gestion de l'aide en ligne (fonctions déplacées depuis le Core ou plugin SVP)

Archiviste

Nouveau plugin qui intègre la gestion des archives zip et tar (fonctions déplacées depuis le Core)

Filtres Images

Suppression des fonctions et fichiers dépréciés depuis SPIP 2.1 (Ticket #3601). Les éléments ont été déplacés dans le plugin Grenier.

Grenier

Accueil des fonctions dépréciées du plugin Filtres images.
Accueil des fonctions dépréciées du Core

Médias

Intégration du plugin Minidoc dans le plugin médias. Il permet différents affichages des listes de documents attachés aux objets éditoriaux. Ticket #3888
Modification également de la présentation par défaut de ces listes documents attachés
Intégration du plugin Ordoc dans le plugin médias. Ticket #3887. Il permet d'ordonner les listes de documents joints aux objets éditoriaux [2], et ajoute un champ "rang_lien" dans la table spip_documents_liens. Il devient alors possible d'utiliser des boucles telle que :
```
 
```
.
Changement de structure du code HTML attendu en retour du pipeline afficher_metas_document, qui par ailleurs envoie le code HTML des détails affichés pour le document plutôt que rien par défaut, ce qui permet de compléter la balise utilisée.Mots Ajout d'une administration avancée sur les mots pour permettre de les fusionner ou de créer des associations/dissociations par rapport à un autre mot clé Commit 100448 Organiseur Mise à jour de la librairie FullCalendar en version 3.5.1 (auparavant en version 1.6). Pour migrer si vous utilisiez cette librairie dans l'espace public, se reporter à https://fullcalendar.io/wiki/Upgrading-to-v2/ ou https://fullcalendar.io/docs/ Intégration de la librairie Moment.js (nécessaire à FullCalendar) Sites Permettre de rechercher dans les articles syndiqués sur un site. Ticket #3859 SVP - Gestion des plugin Prise en compte de l'affichage des erreurs de dépendances sur les extensions PHP. Ticket #3819. Affichage plus compréhensible des versions sur les erreurs de dépendances. On peut maintenant télécharger un plugin sans l'activer. Dans ce cas on reste sur la page de recherche de plugin. Ticket #3471 Afficher une barre de progression lors d'actions multiples (évite des erreurs de redirections). Ticket #3473 Correction de l'absence de confirmation des actions lorsque des actions supplémentaires sont ajoutées automatiquement par SVP (par exemple activer ou désactiver des dépendances). inc/pcltar.php et lib/pcltar/ déplacés dans le plugin Archiviste. URL Étendues Les URLs Arborescentes (principalement) peuvent gérer du multilinguisme (champs multis sur les rubriques par exemple) et des parents multiples (polyhiérarchie). Tolérer plusieurs parents pour un objet. Commit 100814 Ajout d'un champ langue sur la table spip_urls. Commit 100835 Il est possible de définir une URL spécifique pour une certaine langue langue sur un objet éditorial en éditant l'URL. Pour ce faire, dans le champ de saisie, indiquer [code langue]:[url propre] tel que en:movies et fr:videos. Commit 100835 La déclaration du « type » préfixant éventuellement l'URL d'un objet dans les URLs arborescentes (exemple : 'mot' dans mot/titre_du_mot) peut recevoir une écriture à base de balise multi pour que le terme soit traduit en fonction de la langue Commit 100836 Les URLs arborescentes peuvent gérer du multilinguisme, en ajoutant le code de langue dans l'URL, activable par la constante _url_arbo_multilang. Commit 100844. [1] Auparavant, l'ordre pouvait dépendre d'une position souhaitée, mais aussi de l'ordre dont s'activaient les plugins [2] Pour les sites qui utilisaient le plugin Mosaique pour cela, un plugin de migration existe SPIP 3.1 L'équipe de SPIP, tofulm — 2016-01-09T09:21:09Z SPIP 3.1 est une version améliorée de SPIP 3.0, qui comprend une mise à jour des bibliothèques JavaScript embarquées, un nouvel habillage graphique pour l'espace privé et les pages publiques ainsi que de nombreuses améliorations. Sa maintenance active s'arrête le 30 juin 2019. À compter de cette date, seule les correctifs liés à la sécurité lui seront apportés. Sommaire SPIP 3.1 : des nouveautés SPIP 3.1 : l'écriture des squelettes est facilitée SPIP 3.1 : sous le capot SPIP 3.1 : un code source plus beau SPIP 3.1 : les performances web coté client Mettre à jour un site existant vers SPIP 3.1 Cette version sort trois ans après SPIP 3.0 et offre essentiellement aux développeurs : une mise à jour des bibliothèques JavaScript qui accompagnent le cœur de SPIP et les plugins fournis, avec notamment jQuery et jQuery UI ; une actualisation du thème graphique de l'espace public. Ce thème intègre la base CSS Tiny Typo ; Lire Présentation de la dist une actualisation légère du thème graphique de l'espace privé ; des nouveautés et de nombreux bugs corrigés. SPIP 3.1 : des nouveautés Les rédacteurs et administrateurs pourront trouver utile : un bouton supplémentaire sur les barres d'outils d'édition qui permet d'éditer le texte en plein écran, avec sa prévisualisation directe sur le côté ; le lecteur multimédia HTML5 http://mediaelementjs.com fourni en standard pour lire directement vidéos et sons ; l'ajout d'une vidéo calcule, ses dimensions et sa durée (intégration partielle du plugin getID3 dans le plugin médias) ; les forums de discussion dans l'espace privé peuvent se greffer sur n'importe quel objet éditorial via un formulaire de configuration ; les statistiques peuvent être affichées soit sous forme de graphique, soit sous forme de tableau ; la page plan de l'espace privé est améliorée et permet de déplacer des éléments par glisser/déposer ; une nouvelle option dans les préférences personnelles des webmestres pour afficher ou non le menu « Développement » ; des améliorations de l'ergonomie du multilinguisme par secteur. SPIP 3.1 : l'écriture des squelettes est facilitée Critères le critère {age} est modifié, code simplifié et débogué pour certaines durées ; le critère {tri} accepte un 3e argument avec le nom commençant par 'session' et indiquant que le sens et l'élément trié doivent être sauvés dans la session de l'utilisateur ; le critère {branche} accepte un second argument pour préciser la ou les rubriques à parcourir. Balises la balise #MODELE accepte le paramètre env transmettant l'environnement complet ; la balise #INCLURE transmet l'éventuel paramètre connect présent dans l'URL, tout comme le fait déjà l'inclusion Filtres le nouveau filtre |setenv Logos et images filtre_inactif au lieu de no_image_filtrer ; la classe .spip_logo sur les documents à la place de .spip_logos (.spip_logos supporté encore quelques temps) ; l'action d'édition des logos a évolué : la hauteur ou largeur maximale des logos peuvent être définies seules ; si un logo ou une image téléversée dépasse la taille maximale autorisée, et que les miniatures sont autorisées, on réduit le logo ou l'image transmise à la taille maximale plutôt que renvoyer une erreur ; si un document dépasse la taille exploitable par le serveur, une erreur est affichée sans poser de problème ajax. Plugins meilleure ergonomie de l'interface de gestion des plugins ; nouvelles balises dans le paquet.xml ; script pour ajouter un script JavaScript dans le header public ou privé ; style pour ajouter un fichier CSS ; genie pour exécuter une tache cron simplement ; procure pour indiquer qu'un plugin procure des fonctionnalités. SPIP 3.1 : sous le capot Certaines modifications mineures du core peuvent intéresser les hébergeurs ou webmestres de sites SPIP : les sessions anonymes de SPIP utilisent maintenant les sessions PHP ; le cache des vignettes d'images est stocké dans 256 sous-répertoires (#3277), ce qui peut améliorer les performances sur les disques NAS ; lors de l'utilisation d'une base MySQL, les fonctions PHP mysqli_* sont utilisées à la place des fonctions mysql_*. Il faut donc que les fonctions mysqli soient présentes sur le serveur hébergeant le site (elles sont actives par défaut dans PHP depuis la version 5.0) ; les tables MySQL utilisent maintenant MyISAM par défaut (les versions récentes de MySQL s'installaient en INNODB) ; la gestion du cache a été améliorée en reprenant la méthode filecache du plugin mémoization ; les révisions des objets éditoriaux ne sont plus stockées de façon compressée afin d'éviter des problèmes lors de la restauration de sauvegardes de la base de données ; intégration des fonctions d'import/export de fichiers CSV du plugin SPIP-Bonux ; API objet_inserer() plus consistante avec le second paramètre $set ; API de rôles sur les liens : aux liens entre objets peuvent être associés des rôles. SPIP 3.1 : un code source plus beau Un gros travail sur la présentation du code source a été effectué : adoption des normes de codage PSR2 personnalisées ; annotation de nombreuses fonctions PHP au format phpDoc [1] qui permet de générer automatiquement une documentation technique du code source ; nombreuses « notices » PHP corrigées. SPIP 3.1 : les performances web coté client Dans une optique de performance, la méthode getScript de la bibliothèque JavaScript jQuery est surchargée pour utiliser le cache navigateur. En effet, par défaut, jQuery ne met pas en cache ces éléments. Il est par conséquent conseillé dans un squelette SPIP, utilisant jQuery.getScript(...), d'appliquer le filtre timestamp au fichier demandé, de sorte qu'une modification du fichier source entraîne une actualisation du cache navigateur. Exemple : jQuery.getScript('[(#CHEMIN{prive/javascript/ui/widget.js}|timestamp)]', function(){ ... }); Un header Link est envoyé dans les en-têtes HTTP pour annoncer la feuille de style compressée pour qu'elle soit chargée plus rapidement par le navigateur. Bibliothèque jQL dans le plugin Compresseur Il est également possible d'activer via la constante _JS_ASYNC_LOAD un chargement asynchrone du JavaScript compressé de l'espace public par l'intermédiaire de la bibliothèque jQL intégrée au compresseur. Il faut que les scripts « inline » soient compatibles. Mettre à jour un site existant vers SPIP 3.1 Vérifier la compatibilité de ses plugins Avant le lancer la mise à jour par les méthodes habituelles (FTP, Spip loader, Subversion), il est conseillé de mettre à jour ses plugins. Le plugin suivant permet aussi de vérifier si les plugins de votre site sont bien compatibles avec SPIP 3.1 http://contrib.spip.net/Verifier-ses-plugins-pour-le-passage-a-SPIP-3-1 Passer un plugin SPIP 3.0 vers SPIP 3.1 À ce sujet, consulter l'article de spip-contrib. Au sommaire : Bibliothèques JavaScript jQuery et jQuery UI Formulaires CVT Jointures Manipulation des logos Balise #FICHIER Une fois testé et approuvé... Évolution des bibliothèques JavaScript La mise-à-jour des bibliothèques JavaScript intégrées à SPIP 3.1 peut dans certains cas nécessiter une mise-à-jour des squelettes ou plugins lors d'une migration depuis SPIP 3.0. Particulièrement, pour les mises-à-jour de jQuery et jQuery UI. Vous pouvez regarder les conseils de mise-à-jour de ces bibliothèques respectives : jQuery est mis à jour de 1.7.2 à 1.11.3 . Voir jquery 1.8, jQuery 1.9, jquery 1.9 guide de mise-à-jour, jQuery 1.10, jQuery 1.11 ; jQuery UI est mis à jour de 1.8.21 à 1.11.4. Voir les guides de migration. Notez également que les emplacement des fichiers JavaScript et CSS dans jQuery UI comme dans le plugin SPIP jQuery UI ont changé. Les inclusions de ces scripts dans les squelettes devront donc probablement être réécrites. [1] texte de documentation précédent le code source d'une fonction, dans un format précis

SPIP

Les outils utilisés pour le développement

SPIP 3.2

Sommaire

Javascript

PHP

Core

Plugins

SPIP 3.1

Sommaire

SPIP 3.1 : des nouveautés

SPIP 3.1 : l'écriture des squelettes est facilitée

SPIP 3.1 : sous le capot

SPIP 3.1 : un code source plus beau

SPIP 3.1 : les performances web coté client

Mettre à jour un site existant vers SPIP 3.1