Tech de Gamuza

Utiliser PHP_codeSniffer : les bases

clem — 2024-03-01T11:52:45Z

Usage : quelques exemples de commandes

Tester un fichier php seul :

phpcs dossier/fichier_truc.php

Tester un dossier complet : par ex à la racine d'un répertoire de plugin
(/ !\ attention ! lancer phpcs sur un gros dossier avec beaucoup de fichiers (php / css / js) sans faire de restrictions via la configuration peut entraîner une GROSSE charge pour votre processeur !)

phpcs dossier/

devrait retourner tout un tas d'erreurs à corriger, pour à peu près tous les types de fichiers (js, css, php)

Restreindre la portée du scan aux fichiers PHP, exclure des dossiers :
En ajoutant le fichier phpcs.xml à la racine du répertoire avec le contenu proposé dans momh.fr, on doit restreindre la détection des erreurs aux fichiers .html et .php
Le contenu du fichier :

<?xml version="1.0"?> <ruleset> <file>./</file> <exclude-pattern>**/*.js</exclude-pattern> <exclude-pattern>**/*.css</exclude-pattern> <exclude-pattern>**/*.scss</exclude-pattern> <exclude-pattern>node_modules/*</exclude-pattern> <exclude-pattern>vendor/*</exclude-pattern> <arg name="colors"/> <rule ref="SPIP41"/> </ruleset>

Tester uniquement avec les coding-standard de SPIP :

phpcs --standard=SPIP41 dossier/fichier_truc.php

Ne pas afficher les warnings (uniquement les erreurs) :

phpcs -n dossier/fichier_truc.php

Colorer la sortie :

phpcs --colors dossier/fichier_truc.php

Compléments de configuration : l'option —config-set

Utilisation de l'option —config-set :
par exemple si vous n'utilisez phpcs/phpcbf que pour les standards SPIP, pour éviter d'ajouter l'option --standard=SPIP41 à chaque appel de la commande, vous pouvez passer ce paramètre en option par défaut avec :

phpcs --config-set default_standard SPIP41

NB : cela donne une configuration écrite dans le fichier ...Composer/vendor/squizlabs/php_codesniffer/CodeSniffer.conf qu'il est possible de bricoler directement aussi
La syntaxe de cette option est de la forme :

phpcs --config-set clé valeur

par ex pour avoir la coloration par défaut

phpcs --config-set colors 1

La documentation pour les configurations possibles avec l'option —config-set :
https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options

Exemple de fichier de configuration CodeSniffer.conf pour colorer systématiquement, utiliser les standards SPIP41 et ignorer les warnings :

<?php $phpCodeSnifferConfig = array ( 'installed_paths' => 'C:/Users/VOTRE_USER/AppData/Roaming/Composer/vendor/phpcompatibility/php-compatibility,C:/Users/VOTRE_USER/AppData/Roaming/Composer/vendor/spip/coding-standards/src', 'default_standard' => 'SPIP41', 'colors' => 1, 'show_warnings' => 0, ); ?>

Spécifique installation sous Windows :

Adaptations du post de https://momh.fr/installer-globalement-php_codesniffer
On suppose :

l'utilisateur connecté à la session Windows est VOTRE_USER
Composer installé sur la machine
on utilise Gitbash comme interpréteur de commandes (cf https://contrib.spip.net/SPIP-Cli#Specificites-d-installation-sous-Windows)

1/ Installation globale :

composer global --dev require squizlabs/php_codesniffer composer global --dev require spip/coding-standards

Tester que c'est OK :

phpcs --help phpcbf --help

doivent retourner le Help avec toutes les options de la commande

2/ Déclarer le répertoire des standards SPIP à PHP_CodeSniffer :

phpcs --config-set installed_paths C:/Users/VOTRE_USER/AppData/Roaming/Composer/vendor/phpcompatibility/php-compatibility,C:/Users/VOTRE_USER/AppData/Roaming/Composer/vendor/spip/coding-standards/src

cette commande devrait retourner :

Using config file: C:\Users\VOTRE_USER\AppData\Roaming\Composer\vendor\squizlabs\php_codesniffer\CodeSniffer.conf

Pour tester que la config est OK la commande :

phpcs -i

devrait retourner quelque chose comme :

The installed coding standards are MySource, PEAR, PSR1, PSR2, PSR12, Squiz, Zend, PHPCompatibility, SCS1, SPIP40 and SPIP41

Références :

pour l'installation le billet du blog momh.fr : https://momh.fr/installer-globalement-php_codesniffer
le Github de PHP_codeSniffer : https://github.com/squizlabs/PHP_CodeSniffer

One line pour mise à jour Git des sous-dossiers d'un répertoire

clem — 2023-05-18T14:08:15Z

Si ce n'est qu'il faut "boucler" dans la liste des sous-dossiers pour faire le git pull dans chacun d'eux, la complication supplémentaire est de vérifier qu'ils sont bien des dossiers "Git" (c'est à dire qu'ils ont eux-même un sous-dossier .git).
Afin de suivre le déroulement du processus on fait afficher chaque dossier mis à jour.
Ce qui donne donc :

for i in `ls ./`;do if [ -d $i/.git ]; then echo ""; echo $i; cd $i; git pull; cd ../; fi; done

Windows 11 : restaurer les menus contextuels "directs"

clem — 2023-02-17T18:11:40Z

Contexte :

Comme à chaque nouvelle version de Windows, Microsoft a décidé (une fois de plus...) avec Windows 11 que les utilisateurs sont des décérébrés auxquels il faut éviter toute possibilité d'utiliser intelligemment leur ordinateur.
Pour cela les concepteurs de cette version 11 ont choisit que dans l'explorateur de fichier (outil ultra-central pour les utilisateurs un peu efficaces), le menu contextuel qui s'ouvre au clic droit se présente en version minimaliste (en gros toutes les fonctions qui sont en général inutiles car assurée par les raccourcis claviers "de base" : "ouvrir", "propriétés" + des icônes pour "copier", "coller"...). Pour avoir accès à l'ensemble des choix il faut cliquer sur le dernier item "Afficher plus d'options" (ou passer le raccourci clavier Maj + F10).

Le but de ce tuto est donc de se débarrasser de cette infantilisation forcée pour redonner de l'efficaciité à votre OS...
Plusieurs méthodes sont possibles pour cette modification mais elle aboutissent toutes au même résultat : ajouter une clé de registre (vide) :

HKCU\Software\Classes\CLSID\{86ca1aa0-34aa-4e8b-a509-50c905bae2a2}\InprocServer32

Nous en verrons 2 ici.

Méthode 1 : utiliser l'interface graphique de Regedit

ouvrez une invite de commande avec le raccourci clavier Windows + R puis appelez l'utilitaire d'édition du registre en saisissant "regedit" dans le champ "Ouvrir" proposé.
dans l'éditeur du registre ouvrez la "ruche" HKEY_CURRENT_USER puis parcourez l'arborescence des clés Software > Classes > CLSID
créez une nouvelle clé avec clic droit sur CLSID que vous nommez {86ca1aa0-34aa-4e8b-a509-50c905bae2a2}
validez la avec "Entrée" et créez dedans une nouvelle clé nommée InprocServer32
validez avec "Entrée" : vous devriez avoir une valeur par défaut vide dedans :

Registre Windows 11 avec la clé de modification des menus contextuels créée
redémarrez Windows : en principe le menu contextuel doit maintenant vous donner directement accès à la totalité des items !

Méthode 2 : utiliser une commande de modification du registre

plus rapide mais pour le même résultat, vous pouvez faire la création de la clé de registre et de sa sous-clé en une commande.
ouvrez une fenêtre de commande en mode administrateur avec le raccourci clavier Windows + S puis cmd dans la zone de recherche et enfin "Executer en tant qu'administrateur".
dans cette fenêtre exécutez (après un habile copier/coller) la commande suivante : reg.exe add "HKCU\Software\Classes\CLSID\{86ca1aa0-34aa-4e8b-a509-50c905bae2a2}\InprocServer32" /f /ve
vous devriez obtenir le retour L'opération a réussi.
redémarrez la machine

Tests de nom de classe CSS

clem — 2022-12-14T19:01:39Z

Code :

test.123

test#123

test@123

test<123

test123

 test~123
 _test123
 -test123
 123test

 {{{Résultat:}}}  test.123
 test#123
 test@123
 test<123
 123">test`123
test 123
_test123
-test123
123test


ZZZ : URL canonique
clem — 2022-11-30T10:40:27Z

Je demandais hier sur #spip si quelqu'un connaissait un standard pour signaler l'URL canonique d'une page Web. S'koi ? Si on est en train de lire une page sur un site, on peut l'avoir abordée par plusieurs adresses :
 - http://monsite.tld/article12 - http://monsite.tld/Mon-titre-d-article - http://www.monsite.tld/article12.html?couleur=bleu - http://www.monsite.tld/article12.html?post=1 - http://www.monsite.tld/article12.html?PHPSESSID=a2c5fe78
Tout ça, ce sont des URLs valables, qui affichent bien le même article. Mais si je veux mettre des gens (ou des robots) d'accord sur ce qu'est la « vraie » adresse de cet article, il faut que je l'annonce, d'une manière ou d'une autre.
Cette problématique concerne au premier chef les moteurs de recherche et d'indexation (mais pas seulement). Or il se trouve que pas plus tard que la semaine dernière les trois poids lourds Google, Yahoo et Live (Microsoft) annonçaient que leurs algorithmes allaient accepter qu'on leur parle de l'URL canonique d'une page.
– https://developers.google.com/search/blog/2009/02/specify-your-canonical

– https://moz.com/blog/canonical-url-tag-the-most-important-advancement-in-seo-practices-since-sitemaps
C'est bien fait, et c'est simple à mettre en œuvre. En gros, pour toute page HTML qui peut avoir plusieurs adresses, on va indiquer laquelle est la principale, en insérant dans son ... une balise :
 <link rel="canonical" href="http://www.monsite.tld/URL-canonique" />
Les algorithmes qui le souhaitent sauront donc que la page http://www.monsite.tld/article12 qui mentionne ce lien doit en fait être considérée comme étant à l'adresse canonique http://www.monsite.tld/URL-canonique. Et feront leurs calculs (PageRank...) et affichages (résultats de recherche...) en tenant compte de cette information.

* * *
Autre exemple d'usage (qui était celui qui avait suscité ma question) : lorsqu'on veut participer aux sites de partage de bookmarks type delicious.com, il importe que les différents partageurs se mettent d'accord sur une adresse unique, de manière à pouvoir discuter de la même chose, même s'ils l'ont vue dans un contexte différent. Le plugin SPIP Social Tags en tient compte.
Dans le squelette SPIP article.html, il suffit d'indiquer dans la partie .. le code suivant [1] :
 <link rel="canonical" href="[(#URL_ARTICLE|url_absolue)]" />

Pour que Google considère qu'un (vieux) lien vers http://monsite.tld/a1.html pointe en fait vers http://www.monsite.tld/Titre-article (URL canonique de l'article si on a activé les URLs « propres »). Ou que SocialTags indique le nouvel URL dans delicious quand on clique sur l'icone, même si le navigateur indique http://www.monsite.tld/Titre-article?PHPSESSID=12345.

URL canonique et permalien

C'est bien gentil ces URLs canoniques, mais quelle est la différence avec le permalien ?

L'idée du « permalien » d'un article, c'est d'avoir un lien qui référencera toujours cet article ; ainsi, sur un blog, on veut que les gens qui référencent un article ne fassent pas un lien vers la page d'accueil — alors que celle-ci va tourner au fur et à mesure de l'ajout de nouveaux articles — mais plutôt un lien vers une page précise qui affichera toujours l'article dans deux semaines, quand il ne sera plus sur la page d'accueil.

Bien sûr le permalien pointera en général vers l'URL canonique de l'article, ce qui fait qu'en pratique, ces deux propriétés ont la même valeur.

Cependant, les deux notions ne sont pas identiques. On peut imaginer qu'un permalien nous redirige vers l'URL canonique, laquelle peut changer au cours du temps. Par exemple, lorsque SPIP sera racheté par la Mozilla Corp., l'URL canonique de l'article de l'article « Est-ce que je peux... », qui est actuellement http://www.spip.net/fr_article1475.html, deviendra (sur ordre du département marketing) https://spip.mozcorp.world/Est-ce-que-je-peux.html.

L'URL canonique de cet article aura donc changé. Mais http://www.spip.net/fr_article1475.html est et restera un permalien : il affichera toujours le bon article (soit directement, soit en renvoyant le lecteur vers le site mozcorp.world).

Autrement dit :

un permalien (il peut y en avoir plusieurs pour un même article) est un lien qui pointe toujours vers cet article (cette « ressource », en jargon webique). On le code sous la forme . Tant qu'il permet de retrouver la ressource, fût-ce à travers des modifications de formatage des URLs, des redirections et des changements de noms de domaine, c'est un permalien.
l'URL canonique d'une ressource quant à elle est unique (mais pas forcément permanente) : elle signale l'adresse « standard » où il faut aller chercher cette page, même si on l'a trouvée ailleurs. On la référence à l'intérieur de l'entête de la page sous la forme .