in English

Construire des outils

Apprenez à utiliser les scripts npm inclus dans Bootstrap pour créer notre documentation, compiler le code source, exécuter des tests, etc.

Configuration de l'outillage

Bootstrap utilise des scripts npm pour son système de construction. Notre package.json inclut des méthodes pratiques pour travailler avec le framework, y compris la compilation de code, l'exécution de tests, etc.

Pour utiliser notre système de construction et exécuter notre documentation localement, vous aurez besoin d'une copie des fichiers source de Bootstrap et de Node. Suivez ces étapes et vous devriez être prêt à basculer :

  1. Téléchargez et installez Node.js , que nous utilisons pour gérer nos dépendances.
  2. Téléchargez les sources de Bootstrap ou bifurquez le référentiel de Bootstrap .
  3. Accédez au /bootstraprépertoire racine et exécutez npm installpour installer nos dépendances locales répertoriées dans package.json .

Une fois terminé, vous pourrez exécuter les différentes commandes fournies à partir de la ligne de commande.

Utiliser des scripts npm

Notre package.json inclut les commandes et tâches suivantes :

Tâche La description
npm run dist npm run distcrée le /dist/répertoire avec les fichiers compilés. Utilise Sass , Autoprefixer et terser .
npm test Exécute les tests localement après l'exécutionnpm run dist
npm run docs-serve Construit et exécute la documentation localement.

Exécutez npm runpour voir tous les scripts npm.

Commencez avec Bootstrap via npm avec notre projet de démarrage ! Dirigez-vous vers le référentiel de modèles twbs/bootstrap-npm-starter pour voir comment créer et personnaliser Bootstrap dans votre propre projet npm. Inclut le compilateur Sass, le préfixe automatique, Stylelint, PurgeCSS et les icônes Bootstrap.

Toupet

Bootstrap v4 utilise Node Sass pour compiler nos fichiers source Sass en fichiers CSS (inclus dans notre processus de construction). Afin de vous retrouver avec le même CSS généré lors de la compilation de Sass à l'aide de votre propre pipeline d'actifs, vous devrez utiliser un compilateur Sass qui prend en charge au moins les fonctionnalités de Node Sass. Ceci est important à noter car depuis le 26 octobre 2020, LibSass et les packages construits dessus, y compris Node Sass, sont obsolètes .

Si vous avez besoin de nouvelles fonctionnalités Sass ou d'une compatibilité avec les nouvelles normes CSS, Dart Sass est désormais la principale implémentation de Sass et prend en charge une API JavaScript entièrement compatible avec Node Sass (à quelques exceptions près, répertoriées sur la page GitHub de Dart Sass ).

Nous augmentons la précision d'arrondi Sass à 6 (par défaut, c'est 5 dans Node Sass) pour éviter les problèmes d'arrondi du navigateur. Si vous utilisez Dart Sass, vous n'aurez pas besoin de l'ajuster, car ce compilateur utilise une précision d'arrondi de 10 et, pour des raisons d'efficacité, ne permet pas de l'ajuster.

Préfixe automatique

Bootstrap utilise Autoprefixer (inclus dans notre processus de construction) pour ajouter automatiquement des préfixes de fournisseur à certaines propriétés CSS au moment de la construction. Cela nous fait gagner du temps et du code en nous permettant d'écrire des parties clés de notre CSS une seule fois tout en éliminant le besoin de mixins de fournisseurs comme ceux trouvés dans la v3.

Nous maintenons la liste des navigateurs pris en charge via Autoprefixer dans un fichier séparé au sein de notre référentiel GitHub. Voir .browserslistrc pour plus de détails.

Documentation locale

L'exécution de notre documentation localement nécessite l'utilisation de Hugo, qui est installé via le package npm hugo-bin . Hugo est un générateur de site statique extrêmement rapide et assez extensible qui nous fournit : des inclusions de base, des fichiers basés sur Markdown, des modèles, etc. Voici comment démarrer :

  1. Parcourez la configuration des outils ci-dessus pour installer toutes les dépendances.
  2. Depuis le répertoire racine /bootstrap, exécutez npm run docs-servela ligne de commande.
  3. Ouvrez http://localhost:9001/dans votre navigateur, et voilà.

Apprenez-en plus sur l'utilisation d'Hugo en lisant sa documentation .

Dépannage

Si vous rencontrez des problèmes lors de l'installation des dépendances, désinstallez toutes les versions de dépendance précédentes (globales et locales). Ensuite, relancez npm install.