Feat/improve max characters

[TheoLechemia]

Limite le nombre de caractère uniquement sur les champs spécifiés en configuration.
Le contrôle reste informatif et non bloquant (contrôle effectué côté front)
Voir GeotrekCE/Geotrek-admin#3844
Le paramètre de configuration a ce format :

MAPENTITY_CONFIG['MAX_CHARACTERS'] = {
    "tourism_touristicevent": [{'field': 'description_teaser_fr', 'value': 5}]
}

Je pensais mettre uniquement le nom du modèle en config (touristicevent par exemple, mais celui-ci n'est pas forcément unique)
Question : est-ce qu'on maintient une rétrocompatibilité sur l'ancien format de config ?MAPENTITY_CONFIG['MAX_CHARACTERS'] = <INT> ? En l'état, si les gens ne change pas leur config, ça fait planter l'app ..

[camillemonchicourt]

OK, merci pour cette PR liée à GeotrekCE/Geotrek-admin#3844.

Pour la rétrocompatibilité, je ne sais pas trop.
Comme déjà mentionné, comme le paramètre MAX_CHARACTERS actuel s'applique à tous les champs texte de tous les modules, je pense qu'il est peut utilisable en l'état. Et donc certainement peu utilisé.
Mais il doit au moins l'être par le CD66 qui avait commandé ce développement ?

On peut peut-être faire un breaking change et bien l'indiquer dans le changelog de Geotrek-admin pour que ceux qui utilisent ce paramètre global, le modifient pour spécifier les champs dont ils souhaitent limiter le nombre de caractères.

[camillemonchicourt]

Limites :

• Il faut spécifier le nombre de caractère pour chaque mangue de chaque champs
• Le plugin utilisé (https://www.tiny.cloud/docs/plugins/opensource/wordcount/) affiche par défaut le nombre de mots saisis. Il faut cliquer dessus pour passer en nombre de caractères. Il n'est pas possible de paramétrer le plugin pour qu'il affiche par défaut le nombre de caractères... Cela n'est pas très visible ni intuitif et dans notre cas c'est le nombre de caractères qu'on veut compter et limiter et pas le nombre de mots. Donc pour contourner cela et afficher le nombre de caractères par défaut, on simule un clique sur le nombre de mots lors du chargement des formulaires pour basculer sur le nombre de caractères. Pas idéal.
• On aurait préféré afficher clairement XXX caractères saisis / XXX caractères recommandés mais il aurait fallu faire du JS spécifique. Ces 2 infos sont donc distincts et à 2 endroits différents (le nombre de caractères saisis au niveau du plugin, le nombre de caractères recommandés sous le champs avec le texte d'aide)

[marcantoinedupre]

Pour résoudre les 2 points concernant l'UI : peut-être est-il possible d'interroger le composant TinyMCE pour récupérer le nombre courant de caractères et l'afficher en-dessous du champ avec le format : nb_courant / nb_max. (et on oublie le clic simulé)

Une méthode pour récupérer le nombre de caractères est documentée : https://www.tiny.cloud/docs/plugins/opensource/wordcount/#api

Par contre il faudrait pouvoir réagir sur un event émis par le champ TinyMCE. Je ne sais pas si TinyMCE propose une interface pour l'observabilité.

[TheoLechemia]

Oui je m'étais poser la question de faire comme ça necessite de :

• manipuler du DOM pour ajouter manuellement du texte (element.innerText etc...)
• masquer le bloc existant "X CHARACTERES / X Mots"
  Je m'étais dis que ça faisait un peu beaucoup de hack pour une fonctionnalité comme ça...
  Mais si vous préférer cette solution je peut faire ça

ps : qu'est ce qu'on fait pour les input qui n'on pas de limite défini en conf ?
On masque le décompte natif pour ne pas avoir d'hétérogénéité ? On affiche juste le décompte sans limite ?

[marcantoinedupre]

Pas d'opinion tranchée de mon côté. Juste je me dis que la remarque de Camille sur rassembler l'info visuellement est pertinente.

masquer le bloc existant "X CHARACTERES / X Mots"

Je me disais qu'on pouvait le laisser. Il indiquera le nombre de mots et puis voilà.

[camillemonchicourt]

Si ce n'est pas un soucis d'ajouter un peu de code maison, alors autant faire un truc un peu plus clair et lisible.
XX caractères saisis / X caractères recommandés

PS : Le wordcount de base de CKeditor (https://ckeditor.com/docs/ckeditor5/latest/features/word-count.html) est bien plus sympa et clair que celui de TinyMCE :

[TheoLechemia]

J'ai enlever le click programmatique et rajouter la limite. (5/6 characters)
NB: elle s'ajoute uniquement à l'évenement de WordCountUpdate (donc quand l'utilisateur commence à taper). Elle n'est donc pas présente avant que l'utilisateur n'ai commencé à taper
Le mot "characters" est rajouté en dur et n'est pas traduit

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.00%. Comparing base (126e279) to head (77d0e84).

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #282      +/-   ##
==========================================
+ Coverage   89.95%   90.00%   +0.04%     
==========================================
  Files          32       32              
  Lines        2390     2401      +11     
==========================================
+ Hits         2150     2161      +11     
  Misses        240      240              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[TheoLechemia]

Dernière update :

• le paramètre MAX_CHARACTER initial (qui change la longueur max de tous les champs "textarea") est conservé et marqué comme déprécié
• le nouveau paramètre pour changer la longueur maximale d'un seul champ est nommé MAX_CHARACTERS_BY_FIELD

Ready to review !