@phinxlab/config-public

Config definition

Configuration file

The file configuration will be looked at the CWD (Command working directory) or into it parents directory. It will look for the file name environment.json and it will have the following format:

environment.json

type Enviroment={
    config:string,
    mode:'file'|'proxy',
    proxy?:string,
    cwd?:string,
    path?:string,
    bbd?:string
}

Attributes specification

• config Will define the folder inside de config folder where the configuration files will be defined. Traditional configurations are:

  • dev => Development environment
  • qa => Quality Assurance environment
  • prod => Production environment

• mode Will determine the mode that the configuration will work. Posible options are:

  • file => The platform will automatically look for the files at the defined folder. See config.
  • proxy => It will look for a javascript file that will manage the loding of configuration. See proxy

• path This will define the default path to he configuration enviroments. By default it will be targeted to CWD()../config. So be aware that if you change the CWD() you will also need to specified this parameters in order to make the platform work.

• proxy This attribute is mandatory when you specified the 'proxy' mode. It will aim to the .js file that will be in charge of loading the configuration. The platform will look for the corresponding file inside the enviroment specified on config. See config. The file will have to exports a function with the signature:

(path:string,config:string)=>any

Since it will be a javascript file it should be defined like this:


function proxyLoader(path,config) {
    const configObject = require(config);
    //Mofify whatever you need on your base config
    //configObject.password = env.password
    return configObject;
}
module.exports = proxyLoader;

• cwd In case that you decided to run the application from a different directory where the initiation is, you will need to specified the correct directories where the platform will have to search for files.

• bbd This is the directory where the base code is located. In case that you changed the cwd, you will need to specified in order to find the base code.

Glossary

• cwd Command Working Directory

• bbd Build Base Directory