JSPM

  • Created
  • Published
  • Downloads 7101
  • Score
    100M100P100Q122593F
  • License MIT

Core business logic for the used by the Code PushUp CLI

Package Exports

  • @code-pushup/core
  • @code-pushup/core/src/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@code-pushup/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@code-pushup/core

npm downloads dependencies

🔎🔬 Quality metrics for your software project. 📉🔍

  1. ⚙️ Configure what you want to track using your favourite tools.
  2. 🤖 Integrate it in your CI.
  3. 🌈 Visualize reports in a beautiful dashboard.

This package contains the core business logic for the Code PushUp CLI.

For most use cases, you'll probably want to use the @code-pushup/cli package instead. The core package is useful if you prefer programmatic usage (avoids going through the command line).

Setup

npm install --save-dev @code-pushup/core
yarn add --dev @code-pushup/core
pnpm add --save-dev @code-pushup/core

Usage

import { collect } from '@code-pushup/core';

const report = await collect({
  // ...
});