Plugins: userConfig

userConfig plugin

These are the addons to work with the global user configuration file $HOME/.piscosour/piscosour.json.

1. userConfigRead() addon
2. userConfigWrite() addon
3. userConfigGet() addon
4. userConfigSet() addon

1. userConfigRead() addon

this.userConfigRead() returns an object containing the global user configuration file ($HOME/.piscosour/piscosour.json), or an empty object if the file is not found.

It has no parameters.

Example:

run: function(resolve, reject) {
  this.logger.info('json user config', this.userConfigRead());
  return true;
}

It will display the content of $HOME/.piscosour/piscosour.json.

2. userConfigWrite() addon

this.userConfigWrite(userConfig) serializes the userConfig as a JSON object, writes it to the global user configuration file ($HOME/.piscosour/piscosour.json), and returns the content of the file.

If the file $HOME/.piscosour/piscosour.json does not exists, then it is created.

Example:

run: function(resolve, reject) {
  let config = this.userConfigWrite({
    'param1': 'value1',
    'param2': 'value2',
    'param3': 'value3',
    'param4': 'value4'
  });
  this.logger.info('json user config', config);
  return true;
}

Then the content of $HOME/.piscosour/piscosour.json is:

{
  "param1": "value1",
  "param2": "value2",
  "param3": "value3",
  "param4": "value4"
}

Beware, this will replace the current content of $HOME/.piscosour/piscosour.json file.

3. userConfigGet() addon

this.userConfigGet(key) returns the value associated with the key in the global user configuration file ($HOME/.piscosour/piscosour.json), or null if not found.

Example:

run: function(resolve, reject) {
  this.logger.info('param1 user config', this.userConfigGet('param1');
  return true;
}

If $HOME/.piscosour/piscosour.json has the following content:

$ cat ~/.piscosour/piscosour.json
{
  "param1": "value1",
  "param2": "value2",
  "param3": "value3",
  "param4": "value4",
}

Then this.userConfigGet('param1') will return value1.

4. userConfigSet() addon

this.userConfigSet(key, value) maps the value to the key in the global user configuration and writes it to the file ($HOME/.piscosour/piscosour.json). Returns the user config object.

Example:

run: function(resolve, reject) {
  this.userConfigSet('param1': 'foo');
  return true;
}

Then $HOME/.piscosour/piscosour.json has the following content:

$ cat ~/.piscosour/piscosour.json | grep "param1"
  "param1": "foo",