Loads JSON object from environment string or local file
Requires Node version 6 or above.
npm install --save @cypress/env-or-json-file
If you have configuration file locally
foo.json with all your settings,
load it directly
const configFromEnvOrJsonFile =const config =if config// ok, loaded somehowelseconsole
But when you move to CI, just grab the file's contents and put it as
foo_json (environment variables often have restrictions
on characters, so replace all
/.- characters in the path with
cat foo.json | pbcopy
Paste the contents into CI variable
foo_json and it should load the config
on CI without checking in a sensitive file.
To see verbose log message from this module, run with
DEBUG=env-or-json-file ... environment variable.
Given a filename with path, function
filenameToShellVariable converts it to
environment key name, normalizing slashes and dots.
const filenameToShellVariable =// foo_bar__me_json
- To prevent committing sensitive files use ban-sensitive-files
- Make sure CI does NOT leak environment variables to forks, like CircleCI does
License: MIT - do anything with the code, but don't blame us if it does not work.
Support: if you find any problems with this module, email / tweet / open issue on Github
Copyright (c) 2017 Cypress.io
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.