trevtrich / lift

tool for running sub-scaffolders on existing projects :aerial_tramway:

lift

tool for running sub-scaffolders on existing projects 🚡

Table of Contents

• Features
  • Coming Soon
• Usage
  • Installation
  • Example
  • API
    • scaffolders object (required)
    • decisions object (optional)
• Contributing
  • Dependencies
  • Verification

Features

• Runs registered sub-scaffolders independantly of the project-scaffolder, enabling existing projects to be lifted with additional functionality
  • Injects badges from the sub-scaffolder results into the README.md as long as the existing README.md lists the badges using the (fairly recent) zoning convention
• Modify existing README.md files to add badges

Coming Soon

• JavaScript project features
  • Dependency installation
  • Modification of package.json to add scripts and other details

Usage

Installation

$ npm install @form8ion/lift --save-prod

Example

import {lift} from '@form8ion/lift';

lift({});

API

scaffolders object (required)

• keys: string Name of each scaffolder
• values: function Does the scaffolding when executed
  • receives an options object as the first argument
    • projectRoot: string path of the working directory where the CLI command was executed

decisions object (optional)

Answers for expected prompts, to enable consistent behavior while skipping those particular interactive prompts

• keys: string Name of each question
• values: mixed The answer to provide instead of being prompted interactively

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test