nikitas-badges v1.1.1

nikitas-badges

some badges I made to be used with local-badges

Installation

npm install --save nikitas-badges

buildStatus

Usage:

// your badgeConfig.js file
const { buildStatus } = require('nikitas-badges')
module.exports = {
  badges: [
    buildStatus,
    {
      // any other badges you might want to include
    },
  ],
  defaults: {
    template: 'plastic',
  },
}

• Default name: 'build-status'
• Default folder: './' (current working directory)

outputs badge named 'build-status.svg' into the current working directory. To modify this behavior, you can do something like:

const { buildStatus } = require('nikitas-badges')
const customBuildStatus = {
  ...buildStatus,
  name: 'i-want-my-badge-to-be-named-differently',
  folder: './i/want/my/badge/to/go/to/a/different/folder',
}
module.exports = {
  badges: [
    customBuildStatus,
  ],
  defaults: {
    template: 'plastic',
  },
}

Examples:

Cli args:

Depends on the --build-status argument being passed in to local-badges. Including --build-status SUCCESS will create a build passing badge in bright green, otherwise it outputs build failing in red.

cloverCoverage

This badge outputs a code coverage percentage. It depends on a clover.xml file.

Usage:

// your badgeConfig.js file
const { cloverCoverage } = require('nikitas-badges')
module.exports = {
  badges: [
    buildStatus,
    {
      // any other badges you might want to include
    },
  ],
  defaults: {
    template: 'plastic',
  },
}

• Default name: 'coverage'
• Default folder: './' (current working directory)

Examples:

Cli args:

Depends on the --coverage-path argument being passed in to local-badges. The coverage path should be a path to a clover.xml file. This badge simply reads the first <metrics> tag it finds, and calculates the percentage based on statements, methods, and conditionals that are attributes of the metrics tag.