De JSON aux variables d'environnement : présentation de json-to-env-converter

Bonjour ! Ceci est mon tout premier article (alors allez-y doucement dans les commentaires ?). Je suis ravi de partager un petit projet sur lequel je travaille et qui est né d’un besoin personnel. Si vous avez déjà eu du mal à gérer les configurations dans votre application Node.js, ce petit package sans dépendance pourrait vous intéresser. Cela s'appelle json-to-env-converter.

Qu'est-ce que json-to-env-converter ?

json-to-env-converter est un package npm qui convertit les objets JSON en variables d'environnement. Il s'agit d'un outil léger conçu pour vous aider à gérer les configurations basées sur JSON en les convertissant en variables d'environnement et en les injectant dans process.env ; il est destiné aux scénarios dans lesquels les configurations peuvent être dynamiques, imbriquées ou provenir d'API ou de systèmes externes.

Voici l'idée : au lieu de définir manuellement des variables d'environnement pour des configurations complexes ou dynamiques, vous pouvez les charger par programme à partir d'un objet JSON et y accéder comme n'importe quelle autre variable d'environnement.

Pourquoi l'ai-je construit ?

J'ai récemment construit une API secrète et pour chaque projet sur lequel je travaille personnellement ; J'appelle mon API secrets pour obtenir ma configuration au moment de l'exécution qui est fournie au format json. Sans oublier que dans les applications modernes et volumineuses, la configuration peut changer en fonction de l'emplacement de l'utilisateur ou d'autres facteurs dynamiques. Bien que les fichiers .env soient parfaits pour les configurations statiques, ils ne gèrent pas facilement :

• Structures imbriquées : aplatir du JSON imbriqué dans des variables d'environnement peut devenir fastidieux.
• Sources dynamiques : charger des configurations au moment de l'exécution sans redémarrer l'application n'est pas simple.

J'ai construit json-to-env-converter pour explorer un moyen de résoudre ces problèmes. Encore une fois, il s'agissait davantage d'un projet pour un usage personnel et il n'est certainement pas destiné à remplacer des outils comme dotenv, mais plutôt à gérer un cas d'utilisation légèrement différent. ; et j'ai pensé quel est le mal à le rendre open source et à le publier publiquement sur npm et je serais si heureux si quelqu'un en trouvait l'utilité.

Comment ça marche

Installez le package depuis npm :

npm i json-to-env-converter

Voici un exemple simple pour montrer ce qu'il fait :

Exemple de base

import { jsonToEnv } from 'json-to-env-converter';

const config = {
  database: {
    host: 'localhost',
    port: 5432,
  },
};

jsonToEnv(config);

console.log(process.env.DATABASE_HOST); //Output: 'localhost'
console.log(process.env.DATABASE_PORT); //Output: '5432'

Cela prend un objet JSON et le convertit en variables d'environnement. Il aplatit également les clés imbriquées, donc database.host devient DATABASE_HOST.

Ajout d'un préfixe

Pour éviter les collisions, vous pouvez ajouter un préfixe :

jsonToEnv(config, { prefix: 'MYAPP_' });

console.log(process.env.MYAPP_DATABASE_HOST); //Output: 'localhost'

Un cas d'utilisation : configurations dynamiques

Un cas d'utilisation potentiel de ce package est la gestion des configurations dynamiques. Par exemple, imaginez que vous disposez d’une application globale qui récupère les paramètres spécifiques à une région au moment de l’exécution. Au lieu de gérer manuellement les fichiers .env pour chaque région, vous pouvez charger dynamiquement les bons paramètres en fonction de l'emplacement de l'utilisateur :

npm i json-to-env-converter

Cela permet à votre application d'adapter sa configuration sans nécessiter de redémarrage ni de valeurs codées en dur.

Devriez-vous l'utiliser ?

Honnêtement, je suis encore en train de décider dans quelle mesure ce package pourrait être utile. Si vous êtes déjà à l'aise avec les fichiers .env et les configurations statiques, vous n'aurez peut-être pas besoin de cet outil. Mais si vous travaillez avec :

• Environnements dynamiques où les configurations changent au moment de l'exécution
• Objets JSON imbriqués qui doivent être convertis en variables d'environnement plates
• Configurations de configuration programmatique provenant d'API ou de services externes

et vous n'êtes pas satisfait de votre configuration actuelle, alors json-to-env-converter pourrait vous faire gagner du temps et vaut la peine d'essayer.

Installation et commentaires

Si vous êtes curieux de l'essayer, vous pouvez l'installer depuis npm :

import { jsonToEnv } from 'json-to-env-converter';

const config = {
  database: {
    host: 'localhost',
    port: 5432,
  },
};

jsonToEnv(config);

console.log(process.env.DATABASE_HOST); //Output: 'localhost'
console.log(process.env.DATABASE_PORT); //Output: '5432'

J'aimerais entendre vos réflexions, vos commentaires ou, surtout, vos suggestions d'amélioration, alors n'hésitez pas à les mentionner dans les commentaires ici ou à soumettre des demandes de tirage sur mon dépôt github https://github.com/neenus/json-to -env. C’est une expérience d’apprentissage pour moi et j’ai hâte de voir où cela mène.

Oh et encore une chose... merci d'avoir lu mon premier article !

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!