Registry / devops / checkup-formatter-pretty

checkup-formatter-pretty

JSON →
library1.4.2jsnpmunverified

A pretty formatter for Checkup, a project health and consistency tool. Version 1.4.2 (latest) is part of Checkup monorepo. Provides human-readable console output with colors and structure. Released as needed alongside Checkup core. Key differentiator: standard pretty-printing for Checkup results, integrates seamlessly with Checkup's plugin ecosystem. Requires Node >= 12.22; ESM-only.

devops
npm install checkup-formatter-pretty
github ↗package ↗homepage ↗
INSTALL
IMPORT
SIG · CHECKUP-FORMATTER-
C
checkup-formatter-pretty
devopsjavascriptv1.4.2
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

default
✓ import PrettyFormatter from 'checkup-formatter-pretty';
✗ const PrettyFormatter = require('checkup-formatter-pretty');
Package is ESM-only, named default export. CommonJS require will fail.
PrettyFormatter
✓ import { PrettyFormatter } from 'checkup-formatter-pretty';
✗ import PrettyFormatter from 'checkup-formatter-pretty';
Named export also available as an alternative to default import.
FormatterResult
✓ import { FormatterResult } from 'checkup-formatter-pretty';
Type/Duck-typed interface used by formatters. Not a class, but imported from same path.

Creates a PrettyFormatter instance, formats sample checkup results, and prints formatted output.

import PrettyFormatter from 'checkup-formatter-pretty'; const formatter = new PrettyFormatter(); const results = [ { taskName: 'ember-version', taskResult: { version: '3.28' }, category: 'framework', severity: 'info', }, ]; formatter.format(results).then(console.log); // Output: colorized table with task info
Debug
Known issues
breakingPackage is ESM-only. Using require() throws ERR_REQUIRE_ESM.
fix
Use import or dynamic import().
affects: >=1.0
gotchaThe format() method is async (returns Promise). Forgetting await leads to logging Promise object.
fix
Always await or .then() the result.
affects: >=1.0
deprecatedFormatter interface changed in Checkup v2.0; this formatter may need update.
fix
Check compatibility with @checkup/core version.
affects: 1.x
gotchaPrettyFormatter expects results with specific shape. Passing raw checkup output might fail silently.
fix
Pass properly structured task result objects.
affects: >=1.0
Errors
Common errors & fixes
Error [ERR_REQUIRE_ESM]: Must use import to load ES Module: checkup-formatter-pretty
Using require() on ESM-only package.
fix
Replace require() with import or use dynamic import() in CommonJS context.
TypeError: formatter.format(...).then is not a function
Missing await before format() call, trying to chain .then on undefined.
fix
Add await: const output = await formatter.format(results);
Cannot find module 'checkup-formatter-pretty'
Package not installed or not in node_modules.
fix
Run npm install checkup-formatter-pretty.
Upgrade
Version history
1.4.2latest on npm
Audit
Dependencies
@checkup/corerequiredCore types and formatter interface
json5optionalParsing checkup config (internal transitive dep)
Agent activity
2 hits · last 30 days
node
2
Resources
githubhttps://github.com/checkupjs/checkup ↗
packagecheckup-formatter-pretty ↗
homepagehttps://github.com/checkupjs/checkup#readme ↗
checkup-formatter-pretty — npm install checkup-formatter-pretty · libregistry