https://github.com/zinserjan/ts-diagnostic-formatter

Formatter for TypeScript Diagnostics
https://github.com/zinserjan/ts-diagnostic-formatter

Last synced: 2 months ago
JSON representation

Formatter for TypeScript Diagnostics

• Host: GitHub
• URL: https://github.com/zinserjan/ts-diagnostic-formatter
• Owner: zinserjan
• License: mit
• Created: 2017-06-23T17:34:26.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-19T20:57:45.000Z (over 7 years ago)
• Last Synced: 2024-11-09T21:10:51.966Z (3 months ago)
• Language: TypeScript
• Size: 140 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ts-diagnostic-formatter

[![Build Status Linux][build-travis-badge]][build-travis] [![Build Status Windows][build-appveyor-badge]][build-appveyor] [![codecov][codecov-badge]][codecov]

A collection of custom formatter for TypeScript Diagnostics.

## Installation

Install ts-diagnostic-formatter via NPM as usual:

```sh

$ npm install ts-diagnostic-formatter --save-dev

```

## Usage

```typescript

import diagnosticFormatter from "ts-diagnostic-formatter";

const formatter =  "ts-loader"; // or stylish/codeframe

const contextPath = process.cwd();

const formattedDiagnostics = diagnosticFormatter(diagnostics, formatter, contextPath);

```

## Included formatters

### ts-loader

![ts-loader formatter](docs/screenshots/ts-loader.png)

### stylish

![stylish formatter](docs/screenshots/stylish.png)

### codeframe

![codeframe formatter](docs/screenshots/codeframe.png)

## License

MIT

[build-travis-badge]: https://travis-ci.org/zinserjan/ts-diagnostic-formatter.svg?branch=master

[build-travis]: https://travis-ci.org/zinserjan/ts-diagnostic-formatter

[build-appveyor-badge]: https://ci.appveyor.com/api/projects/status/swjbs9vq1l9yy4v9/branch/master?svg=true

[build-appveyor]: https://ci.appveyor.com/project/zinserjan/ts-diagnostic-formatter

[codecov-badge]: https://codecov.io/gh/zinserjan/ts-diagnostic-formatter/branch/master/graph/badge.svg

[codecov]: https://codecov.io/gh/zinserjan/ts-diagnostic-formatter