Consultation des exemples après installation NPM ou git

rubycon commented 11 months ago

Décrire le bug

L'installation du projet via NPM comme spécifiée dans la doc ne permet pas de visualiser les exemples. L'installation du projet via git n'est pas documentée (sauf dans la partie, plus technique, Contribution) et rend difficile la génération/consultation des exemples.

Les étapes pour reproduire le bug

Installation via NPM (ou Yarn) :

Créer un nouveau projet NPM (répertoire vide, npm init)
npm install @gouvfr/dsfr
cd node_modules/@gouvfr/dsfr/
npm run serve (❌ ERREUR: la dépendances browser-sync n'est pas installée)
npm install -D browser-sync
npm run serve 🎉

Installation via git clone :

git clone https://github.com/GouvernementFR/dsfr.git
cd dsfr
npm install (❌ ERREUR: conflit entre dépendances)
npm install --legacy-peer-deps (ignorer les conflits de dépendances)
npm run build (❌ ERREUR: fichier './.config/config.json' manquant)
npm run build -- --config ou npm run release (génère le fichier de configuration avant de constuire le projet)
npm run serve 🎉

Comportement attendu

Lors de l'installation du paquet via NPM ou git, il devrait être possible de visualiser les exemples simplement comme indiqué dans la documentation :

L'installation du Système de Design de l'État (ci-après, le DSFR) peut se faire de manières différentes. En téléchargeant l'ensemble des fichiers nécessaires à son utilisation, en utilisant le gestionnaire de paquets NPM, ou encore via git.

Configuration et système utilisé

Version du DSFR : 1.10.2 (NPM 10.2, Node 18.18) / HEAD main (git)
Système d’exploitation : Windows 10 et MacOs 11.6

Informations complémentaires

Dans le cas de l'installation NPM, le problème vient de la dépendance browser-sync qui n'est pas installée automatiquement. Voici deux solutions possibles :

Mettre browser-sync en dépendance régulière (dependencies) ou optionnelle (optionalDependencies) du projet, elle sera ainsi installée automatiquement.
Mettre browser-sync en dépendance paire (peerDependencies) et, dans la documentation, demander à l'utilisateur de l'installer manuellement.

Concernant l'installation via git clone, il faudrait documenter la procédure dans la partie Installation de la doc (comme celà est déjà fait ici CONTRIBUTING.md).

keryanS commented 3 months ago

Bonjour,

Merci pour le retour détaillé. Les points concernant la dépendance a browser-sync et la génération de la config au build ont été corrigé en v1.12 Nous privilégions yarn pour l'installation des dépendances, qui aura pour avantage de ne pas avoir à utiliser le paramètre --legacy-peer-deps de npm.

Keryan, Pour l'équipe du DSFR

rubycon commented 3 months ago

@keryanS Pour des raisons de sécurité, certaines administrations publiques (où le DSFR est utilisée) fournissent elles-même les postes de développement aux équipes. Ces postes sont extrêmement restreint et ne permettent pas d'utiliser autre chose que NPM. Le support de NPM serait apprécié.

GouvernementFR / dsfr