`africa` is a _Node.JS_ package which simplifies reading from and writing to persistent configuration files in user's home directory. If a configuration exists, it will be read, and if not, the user will be presented with questions, after which the answers will be stored in the `.rc` file.
```sh
yarn add africa
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`async africa(packageName, questions=, config=): !Object`](#async-africapackagename-stringquestions-_reloquentquestionsconfig-config-object)
* [`Config`](#type-config)
- [Groups](#groups)
- [Copyright & License](#copyright--license)
async africa(): !Object
Read package configuration from the home directory, or ask questions with
readline interface to create a new configuration in `~/.${packageName}rc`.
- packageName* `string`: The name of the package.
- questions `!_reloquent.Questions` (optional): An object with questions to ask when config wasn't found.
- config !Config (optional): Configuration object.
Call `africa` asynchronously to read or create a new configuration. Questions should adhere to the [`reloquent`][2]'s interface.
__`Config`__: The configuration object to configure additional functionality.
| Name | Type | Description | Default |
| ---------------- | ---------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| force | boolean | Ask questions and update the configuration file even if it already exists. | `false` |
| homedir | string | In which directory to save and search for configuration file. | `os.homedir()` |
| questionsTimeout | number | How log to wait in ms before timing out. Will wait forever by default. | - |
| local | boolean | Whether to read a local config file in the current working directory rather than in the `HOMEDIR`. When initialising, the default values will be taken from the home config if it exists so that it is easy to extend `.rc` files. | `false` |
| recursive | boolean | **`paid`** Read all configurations up to the root one from the home directory, and merge them together. | `false` |
| skipExisting | boolean | **`paid`** When creating nested configs, skip writing values that are taken from parent RCs. | `true` |
| rcNameFunction | (packageName: string) => string | Function used to generate the `.rc` name. Default: packageName => `.${packageName}rc`. | - |
```js
import africa from 'africa'
import { userInfo } from 'os'
(async () => {
try {
const config = await africa('africa', {
name: {
defaultValue: userInfo().username,
text: 'user',
},
}, { force: true })
console.log(config)
} catch ({ stack }) {
console.log(stack)
}
})()
```
```sh
user: [zavr]
{ name: 'zavr' }
```
|
© Art Deco™ 2020 |  |
|---|
