@form8ion/codecov

codecov

code coverage service plugin for form8ion

Table of Contents

• Features
  • Lift
• Usage
  • Installation
  • Example
    • Import
    • Execute
  • API
    • scaffold
    • lift
      • projectRoot string (required)
      • packageManager string (required)
      • vcs object (required)
• Contributing
  • Dependencies
  • Verification

Features

Lift

• Define a coverage status badge to communicate current coverage details
• Link from the status badge to further details on the Codecov site
• Migrate from the legacy node uploader to the modern uploader
  • Currently supports the following CI Providers:
    • GitHub Action

Usage

Installation

$ npm install @form8ion/codecov --save

Example

Import

import {packageManagers} from '@form8ion/javascript-core';
import {scaffold, lift} from '@form8ion/codecov';

Execute

(async () => {
  await scaffold();

  await lift({
    projectRoot: process.cwd(),
    packageManager: packageManagers.NPM,
    vcs: {
      host: 'github',
      owner: 'foo',
      name: 'bar'
    }
  });
})();

API

scaffold

The scaffolder of this plugin is currently a no-op since the work is all done as part of the lifting process

lift

Migrates Codecov details from legacy conventions to modern conventions.

Takes a single options object as an argument, containing:

projectRoot string (required)

path to the root of the project

packageManager string (required)

chosen package manager to be used for the project

vcs object (required)

• host string (required) VCS hosting service
• owner string (required) account name on the host service for the repository
• name string (required) repository name

Contributing

Dependencies

$ nvm install
$ npm install

Verification

$ npm test