feat: migrate to W3C Spec Generator API and implement error handling for validation failures (#9)

* ci: add automated release workflow and bump version to 0.0.3

* feat: migrate to W3C Spec Generator API and implement error handling for validation failures

* feat: add vsce package dependency and build script for extension packaging

* style: fix indentation and formatting in release workflow YAML

* ci: update release workflow to trigger on tag creation

Author: alexnj

README.md

@@ -9,7 +9,7 @@ This plugin is currently in Beta and under active development. There may be bugs
 ## Features
 
 - Bikeshed side-by-side preview within Visual Studio Code. Bring up Visual Studio Code [Command Palette](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette) (⇧⌘P on Macs) and select `Open Bikeshed Preview` while editing a Bikeshed file.
-- Compilation support via [local Bikeshed install](https://speced.github.io/bikeshed/#installing) or through [a remote CGI](https://api.csswg.org/bikeshed/).
+- Compilation support via [local Bikeshed install](https://speced.github.io/bikeshed/#installing) or through the [W3C Spec Generator](https://www.w3.org/publications/spec-generator/).
 - IntelliSense / autocompletion support for W3C webref definitions and definitions within the document.
 
 ## Requirements
@@ -23,7 +23,7 @@ This extension contributes the following settings:
 - `visualBikeshed.autoUpdate`: Automatically update the preview when the document changes.
 - `visualBikeshed.compilerOption`: Selects a compilation method (URL or Bikeshed binary path).
 - `visualBikeshed.commandPath`: Path to the Bikeshed binary, for local compilation.
-- `visualBikeshed.processorUrl`: URL of the Bikeshed processor (defaults to `https://api.csswg.org/bikeshed/`).
+- `visualBikeshed.processorUrl`: URL of the Bikeshed processor (defaults to `https://www.w3.org/publications/spec-generator/`).
 
 ## Known Issues
 

client/src/extension-preview.ts

@@ -11,6 +11,12 @@ import { parseStringPromise } from 'xml2js';
 
 const PREVIEW_UPDATE_DEBOUNCE_TIME = 500;
 
+type SpecGeneratorError = {
+  lineNum: string | null;
+  messageType: 'fatal' | 'warning' | 'linkerror' | 'message' | 'failure';
+  text: string;
+};
+
 type BikeshedErrorOutput = {
   root: {
     warning?: string[];
@@ -39,7 +45,7 @@ async function updateWebview(
       const commandPath = config.get<string>('commandPath', 'bikeshed');
       const processorUrl = config.get<string>(
         'processorUrl',
-        'https://api.csswg.org/bikeshed/'
+        'https://www.w3.org/publications/spec-generator/'
       );
       let htmlContent = '';
       try {
@@ -166,6 +172,19 @@ async function parseErrors(xml: string): Promise<BikeshedErrorOutput> {
   }
 }
 
+function notifyUserOfJSONErrors(errors: SpecGeneratorError[]): void {
+  for (const err of errors) {
+    let status: VSCodeNotifyType = 'info';
+    if (err.messageType === 'fatal' || err.messageType === 'failure') {
+      status = 'error';
+    } else if (err.messageType === 'warning') {
+      status = 'warning';
+    }
+    const msg = `${err.lineNum ? `[${err.lineNum}] ` : ''}${err.text}`;
+    notify(msg, status);
+  }
+}
+
 function notifyUserOfErrors(errors: BikeshedErrorOutput): void {
   const messages: [string, VSCodeNotifyType][] = [];
   if (errors.root.fatal) {
@@ -216,35 +235,45 @@ async function getProcessedContent(
 ): Promise<string> {
   const formData = new FormData();
   formData.append('file', new Blob([content]), 'file.bs');
-  formData.append('force', '1');
-  const response = await axios.post(processorUrl, formData, {
-    headers: {
-      'Content-Type': 'multipart/form-data',
-    },
-    onUploadProgress: (progressEvent) => {
-      const percentCompleted = Math.round(
-        progressEvent.total
-          ? (progressEvent.loaded / progressEvent.total) * 50
-          : 0
-      );
-      progress.report({
-        increment: percentCompleted,
-        message: `Uploading to ${processorUrl}`,
-      });
-    },
-    onDownloadProgress: (progressEvent) => {
-      const percentCompleted = Math.round(
-        progressEvent.total
-          ? (progressEvent.loaded / progressEvent.total) * 50
-          : 0
-      );
-      progress.report({
-        increment: 50 + percentCompleted,
-        message: `Downloading compiled output from ${processorUrl}`,
-      });
-    },
-  });
-  return response.data;
+  formData.append('type', 'bikeshed-spec');
+
+  try {
+    const response = await axios.post(processorUrl, formData, {
+      headers: {
+        'Content-Type': 'multipart/form-data',
+      },
+      onUploadProgress: (progressEvent) => {
+        const percentCompleted = Math.round(
+          progressEvent.total
+            ? (progressEvent.loaded / progressEvent.total) * 50
+            : 0
+        );
+        progress.report({
+          increment: percentCompleted,
+          message: `Uploading to ${processorUrl}`,
+        });
+      },
+      onDownloadProgress: (progressEvent) => {
+        const percentCompleted = Math.round(
+          progressEvent.total
+            ? (progressEvent.loaded / progressEvent.total) * 50
+            : 0
+        );
+        progress.report({
+          increment: 50 + percentCompleted,
+          message: `Downloading compiled output from ${processorUrl}`,
+        });
+      },
+    });
+    return response.data;
+  } catch (error) {
+    if (axios.isAxiosError(error) && error.response?.status === 422) {
+      const apiErrors = error.response.data as SpecGeneratorError[];
+      notifyUserOfJSONErrors(apiErrors);
+      throw new Error('Compilation failed with errors.');
+    }
+    throw error;
+  }
 }
 
 async function getProcessedContentWithShell(