Coding Standards

Dev
#37

La PR : https://git.spip.net/spip/spip/pulls/4868

les commits

#38

Donc, on merge ?

#39

Pour moi c’est bon, attendons l’avis d’autres personnes :slight_smile:

#40

Bon, c’est mergé et reporté sur la branche 4.0. :white_check_mark:

Maintenant la documentation ^^

#41

Hmmmm, du code bien formaté :slight_smile:
Merci @JamesRezo

1 « J'aime »
#42

Les règles de codage (SCS1) en preview : https://www.spip.net/fr_article6677.html?var_mode=preview

à suivre, les standards SPIP40 et SPIP41

1 « J'aime »
#43

les 2 autres rulesets phpcs sont décrit ici :

#44

Corrigé une micro pétouille, gogogo :slight_smile:

#45

Du coup, la section Étendre SPIP - Règle de codage renvoie vers la rubrique où sont publiés les « standards SPIP » :slight_smile:

#46

Le 02/09/2021 à 13:20, JamesRezo via Discuter de SPIP a écrit :

les 2 autres rulesets phpcs sont décrit ici :

Questionnement : vu la petitesse et la répétition du contenu, et le fait aussi qu’on peut mettre des sommaires aux longs articles : est-ce utile de multiplier les articles plutôt que tout mettre dans la même page avec des titres et un sommaire ?

–
RastaPopoulos

#47

Ha vi, bonne idée, mais peut-être que @JamesRezo a pour projet d’automatiser tout ça par la suite, mais ça n’empêche pas de tout regrouper sur une seule page.

#48

Oui, à moyen/long terme, je pense que ça pourrait être automatisé. C’est vrai que c’est court, mais mon idée à la base était d’avoir un article (donc 1 page web) par « standard ». Afin d’éditer un nouvel article quand un nouveau standard est défini et de n’avoir qu’un seul article à modifier si un standard évolue…

Mais bon, j’imagine qu’à coup de modèle on pourrait sans doute avoir un ensemble de pages un peu plus cool. La rubrique Règles de codage - SPIP est bien triste, je l’admets.

#49

Je n’ai pas trop d’avis pour les articles, l’un et l’autre me vont. C’est vrai que les articles des standards php-cs sont assez courts…

#50

à l’instar des standards eux-même ^^

mais bref, je suis un peu à court d’idée, mais oui, on va trouver un compromis. L’dée des modèles, ça vous paraît une bonne piste ?

#51

Le 02/09/2021 à 12:41, JamesRezo via Discuter de SPIP a écrit :

Les règles de codage (SCS1) en preview : https://www.spip.net/fr_article6677.html?var_mode=preview
https://www.spip.net/fr_article6677.html?var_mode=preview
à suivre, les standards SPIP40 et SPIP41

C’est un beau boulot de s’outiller pour nettoyer le code.

Mais les actuels titres des articles de ces pages : « SCS1 », « SPIP40 » et « SPIP41 » sont ésotériques
et le contenu des articles sera très décevant pour qui tombera là par exemple après avoir cherché « SPIP 4.0 » ou « SPIP 4.1 ».

Par ailleurs est-ce que tout cela ne concerne pas plutôt https://programmer.spip.net ?

JLuc

Voir le sujet https://discuter.spip.net/t/coding-standards/155150/42 ou répondre à ce courriel pour répondre.

    Réponses précédentes

[tcharlss] tcharlss https://discuter.spip.net/u/tcharlss
Août 30

Hmmmm, du code bien formaté :slight_smile:
Merci @JamesRezo https://discuter.spip.net/u/jamesrezo

[JamesRezo] JamesRezo
Août 30

Bon, c’est mergé et reporté sur la branche 4.0. :white_check_mark:

Maintenant la documentation ^^

[b_b] b_b
Août 28

Pour moi c’est bon, attendons l’avis d’autres personnes :slight_smile:

[JamesRezo] JamesRezo
Août 28

Donc, on merge ?

[JamesRezo] JamesRezo
Août 27

La PR : #4868 - cs-autofixes - spip - SPIP on GIT https://git.spip.net/spip/spip/pulls/4868

les commits

Voir le sujet https://discuter.spip.net/t/coding-standards/155150/42 ou répondre à ce courriel pour répondre.

Vous recevez ce courriel car vous avez activé la liste de diffusion.

Pour se désabonner de ces courriels, cliquez ici
https://discuter.spip.net/email/unsubscribe/31cc9574f16e795590c7e8c8e9dbcb9d69c9911443c269a893ee56c511d30cd3.

#52

J’ai répondu dans le forum privé de l’article.

Sans doute. J’ai documenté là où les règles de codage étaient publiées depuis 6 ans. Je n’ai rien contre le changement.

En attendant, que ces règles soient sur spip.net ou sur un autre site, je pense que les pages de contrib pourraient être supprimées, histoire d’éviter toute confusion à l’avenir.

#53

Je ne suis pas sur que Programmer soit une meilleure place pour ces articles.
Il y a des articles sur le code et les contributions dans tous les sites…

Il me semble que pour l’instant on parle du code de SPIP « Core » et pas encore des plugins.
Enfin, tout ça pour dire que je ne suis pas sur que le positionnement de ces articles soit un problème majeur actuellement.

Par contre, c’est l’utilisation de ces outils qui me parait plus cryptique en l’état.
Personnellement j’utilise PHPStorm et sachant que PHPStan et PHPCode_Sniffer sont intégrables aux inspections ça serait pratique d’avoir un tuto pour les installer avec la bonne configuration. En plus, on est plusieurs dans l’équipe à l’utiliser.

Autre chose, PHPCSFixer que j’utilise a une configuration facile à définir dans un fichier réutilisable par tout le monde. Le mien va au-delà de PSR-je ne sais pas combien. Où a-t-on la liste exacte de la configuration pour comparer ? Par exemple, avec PHPStorm et PHPCSFixer je peux corriger les array(), les if else mal gaulés… C’est contenu dans les outils mis en place ?

#54

Le 02/09/2021 à 18:37, Eric Lupinacci via Discuter de SPIP a écrit :

Par exemple, avec PHPStorm et PHPCSFixer je peux corriger les array(), les if else mal gaulés… C’est contenu dans les outils mis en place ?

Oui, tout a été montré dans la PR qui a fait les modifs il me semble :

–
RastaPopoulos

#55

et puis, on en a causé dans ce topic en plus ! :laughing:

#56

OK, je suis un peu de loin.
Mais quand même, si je lis l’article SCS1, il y a une liste de recommandations.
Soit, mais cette liste n’est pas l’ensemble des règles applicables.
Donc, comment je fais pour connaitre la liste des règles applicables, il faut toujours se relire les PSR-x?