BanzaiMan / lift-javascript

lift enhancer for details specific to the JavaScript language

lift-javascript

lift enhancer for details specific to the JavaScript language

Table of Contents

• Features
  • Coming Soon
• Usage
  • Installation
  • Example
    • Import
    • Execute
  • API
    • test
      • projectRoot string (required)
    • lift
      • projectRoot string (required)
      • results object (required)
    • configs object (optional)
      • eslint object (optional)
        • scope string (required)
• Contributing
  • Dependencies
  • Verification

Features

• Adds scripts to package.json from results

Coming Soon

• Install dependencies from results
• Configure eslint configs from results

Usage

Installation

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

Example

Import

import {lift, test} from '@form8ion/lift-javascript';

Execute

const projectRoot = process.cwd();

(async () => {
  if (await test({projectRoot})) {
    await lift({
      results: {dependencies: [], devDependencies: [], scripts: {}, eslintConfigs: []},
      projectRoot
    });
  }
})();

API

test

predicate function that returns true when the project is a JavaScript project

Arguments:

projectRoot string (required)

path to the root of the project

lift

function that takes results from a JavaScript sub-scaffolder and applies the necessary changes to an existing project

Arguments:

projectRoot string (required)

path to the root of the project

results object (required)

results from sub-scaffolder

configs object (optional)

eslint object (optional)

Config details scaffolding for ESLint. eslintConfigs in results will only be processed if these details are provided.

scope string (required)

The npm scope to be used when installing and configuring use of shareable ESLint config packages.

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test