Hairballs

0.3.3 verified Fri May 01 auth: no javascript maintenance

Shared utilities for lint reporters, including ESLint and SCSS-Lint. Version 0.3.3 is current, with infrequent releases. Provides formatting and reporting helpers. Minimal dependencies, but some security fixes were applied in v0.3.0 for Handlebars vulnerabilities. Not widely used; primarily for internal tooling at ratherblue.

Common errors

error Cannot find module 'hairballs' ↓

cause Package not installed or not in node_modules.

fix

Run npm install hairballs.

error TypeError: hairballs.formatResults is not a function ↓

cause Using default import instead of named import.

fix

Use import { formatResults } from 'hairballs'.

Warnings

deprecated handlebars dependency had a prototype pollution vulnerability before v0.3.0 ↓

fix Update to v0.3.0 or later.

gotcha No TypeScript definitions; use with @ts-ignore or create own types. ↓

fix Declare module or use .d.ts file.

breaking v0.3.0 updated dependencies, potentially breaking if relying on old Handlebars behavior. ↓

fix Test reporters with new versions.

Install

npm install hairballs

yarn add hairballs

pnpm add hairballs

Imports

default
wrong
```
const hairballs = require('hairballs')
```
correct
```
import hairballs from 'hairballs'
```
Package does not export a default, but some users might try default import; actual export is named.

formatResults

wrong

const { formatResults } = require('hairballs')

correct

import { formatResults } from 'hairballs'

ESM only; CJS require will not work.

createReporter
```
import { createReporter } from 'hairballs'
```
Named export; TypeScript definitions not officially provided.

Quickstart

Demonstrates importing formatResults and formatting a lint result object.

import { formatResults } from 'hairballs';
const results = formatResults({
  errors: [{ message: 'Unexpected var', line: 1, column: 5 }],
  warnings: []
});
console.log(results);