Improve error message with title, description, and examples (#10)

* Add source and hover information to error output

For the CLI, only the source (i.e. title property) is added.
FOr the CI, the hover information (title, description, examples) are
added and formatted according to YAMLHover.

* build

* run prettier

* Fix escape sequences in links not being unescaped

* build

github-action/index.ts

@@ -2,8 +2,14 @@ import * as core from '@actions/core';
 import * as path from 'path';
 import { YamlVersion } from 'yaml-language-server/out/server/src/languageservice/parser/yamlParser07';
 import { SchemaMapping, validateDirectory } from '../src';
+import { MarkupContent } from 'vscode-languageserver-types';
+
+import { marked } from 'marked';
+import { markedTerminal } from 'marked-terminal';
 
 async function run() {
+    marked.use(markedTerminal() as any);
+
     let rootPath = process.env['GITHUB_WORKSPACE'] as string;
     let relativeToRoot = core.getInput('root', { trimWhitespace: true });
     if (relativeToRoot) {
@@ -29,19 +35,20 @@ async function run() {
     if (results && results.length > 0) {
         for (const result of results) {
             for (const error of result.error) {
-                core.error(
-                    `${result.filePath}:${error.range.start.line + 1}:${error.range.start.character + 1}: ${
-                        error.message
-                    }`,
-                    {
-                        title: error.message,
-                        file: result.filePath,
-                        startLine: error.range.start.line + 1,
-                        endLine: error.range.end.line + 1,
-                        startColumn: error.range.start.character,
-                        endColumn: error.range.end.character,
-                    },
-                );
+                const { diag, hover } = error;
+                const hoverMessage =
+                    hover && MarkupContent.is(hover.contents)
+                        ? `\n\n${marked(hover.contents.value, { gfm: false })}`
+                        : '';
+
+                core.error(diag.message + hoverMessage, {
+                    title: `${diag.message}${diag.source ? ' ' + diag.source + '.' : ''}`,
+                    file: result.filePath,
+                    startLine: diag.range.start.line + 1,
+                    endLine: diag.range.end.line + 1,
+                    startColumn: diag.range.start.character,
+                    endColumn: diag.range.end.character,
+                });
             }
         }
 

github-action/webpack.config.js

@@ -24,7 +24,7 @@ module.exports = {
     ),
   ],
   resolve: {
-    extensions: [ '.ts', '.js' ],
+    extensions: [ '.ts', '.js', '.json' ],
   },
   output: {
     filename: 'index.js',

package.json

@@ -42,8 +42,11 @@
     "@actions/core": "^1.10.0",
     "@types/glob": "^7.1.4",
     "@types/jest": "^27.0.2",
+    "@types/marked-terminal": "^6.0.1",
     "@types/node": "^16.9.4",
     "jest": "^27.2.1",
+    "marked": "^11.1.1",
+    "marked-terminal": "^6.2.0",
     "npm-run-all": "^4.1.5",
     "prettier": "^2.4.1",
     "rimraf": "^3.0.2",