v1.0.1

Un utilitaire CLI pour compiler plusieurs fichiers SCSS en un seul fichier CSS pour éviter de lier un million de fichiers CSS au sein d’un projet. Compile SCSS utilise Click pour construire son interface CLI.

Installation

pip install compile_scss

Utilisation

Exécuter compile_scss

Si compile_scss est exécuté sans aucune option ou drapeau, Compile SCSS cherchera dans le répertoire racine du projet un fichier nommé compile_scss_config.json, qui stocke un objet JSON avec les valeurs de configuration prédéfinies de l’utilisateur.

Si un fichier de configuration est trouvé Compile SCSS s’exécutera en utilisant la configuration trouvée dans le fichier JSON. Si aucun fichier de configuration n’est trouvé, un Read, Evaluate, Print, Loop (R.E.P.L.) sera déclenché et l’utilisateur aura la possibilité de définir de nouvelles valeurs de configuration avec une série d’invites.

Options

--root <PROJECT_ROOT_DIRECTORY>

L’option --root permet à l’utilisateur de spécifier le répertoire racine de son projet. Compile SCSS recherchera dans ce répertoire le fichier compile_scss_config.json. >

Le chemin par défaut du répertoire racine est ./, ce qui se traduit par n’importe quel répertoire à partir duquel compile_scss est appelé.

--set-config

Si le drapeau --set-config est présent, la configuration R.E.P.L. sera déclenchée par défaut.

Si un fichier de configuration a été trouvé, l’utilisateur aura la possibilité de créer un nouveau fichier de configuration ou de continuer avec les valeurs trouvées dans le fichier de configuration.

Si aucun fichier de configuration n’a été trouvé, l’utilisateur aura l’option de créer un nouveau fichier de configuration.

--watch

Si le drapeau --watch est présent, Compile SCSS observera le répertoire SCSS spécifié dans le fichier de configuration pour toute modification et mettra à jour le fichier CSS en conséquence.

Configuration

Par défaut, Compile SCSS cherchera dans le répertoire racine du projet un fichier nommé compile_scss_config.json. Le fichier doit être présent et contenir un objet de configuration valide pour que Compile SCSS puisse s’exécuter.

Le fichier de configuration doit contenir cinq clés et les valeurs correspondantes :

• root – Le répertoire racine du projet. La valeur par défaut est ./

• scss_dir – Le répertoire SCSS de premier niveau du projet. Ce répertoire peut contenir des sous-répertoires et autant de fichiers SCSS que nécessaire. Le chemin scss_dir doit mener à un répertoire contenant au moins un fichier SCSS afin d’être un chemin SCSS valide.

• css_dir – Le répertoire CSS contenant le fichier CSS principal. C’est là que Compile SCSS générera son fichier de sortie CSS.

• css_filename – Le nom souhaité du fichier CSS cible.

  Le nom de fichier ne doit pas contenir de caractères spéciaux autres que des traits d’union ou des traits de soulignement non en tête/en queue. L’extension du fichier doit être en minuscules, mais le nom de fichier peut contenir des majuscules.

  Voir les exemples ci-dessous pour les noms de fichiers valides et invalides.

• output_style – Libsass’ sass.compile() permet à la sortie CSS d’être compilée dans l’un des quatre styles suivants :

  • compact

  • compressé

  • expansé

  • intégré

.

Noms de fichiers CSS valides et invalides

Valides

Invalides

Exemple de fichier de configuration

{ "root": ".", "scss_dir": "./static/scss", "css_dir": "./static/css", "css_filename": "index.css", "output_style": "expanded"}

Compiler SCSS est encore en développement. Il a été testé avec succès mais pas de manière extensive avec :

• Variables
• @import statements
• Functions (basic)
• Mixins (basic)

.