This parameter is used to contain the caller location of imperative configuration file.
Current command needed for processing
The config object
This is the daemon context needed to pass to yargs.fail()
in the event that we cannot extract
context through a yargs.parse()
call.
This is the package name of the host application. It will only be set once accessed to lessen loads to the host package.json.
This is the name of our imperative package. It will only be set once accessed to lessen loads to the imperative package.json.
It isn't hardcoded so that the name of our package can change without affecting modules dependent on it.
This parameter is used as the container of all loaded configuration for Imperative.
This is our calling CLI's command name (taken from package.json: bin).
This is the variable that stores the specific instance of Imperative Config. Defined as static so that it can be accessed from anywhere.
Return file location of imperative configuration file.
Set the caller location.
new location to be updated with
Return package.json of the imperative user
Return the cli Home path.
path to cli Home.
Retrieve the command line.
Set the command line (needed for daemon where command changes and is not static)
Set context for daemon to retrieve if no handler is called.
Context for daemon when no handler is invoked.
Get the configured environmental variable prefix for the user's CLI
Retrieve the host package name from which imperative was called.
Retrieve the package name of the imperative application.
Retrieve the loaded config (if init has
Set the loaded config data.
to be set.
Return profile Directory.
profile directory.
a key/value object where the key is the profile type and the value is the profile type schema
Get our root command name.
The name of our calling CLI's command.
Set our root command name.
The name of our calling CLI's command.
The name of our calling CLI's command.
Gets a single instance of the ImperativeConfig. On the first call of ImperativeConfig.instance, a new ImperativeConfig object is initialized and returned. Every subsequent call will use the one that was first created.
The newly initialized ImperativeConfig object.
Parses the package.json file and searches for the symlink name used under "bin".
Require a file from a project using imperative accounting for imperative being contained separately from the current implementers directory.
the file to require from project using imperative
Generated using TypeDoc
This class is used to contain all configuration being set by Imperative. It is a singleton and should be accessed via ImperativeConfig.instance.