Modifier / Ajouter / Supprimer un fichier JavaScript

1. Nomenclature des fichiers

Nomenclature des fichiers des librairies internes et externes

Les librairies JavaScript sont situées dans le dossier /libs/. Le nom des fichiers des librairies externes portent simplement leur nom. Nous ne modifions pas le nom du fichier d’une librairie externe. Les fichiers des librairies internes, développées par l’agence Thuria sont préfixées par « th_ ».

Voici un exemple ci-dessous dans le cas où vous souhaitez ajouter un nouveau script externe.

NB : les mots en gras correspondent à des noms de dossiers et le reste à des noms de fichiers CSS.

• /assets/ –> /js/ –> /libs/ :
  • /nom_du_fichier.js

Nomenclature des fichiers sources

Les fichiers JS destinés pour la fabrique à sites se situent dans le dossier /src/. Ce dossier comporte plusieurs sous-dossiers dans le but de le segmenter permettant d’avoir plus de visibilité sur certaines parties du site.

Si un fichier concerne les blocs, il sera intégré dans le sous-dossier /blocs/ et chaque fichier sera préfixé de « bloc- » suivi du nom du bloc.

Si un fichier concerne le header du site, il sera intégré dans le sous-dossier /header/ et chaque fichier sera préfixé de « header- » suivi de l’élément dans le header sur lequel il agit.

Si un fichier concerne un modèle de page (hors SIT), il sera intégré dans le sous-dossier /modeles/ et chaque fichier portera le nom du modèle.

Si un fichier concerne un modèle de page SIT, il sera intégré dans le sous-dossier /sit/ et chaque fichier sera préfixé de « page- » (et du mot « listing » s’il s’agit d’un listing SIT)  suivi du nom du modèle de page sur lequel il agit.

Voici un exemple ci-dessous dans le cas où vous souhaitez ajouter un nouveau script concernant une strate optionnelle du site.

• /assets/ –> /js/ –> /src/ –> /strates/ :
  • /nom_du_fichier.js

 

2. Surcharger un fichier JavaScript

Nomenclature d’un fichier pour un besoin de surcharge

Votre besoin est de surcharger un script existant sans pour autant le remplacer. Incluez un nouveau fichier JavaScript dans votre thème en respectant le même chemin de dossiers et sous-dossiers afin de garder une bonne lisibilité dans le projet.

Nommez-le de la même façon que sur la fabrique à sites, simplement en lui ajoutant un suffixe « -custom ». Le fichier sera compilé automatiquement dès qu’il sera modifié.

• /assets/ –> /js/ –> /src/ –> /header/  :
  • _header-menu-custom.js

 

3. Modifier / Remplacer un fichier JavaScript

Nomenclature d’un fichier pour un besoin de remplacement

Votre besoin est de modifier en conséquence un fichier de la fabrique à sites. Dans ce cas, reprenez la même arborescence de dossiers et sous-dossiers ainsi que le même nom de fichier. À ce moment, votre fichier remplacera le fichier par défaut et sera compilé automatiquement dès que vous le modifierez.

• /assets/ –> /js/ –> /src/ –> /header/ :
  • _header-menu.js

 

4. Supprimer un fichier JavaScript

Votre besoin est de supprimer un script sur votre thème. Dans ce cas, reprenez la même arborescence de dossiers et sous-dossiers ainsi que le même nom de fichier. À ce moment, votre fichier remplacera le fichier par défaut et sera compilé automatiquement dès que vous le modifierez. Pour le supprimer, vous aurez simplement à le laisser vide dans votre thème.

Attention tout de même lors de la suppression d’un script, ceci peut avoir des conséquences sur votre thème.

• /assets/ –> /js/ –> /src/ –> /header/ :
  • _header-menu.js