Registry / testing / ts-diagnostic-formatter

ts-diagnostic-formatter

library0.1.1jsnpmunverified

A collection of custom formatters for TypeScript diagnostics, providing human-readable output in ts-loader, stylish, and codeframe formats. Current stable version 0.1.1 has no recent updates; release cadence is unknown. Key differentiators: integrates with ts-loader, offers alternative formatting styles to the default TypeScript output. Requires TypeScript ^2.2.2 as a peer dependency. Primarily used as a development tool for formatting compiler diagnostics in build tools or custom scripts.

testing

npm install ts-diagnostic-formatter

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TS-DIAGNOSTIC-FORM

ts-diagnostic-formatter

testingjavascriptv0.1.1

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 diagnosticFormatter from 'ts-diagnostic-formatter'

✗ const diagnosticFormatter = require('ts-diagnostic-formatter')

Package exports a single default function; named imports not supported. Use ESM import for TypeScript.

DiagnosticFormatter

✓ import type { DiagnosticFormatter } from 'ts-diagnostic-formatter'

✗ import { DiagnosticFormatter } from 'ts-diagnostic-formatter'

Type export only; import as type to avoid runtime error in TypeScript.

createFormatter

✓ import { createFormatter } from 'ts-diagnostic-formatter'

✗ const createFormatter = require('ts-diagnostic-formatter').createFormatter

Although the default export is the main function, createFormatter is a named export. Use with ESM.

Demonstrates how to format TypeScript diagnostics using the stylish formatter and print to console.

import diagnosticFormatter from 'ts-diagnostic-formatter'; import * as ts from 'typescript'; const program = ts.createProgram(['app.ts'], { noEmit: true, strict: true }); const diagnostics = ts.getPreEmitDiagnostics(program); const formatter = 'stylish'; const contextPath = process.cwd(); const output = diagnosticFormatter(diagnostics, formatter, contextPath); console.log(output);

Debug

Known issues

deprecatedPackage is no longer actively maintained; may not work with modern TypeScript versions.

fix

Consider using TypeScript's built-in formatting or alternative libraries like ts-error-formatter.

affects: >=0.1.0

breakingRequires TypeScript ^2.2.2; incompatible with TypeScript 3+ due to API changes.

fix

Upgrade to a maintained alternative or pin TypeScript to version 2.x.

affects: >=0.1.0

gotchaThe default export is a function; do not use named imports for the main formatter.

fix

Use default import: import diagnosticFormatter from 'ts-diagnostic-formatter'.

affects: >=0.0.0

gotchaThe third argument (contextPath) is required; omitting it causes a runtime error.

fix

Always provide a contextPath string, e.g., process.cwd().

affects: >=0.1.0

deprecatedThe 'ts-loader' formatter is designed for a specific build tool and may not work outside that context.

fix

Use 'stylish' or 'codeframe' formatters for general use.

affects: >=0.0.0

Errors

Common errors & fixes

TypeError: diagnosticFormatter is not a function

Using named import like { diagnosticFormatter } instead of default import.

fix

import diagnosticFormatter from 'ts-diagnostic-formatter'

Cannot find module 'typescript'

Missing TypeScript peer dependency.

fix

npm install typescript@^2.2.2

Error: Unsupported formatter: 'unknown'

Using a formatter name not in the supported list (ts-loader, stylish, codeframe).

fix

Use one of: 'ts-loader', 'stylish', 'codeframe'.

Upgrade

Version history

0.1.1latest on npm

Audit

Dependencies

typescriptrequiredPeer dependency for TypeScript diagnostics types and APIs

Agent activity

9 hits · last 30 days

node

Amazon

Resources

githubhttps://github.com/zinserjan/ts-diagnostic-formatter ↗

packagets-diagnostic-formatter ↗

homepagehttps://github.com/zinserjan/ts-diagnostic-formatter#readme ↗