README.md

vite

form8ion plugin for managing Vite configuration in javascript projects

Table of Contents

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

Usage

Installation

$ npm install @form8ion/vite --save-dev

Example

Import

import {scaffold} from '@form8ion/vite';

Execute

(async () => {
  await scaffold({projectRoot: process.cwd(), projectType: projectTypes.PACKAGE});
})();

API

scaffold

Scaffolder for enabling Vite for building a project.

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

projectType string (required)

Chosen type of possible JavaScript project type

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test