README.md

java

Java language plugin for the @form8ion toolset

Table of Contents

• Features
  • scaffold
• Usage
  • Installation
  • Example
    • Import
    • Execute
  • API
    • scaffold
      • projectRoot string (required)
      • projectName string (required)
• Contributing
  • Dependencies
  • Verification

Features

scaffold

• creates a minimal POM

Usage

Installation

$ npm install @form8ion/java --save

Example

Import

import {scaffold, lift, test} from '@form8ion/java';

Execute

(async () => {
  const projectRoot = process.cwd();

  await scaffold({projectRoot, projectName: 'project-name'});

  if (await test({projectRoot})) {
    await lift({projectRoot, vcs: {}});
  }
})();

API

scaffold

projectRoot string (required)

path to the root of the project

projectName string (required)

name of the project

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test