@form8ion/vitest

vitest

test framework plugin for form8ion

Table of Contents

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

Usage

Installation

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

Example

Import

import {dialects} from '@form8ion/javascript-core';
import {scaffold, test, lift} from '@form8ion/vitest';

Execute

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

  await scaffold({projectRoot, dialect: dialects.ESM});

  if (await test({projectRoot})) {
    await lift({projectRoot});
  }
})();

API

scaffold

Scaffolder for configuring Vitest as the unit-test framework for the project

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test