Miss any of our Open RFC calls?Watch the recordings here! »

answer-store

0.4.0 • Public • Published

answer-store NPM version Build Status

Store answers to user prompts, based on locale and/or current working directory.

TOC

(TOC generated by verb using markdown-toc)

Install

Install with npm:

$ npm i answer-store --save

Usage

var answer = require('answer-store');

What does this do?

With project generators and build systems it's fairly common to prompt the user for information that is needed to complete the build or generate the project.

This library makes it easy to:

  1. Persist the answers to the file system
  2. Store values based on the current working directory
  3. Store defaults that can be used regardless of the directory

How this works

  • An answer is stored based on the current working directory, and the currently defined locale.
  • A default answer may be defined for each locale

See the API docs for information about setting and getting stores values.

Example

var answer = new Answer('project-name');
answer.set('foo');

Results in the following object being written to project-name.json at '/Users/jonschlinkert/answers/project-name.json':

{
  cache:
   { dest: '/Users/jonschlinkert/answers',
+     path: '/Users/jonschlinkert/answers/project-name.json',
     cwd: '/Users/jonschlinkert/dev/answer-store' },
  options: {},
  name: 'project-name',
  data: { 
    en: { 
      '/Users/jonschlinkert/dev/answer-store': 'foo' 
    }
  }
}

locales

If the question has been answered for multiple locales, the object would something like this:

{
  cache:
   { dest: '/Users/jonschlinkert/answers',
     path: '/Users/jonschlinkert/answers/project-name.json',
     cwd: '/Users/jonschlinkert/dev/answer-store' },
  options: {},
  name: 'project-name',
+  data: { 
+    en: { '/Users/jonschlinkert/dev/answer-store': 'foo' },
+    es: { '/Users/jonschlinkert/dev/answer-store': 'bar' },
+    fr: { '/Users/jonschlinkert/dev/answer-store': 'baz' }
+  }
}

directories

When the question has been answered from different directories, the object might look something like this:

{
  cache:
   { dest: '/Users/jonschlinkert/answers',
     path: '/Users/jonschlinkert/answers/project-name.json',
     cwd: '/Users/jonschlinkert/dev/answer-store' },
  options: {},
  name: 'project-name',
  data: { 
+    en: { 
+      '/Users/jonschlinkert/dev/answer-store/1': 'foo1',
+      '/Users/jonschlinkert/dev/answer-store/2': 'foo2',
+      '/Users/jonschlinkert/dev/answer-store/3': 'foo3' 
+    }
  }
}

defaults

A default value may be stored for each locale:

{
  cache:
   { dest: '/Users/jonschlinkert/answers',
     path: '/Users/jonschlinkert/answers/project-name.json',
     cwd: '/Users/jonschlinkert/dev/answer-store' },
  options: {},
  name: 'project-name',
  data: { 
+    default: 'foo',
    en: { 
      '/Users/jonschlinkert/dev/answer-store/1': 'foo1',
      '/Users/jonschlinkert/dev/answer-store/2': 'foo2',
      '/Users/jonschlinkert/dev/answer-store/3': 'foo3' 
    }
  }
}

What else?

Module dependencies are lazily required, so initialization is fast!

API

Answer

Create new Answer store name, with the given options.

Params

  • name {String}: The answer property name.
  • options {Object}: Store options

.set

Store the specified value for the current (or given) local, at the current cwd.

Params

  • value {any}: The answer value.
  • locale {String}: Optionally pass the locale to use, otherwise the default locale is used.

Example

answer.set('foo');

.get

Get the stored answer for the current (or given) locale at the current cwd.

Params

  • locale {String}: Optionally pass the locale to use, otherwise the default locale is used.

Example

answer.get(locale);

.has

Return true if an answer has been stored for the current (or given) locale at the working directory.

Params

  • locale {String}: Optionally pass the locale to use, otherwise the default locale is used.

Example

answer.has('foo');

.del

Delete the stored values for the current (or given) locale, at the current cwd.

Params

  • locale {String}: Optionally pass the local to delete.

Example

answer.del(locale);

.erase

Erase all stored values and delete the answer store from the file system.

Example

answer.erase();

.setDefault

Set the default answer for the currently defined locale.

Params

  • locale {String}: Optionally pass the locale to use, otherwise the default locale is used.

Example

answer.setDefault('foo');

.getDefault

Get the default answer for the currently defined locale.

Params

  • locale {String}: Optionally pass the locale to use, otherwise the default locale is used.

Example

answer.getDefault();

.hasDefault

Return true if a value is stored for the current (or given) locale, at the current cwd.

Params

  • locale {String}: Optionally pass the locale to use, otherwise the default locale is used.

Example

answer.hasDefault(locale);

.delDefault

Delete the stored values for the current (or given) locale.

Params

  • locale {String}: Optionally pass the local to delete.

Example

answer.delDefault(locale);

Related projects

  • ask-once: Only ask a question one time and store the answer. | homepage
  • common-questions: An object of questions commonly used by project generators or when initializing projects. Questions can… more | homepage
  • question-cache: A wrapper around inquirer that makes it easy to create and selectively reuse questions. | homepage
  • question-store: Ask questions, persist the answers. Basic support for i18n and storing answers based on current… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm i -d && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm i -d && npm test

Author

Jon Schlinkert

License

Copyright © 2016 Jon Schlinkert Released under the MIT license.


This file was generated by verb, v0.9.0, on February 21, 2016.

Keywords

Install

npm i answer-store

DownloadsWeekly Downloads

3

Version

0.4.0

License

MIT

Last publish

Collaborators

  • avatar