Package Exports

vfile-messages-to-vscode-diagnostics

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 (vfile-messages-to-vscode-diagnostics) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

vfile-messages-to-vscode-diagnostics

A Node module to convert VFile#messages into an array of VS Code diagnostics

const VFile = require('vfile');
const vFileMessagesToVSCodeDiagnostics = require('vfile-messages-to-vscode-diagnostics');

vFileMessagesToVSCodeDiagnostics(new VFile().warn('error!', {line: 10, column: 2}));
/* =>
  [{
    message: 'error!',
    severity: 2,
    range: {
      start: {line: 9, character: 1},
      end: {line: 9, character: 1}
    }
  }]
*/

Installation

Use npm.

npm install vfile-messages-to-vscode-diagnostics

API

const vFileMessagesToVSCodeDiagnostics = require('vfile-messages-to-vscode-diagnostics');

vFileMessagesToVSCodeDiagnostics(messages)

messages: Object (VFile#messages)
Return: Array of VS Code's Diagnostics instance

It converts an array of VFileMessages to an array of Visual Studio Code API compatible Diagnostics instances.

const VFile = require('vfile');
const vFileMessagesToVSCodeDiagnostics = require('vfile-messages-to-vscode-diagnostics');

const file = new VFile();
file.warn('err1');
file.warn('err2', {
  position: {
    start: {line: 23, column: 5},
    end: {line: 23, column: 11}
  }
});

vFileMessagesToVSCodeDiagnostics(file.messages);
/* =>
  [{
    message: 'err1',
    severity: 2,
    range: {
      start: {line: 0, character: 0},
      end: {line: 0, character: 0}
    } 
  }, {
    message: 'err2',
    severity: 2,
    range: {
      start: {line: 22, character: 4},
      end: {line: 22, character: 10}
    }
  }]
*/

License

Licensed under the MIT License.