@code-pushup/core

[![npm](https://img.shields.io/npm/v/%40code-pushup%2Fcore.svg)](https://www.npmjs.com/package/@code-pushup/core) [![downloads](https://img.shields.io/npm/dm/%40code-pushup%2Fcore)](https://npmtrends.com/@code-pushup/core) [![dependencies](https://img.shi

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
@code-pushup/core
21830.39.018 days ago6 months agoMinified + gzip package size for @code-pushup/core in KB

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({
  // ...
});