Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

africa

1.5.0 • Public • Published

africa

npm version Build status Pipeline Badge

Africa

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.

yarn add africa

Table Of Contents

API

The package is available by importing its default function:

import africa from 'africa'

async africa(
  packageName: string,
  questions=: !_reloquent.Questions,
  config=: !Config,
): !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'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. -
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)
  }
})()
user: [zavr]
{ name: 'zavr' }

Groups

It's possible to ask questions in groups, such that answers will be received in a nested object. Only 1 level of nesting is supported at the moment. To group questions, import the Group type and pass questions to it.

import africa, { Group } from 'africa'
 
africa('test', {
  group: new Group({
    test: {
      text: 'hello',
    },
  }),
  nongroup: {
    text: 'your-name',
  },
}, { force: true, homedir: __dirname })
your-name: [name-doc] name-doc
hello: [world-doc] world-doc
{
  "nongroup": "name-doc",
  "group": {
    "test": "world-doc"
  }
}

Copyright & License

Photo Diana Robinson, 2017

GNU Affero General Public License v3.0

Art Deco © Art Deco™ 2020 AGPL-3.0

Install

npm i africa

DownloadsWeekly Downloads

3

Version

1.5.0

License

AGPL-3.0

Unpacked Size

126 kB

Total Files

23

Last publish

Collaborators

  • avatar