@code-pushup/core

@code-pushup/core

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

Changelog

0.1.0 (2023-12-01)

Bug Fixes

• cli-e2e: re-create package-lock.json (8a99ec0)
• cli: changed persist format options to array (#153) (26c6a85), closes #95
• cli: exclude nested kebab-case keys, update tests (741d5a5)
• cli: parse multiple config args to last item of array (#164) (7c81f81), closes #146
• cli: replace clui on @isaacs/cliui (#282) (465f230), closes #209
• cli: run npm install before tests (6507c2e)
• core: audit metadata looked up in plugin config, not expected in output (31ffd5e)
• core: include package.json data (0fef0c3)
• formatting (7e5e743)
• lint config and errors (6f5f677)
• models: add package.lock (8075613)
• models: allow empty string as docsUrl (1c34d92)
• models: increase character limit for issue message (e6f6fc8)
• plugin-eslint: allow unmatched patterns (d350187)
• plugin-eslint: ensure runner output directory exists (fca87f5)
• plugin-eslint: ensure working directory exists before writing .eslintrc.json (3f19d6f)
• plugin-eslint: exclude rules which are turned off (f2cc454)
• plugin-eslint: handle implicitly relative config paths (39a7d43)
• plugin-eslint: omit empty docsUrl in audit metadata (3127683)
• plugin-eslint: pluralize audit display value based on count (aa35d0c)
• refactor after core package intro (#83) (aa39d09)
• sync package-lock.json with npm install (0fde5f3)
• testing: fix tests for Windows (#165) (b80255b), closes #131
• utils,cli: remove all mentions of the interactive option (#245) (be7471e), closes #120
• utils: handle descriptions ending in code block in report.md (a9a05ad)

Features

• add transform to persist config (#229) (ce4d975)
• cli: add --persist.filename cli option (#187) (296df7d)
• cli: disabled version option (#162) (9a5371c), closes #124
• cli: initial collect command (#45) (ba048be)
• cli: introduce the onlyPlugins option (#246) (13c9d26), closes #119
• cli: persist login and formatting options (#47) (6241fd7)
• cli: setup yargs for cli (#42) (37ea0a5), closes #6 #38
• cli: use bundle-require instead of jiti (no hackfix, but also no CJS configs) (028c592)
• configure build and tests to handle ESM and CJS configs (48cd967)
• core: add core package (dd8ddae)
• core: add esm plugin logic (#248) (18d4e3a)
• core: change to execute all plugins before throwing on failed (#275) (32a6ef5), closes #159
• models: add isBinary field to category schema (8b13039)
• models: add report filename option (#174) (bdeab54)
• models: setup types and parser with zod (7d5c99e)
• models: validate plugin icons using portal-client package (f52cc75)
• nx-plugin: add configuration generator (#294) (ee21143), closes #61
• nx-plugin: initial setup and init command (#51) (c8dd4d9), closes #9
• plugin-eslint: add support for inline eslint config (67571eb)
• plugin-eslint: configure bin entry point (b34ecb2)
• plugin-eslint: convert rule ids to slugs, add basic description to audits (971c97a)
• plugin-eslint: create groups from rules' meta.docs.category (per plugin) (56e129c)
• plugin-eslint: create groups from rules' meta.type (problem/suggestion/layout) (0350e49)
• plugin-eslint: implement runner logic (0ad5445)
• plugin-eslint: include NPM package name and version (25bda11)
• plugin-eslint: register audit metadata based on eslintrc and file patterns (3aac581)
• plugin-eslint: rule options used to identify audit, options in slug (hash) and description (b9f51c9)
• plugin-eslint: validate initializer params with Zod (56e1aee)
• support top-level await in config files (7712250)
• support TS config files using Jiti + hackfix lighthouse import.meta usages (3b7927d)
• utils: add audits sorting for reports (#302) (10ee12e), closes #210
• utils: add command line args helper (#52) (9d6acec), closes #43
• utils: add file size logging (#65) (c46046f), closes #59
• utils: add file-system helper (#336) (001498b)
• utils: add package utils for cli independent logic (#39) (dacaaf7), closes #32
• utils: add scoring logic (#133) (89fecbb)
• utils: add upload logic (#66) (3e88ffc), closes #21 #57 #85
• utils: implement a new design for stdout (#206) (84b8c28), closes #190
• utils: implement report.md formatting (#196) (346596d), closes #148
• utils: implement verbose helper logic (#121) (112ebe7)
• utils: move parts from utils into core (#81) (dd0a180), closes #78
• utils: update git latest commit functionality (#205) (7ec4582), closes #192

Performance Improvements

• utils: add benchmark logic and example (#137) (142943e)
• utils: improve the performance of scoring and reporting (#212) (41d7c0b), closes #132