vscode-texinfo/src/diagnosis.ts

78 lines
2.5 KiB
TypeScript

/**
* diagnosis.ts
*
* Copyright (C) 2020,2021 CismonX <admin@cismon.net>
*
* This file is part of vscode-texinfo.
*
* vscode-texinfo is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the Free
* Software Foundation, either version 3 of the License, or (at your option)
* any later version.
*
* vscode-texinfo is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along with
* vscode-texinfo. If not, see <https://www.gnu.org/licenses/>.
*/
import * as vscode from 'vscode';
import { lineNumToRange } from './utils/misc';
import { isDefined } from './utils/types';
/**
* Manage diagnostic information of Texinfo documents.
*/
export default class Diagnosis implements vscode.Disposable {
/**
* Remove a document's diagnostic entry from the collection.
*
* @param document
*/
delete(document: vscode.TextDocument) {
this._diagnostics.delete(document.uri);
}
/**
* Generate diagnostic information based on error log from `makeinfo`.
*
* @param document
* @param logText
*/
update(document: vscode.TextDocument, logText: string) {
const fileName = document.uri.path;
const diagnostics = logText.split('\n')
.filter(line => line.startsWith(fileName))
.map(line => logToDiagnostic(line.substring(fileName.length + 1)))
.filter(isDefined);
this._diagnostics.set(document.uri, diagnostics);
}
dispose() {
this._diagnostics.dispose();
}
private readonly _diagnostics
= vscode.languages.createDiagnosticCollection('texinfo');
}
/**
* Convert a `makeinfo` error log line to a VSCode `Diagnostic` object.
*
* @param lineText
* @returns
*/
function logToDiagnostic(lineText: string) {
const lineNum = parseInt(lineText) - 1;
// Ignore error that does not correspond a line in document.
if (isNaN(lineNum)) return undefined;
const message = lineText.substring(lineNum.toString().length + 2);
const severity = message.startsWith('warning:')
? vscode.DiagnosticSeverity.Warning : undefined;
return new vscode.Diagnostic(lineNumToRange(lineNum), message, severity);
}