@form8ion/javascript-core

javascript-core

core logic for form8ion tools related to JavaScript, like javascript-scaffolder and lift-javascript

Table of Contents

• Usage
  • Installation
  • Example
    • Import
    • Scaffold
  • API
    • scaffoldChoice
      • choices object (required)
      • choice string (required)
      • options object (optional)
    • scaffoldUnitTesting
      • projectRoot string (required)
      • frameworks object (required)
      • decisions object (optional)
      • visibility string (required)
      • vcs object (required)
    • unitTestFrameworksSchema
    • questionNames
• Contributing
  • Dependencies
  • Verification

Usage

Installation

$ npm install @form8ion/javascript-core --save-prod

Example

Import

import {scaffoldUnitTesting, scaffoldChoice} from '@form8ion/javascript-core';

Scaffold

(async () => {
  await scaffoldUnitTesting({
    projectRoot: process.cwd(),
    visibility: 'Public',
    vcs: {host: 'GitHub', owner: 'foo', name: 'bar'}
  });

  await scaffoldChoice(
    {foo: {scaffolder: options => options}},
    'foo',
    {bar: 'baz'}
  );
})();

API

scaffoldChoice

A generic function that executes the scaffolder function from a provided map of options based on the chosen option name.

Takes three unnamed arguments:

choices object (required)

• keys: string Name of the choice
• values: object
  • scaffolder: function (required) scaffolds the choice options

choice string (required)

Name of the choice. SHOULD match a key from the choices object.

options object (optional)

options object to be passed as the only argument to the chosen scaffolder

scaffoldUnitTesting

Scaffolder for enabling unit-testing in a project with the ability to choose a desired framework from provided options.

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

frameworks object (required)

A choices object for defining unit-testing framework options

decisions object (optional)

Answers for prompt questions so that the prompt is skipped at execution time

• keys: string Name of the prompt question
• values: Hard-coded answer for the prompt question

visibility string (required)

visibility of the project (Public or Private)

vcs object (required)

• host string (required) VCS hosting service
• owner string (required) account name on the host service for the repository
• name string (required) repository name

unitTestFrameworksSchema

joi schema for the choices required for the unit-testing scaffolder

questionNames

Constants defining the question names for the prompts implemented in this package

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test