Package Exports

@dev-build-deploy/diagnose-it
@dev-build-deploy/diagnose-it/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@dev-build-deploy/diagnose-it) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

DiagnoseIt - Expressive Diagnostics Library

Lightweight diagnostics logger, based on LLVMs Expressive Diagnostics specification:

Features

Simple to use
Inspired by the LLVMs Expressive Diagnostics specification
Provide context to your diagnostics messages

Usage

Create an Expressive Diagnostics message

import { DiagnosticsMessage, FixItHint } from '@dev-build-deploy/diagnose-it';
const lines = `steps:
  - uses: actions/checkout@v2
  - neds: [build, test]
    - uses: actions/setup-node@v2`;
  
// Example use case
const message = DiagnosticsMessage.createError(
  "example.yaml",
  {
    text: "Invalid keyword 'neds'",
    linenumber: 9,
    column: 5
  }
)
  // Add context to the diagnostics message
  .setContext(7, lines)
  // Add a FixIt Hint
  .addFixitHint(FixItHint.createReplacement({ index: 5, length: 4 }, "needs"));

// Convert to string
console.log(message.toString());

// Apply FixIt Hints
console.log("Results after applying FixIt Hints:", message.applyFixitHints());

// Throw as an Error
throw message;

Parse a file

You can parse a (compiler output) file to retrieve any Expressive Diagnostic message:

import * as diagnoseIt from '@dev-build-deploy/diagnose-it';

for await(const message of diagnoseIt.extractFromFile("build.log")) {
  if (message.toJSON().type === "error") {
    // Oh noes!
  }
}

NOTE: Any .sarif or .sarif.json file will be parsed for valid SARIF results content

Output format

DiagnoseIt is inspired by the LLVMs Expressive Diagnostics formatting;

However, it does not aim to provide full compatibility.

Contributing

If you have suggestions for how DiagnoseIt could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

@dev-build-deploy/diagnose-it