{"id":16773822,"url":"https://github.com/ziflex/env-manager","last_synced_at":"2025-03-16T17:21:28.832Z","repository":{"id":57225873,"uuid":"45801133","full_name":"ziflex/env-manager","owner":"ziflex","description":"Environment manager for build tasks","archived":false,"fork":false,"pushed_at":"2019-04-15T19:57:17.000Z","size":86,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T04:14:43.498Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ziflex.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-11-08T22:02:10.000Z","updated_at":"2020-08-10T15:26:38.000Z","dependencies_parsed_at":"2022-08-24T11:00:33.050Z","dependency_job_id":null,"html_url":"https://github.com/ziflex/env-manager","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziflex%2Fenv-manager","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziflex%2Fenv-manager/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziflex%2Fenv-manager/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ziflex%2Fenv-manager/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ziflex","download_url":"https://codeload.github.com/ziflex/env-manager/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243903166,"owners_count":20366434,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-13T06:47:07.922Z","updated_at":"2025-03-16T17:21:28.809Z","avatar_url":"https://github.com/ziflex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Environment manager\n\nEnvironment manager for build tasks.\n\n[![npm version](https://badge.fury.io/js/env-manager.svg)](https://www.npmjs.com/package/env-manager)\n[![Build Status](https://secure.travis-ci.org/ziflex/env-manager.svg?branch=master)](http://travis-ci.org/ziflex/env-manager)  \n\n```env-manager``` matches a file with environment variables based on passed arguments.\n\n\n## Install\n\n```sh\n\n    $ npm install --save-dev env-manager\n\n```\n\n## Usage\n\n### Basic\n\nFor example, we have these files with environment variables. (```.js``` files also can be used)\n\n```sh\n\n    root\n      environment.dev.json  \n      environment.test.json  \n      environment.prod.json  \n\n```\n\n```javascript\n\n    var env = require('env-manager')({\n        argv: process.argv\n    });\n\n```\nRunning this command.\n\n```sh\n\n    npm run build -- --env dev\n\n```\n\nWill return a content from ```environment.dev.json```.\n\n### Merge\n\nIn order to avoid boilerplate code we can define base `environment.json` with default values\nand override them with values from matched file:\n\n```sh\n\n    root\n      environment.json\n      environment.dev.json  \n      environment.test.json  \n      environment.prod.json  \n\n```\n\n```javascript\n\n    var env = require('env-manager')({\n        argv: process.argv,\n        base: 'environment.json'\n    });\n\n```\n\n```sh\n\n    npm run build -- --env dev\n\n```\n\nWill return a content from ```environment.json``` merged with ```environment.dev.json```.\n\n#### Config override\n\nAlternatevley, you can override config values by passing new values via CLI arguments.\n\n```json\n{\n  \"name\": \"config\",\n  \"version\": \"1.0.0\",\n  \"server\": {\n      \"endpoint\": \"/api\",\n      \"port\": 9090\n  }\n}\n```\n\n```sh\n\n    npm run build -- --version 1.1.0-alpha.1 --server.port 9091\n\n```\n\n### Custom pattern and directory\n\nIt's possible to define a custom match pattern and custom target directory.\nBoth of these options are independent.\n\n```sh\n\n    root\n      environments\n        linux\n          dev.json\n          prod.json\n        windows\n          dev.json\n          prod.json\n\n```\n\n```javascript\n\n    var path = require('path');\n    var env = require('env-manager')({\n        argv: process.argv,\n        pattern: '{platform}/{env}.json',\n        dir: path.join(__dirname, 'environments')\n    });\n\n```\n\n```sh\n\n    npm run build -- --env dev --platform linux\n\n```\n\nWill return a content from ```environments/linux/dev.json```.\n\n## API\n\n#### manager(options)   \n\n#### options.argv\nType: `Array\u003cstring\u003e`.  \nProcess arguments.  \nRequired.  \n\n#### options.dir\nType: `string`.  \nFiles lookup folder.    \nOptional.  \nDefault ```__dirname```.\n\n\n#### options.base\nType: `string`.  \nBase file with environment variables.  \nIf defined, base file will be extended with matched file.  \nOptional.  \n\n#### options.pattern\nType: `string`.  \nFile matching pattern based on arguments.  \nOptional.  \nDefault ```environment.{env}.json```.    \n\n#### options.defaults  \nType: `object`.  \nDefault arguments.  \nOptional.  \n\n## License\nThe MIT License (MIT)    \nCopyright (C) 2015 Tim Voronov\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fziflex%2Fenv-manager","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fziflex%2Fenv-manager","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fziflex%2Fenv-manager/lists"}