Créer un fichier de configuration Javascript

Il est souvent utile de centraliser tous le paramétrage de votre application javascript dans un seul et même ficher et d’avoir accès à ces propriétés n’importe où ensuite.
Par exemple, on peut y mettre les informations de connexion à la base de données, le numéro de version, etc…

Et surtout, ça évite d’avoir des variables un peut partout dans le code qu’il faut rechercher à chaque fois quand on veut modifier un petit paramétrage.

Vous ne voyez pas l’intérêt sur votre projet de 300 lignes? Et bien attendez de vous retrouver avec un projet de 10.000 lignes et vous en verrez vite l’intérêt 😉

Création du fichier de configuration

Dans un premier temps on va créer ce fichier de configuration.
pour ma part je vais l’appeler “config.js” et le placer dans un répertoire “/js” sur mon projet.

A l’intérieur on va créer un objet “globalConfig” composé des différentes variables que vous souhaitez paramétrer :

var globalConfig = {
  bddHost: 'http:\\localhost',
  bddUser: 'admin',
  bddPassword: 'admin',
  enabled: true,
  version: 2
};

On peut ainsi y insérer des variables de tout type, des tableaux, etc… avec la syntaxe : <key>: <value>

Utilisation

Pour que ce fichier soit prit en compte il faut maintenant l’inclure dans votre fichier “index.html” :

<!doctype html>
<head>
<script src="js/config.js"></script>
...

Puis, dans tous vos fichiers js il vous suffira d’effectuer un appel à l’objet “globalConfig” pour récupérer ses informations :

...
  if (globalConfig.enabled) {
      var host = globalConfig.bddHost;
      var user = globalConfig.bddUser;
      var password = globalConfig.bddPassword;
  }
  ...

C’est tout simple, mais c’est “le” petit truc qui organise bien vos paramètres d’application et votre code et qu’on oublie toujours !

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Prouve moi que tu es bien humain ->