pr annotations

Author: GarboMuffin

.github/workflows/validate.yml

@@ -35,7 +35,7 @@ jobs:
           cache: npm
       - name: Install dependencies
         run: npm ci
-      - name: Validate
+      - name: Lint
         run: npm run lint
 
   format:
@@ -52,5 +52,22 @@ jobs:
           cache: npm
       - name: Install dependencies
         run: npm ci
-      - name: Validate
+      - name: Check format
         run: npm run check-format
+
+  type-warnings:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+      - name: Install Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Generate type warnings
+        run: npm run generate-type-warnings

development/ci-commands.js

@@ -0,0 +1,42 @@
+import pathUtil from "node:path";
+
+/**
+ * @returns {boolean} true if running in GitHub Actions, etc.
+ */
+export const isCI = () => !!process.env.CI;
+
+/**
+ * @typedef Annotation
+ * @property {'notice'|'warning'|'error'} type
+ * @property {string} file Absolute path to file or relative from repository root
+ * @property {string} title
+ * @property {string} message
+ * @property {number} [line] 1-indexed
+ * @property {number} [col] 1-indexed
+ * @property {number} [endLine] 1-indexed
+ * @property {number} [endCol] 1-indexed
+ */
+
+/**
+ * @param {Annotation} annotation
+ */
+export const createAnnotation = (annotation) => {
+  const rootDir = pathUtil.join(import.meta.dirname, "..");
+  const relativeFileName = pathUtil.relative(rootDir, annotation.file);
+
+  let output = "";
+  output += `::${annotation.type} `;
+  output += `file=${relativeFileName}`;
+
+  if (typeof annotation.line === "number") output += `,line=${annotation.line}`;
+  if (typeof annotation.col === "number") output += `,col=${annotation.col}`;
+  if (typeof annotation.endLine === "number")
+    output += `,endLine=${annotation.endLine}`;
+  if (typeof annotation.endCol === "number")
+    output += `,endCol=${annotation.endCol}`;
+
+  output += `,title=${annotation.title}::`;
+  output += annotation.message;
+
+  console.log(output);
+};

development/colors.js

@@ -3,5 +3,8 @@ const color = (i) => (enableColor ? i : "");
 
 export const RESET = color("\x1b[0m");
 export const BOLD = color("\x1b[1m");
+
 export const RED = color("\x1b[31m");
+export const YELLOW = color("\x1b[33m");
 export const GREEN = color("\x1b[32m");
+export const BLUE = color("\x1b[34m");

development/generate-type-warnings.js

@@ -0,0 +1,65 @@
+import pathUtil from "node:path";
+import ts from "typescript";
+import { createAnnotation } from "./ci-commands.js";
+
+/**
+ * @fileoverview
+ * tsc command output will be parsed by GitHub Actions as errors.
+ * We want them to be just warnings.
+ */
+
+const check = () => {
+  const rootDir = pathUtil.join(import.meta.dirname, "..");
+  const tsconfigPath = pathUtil.join(rootDir, "tsconfig.json");
+  const commandLine = ts.getParsedCommandLineOfConfigFile(
+    tsconfigPath,
+    {},
+    ts.sys
+  );
+
+  const program = ts.createProgram({
+    rootNames: commandLine.fileNames,
+    options: commandLine.options,
+  });
+  const emitted = program.emit();
+
+  const diagnostics = [
+    ...ts.getPreEmitDiagnostics(program),
+    ...emitted.diagnostics,
+  ];
+
+  let numWarnings = 0;
+
+  for (const diagnostic of diagnostics) {
+    numWarnings++;
+
+    const startPosition = ts.getLineAndCharacterOfPosition(
+      diagnostic.file,
+      diagnostic.start
+    );
+    const endPosition = ts.getLineAndCharacterOfPosition(
+      diagnostic.file,
+      diagnostic.start
+    );
+    const flattened = ts.flattenDiagnosticMessageText(
+      diagnostic.messageText,
+      " ",
+      0
+    );
+
+    createAnnotation({
+      type: "warning",
+      file: diagnostic.file.fileName,
+      title: "Type warning - may indicate a bug - ignore if no bug",
+      message: flattened,
+      line: startPosition.line + 1,
+      col: startPosition.character + 1,
+      endLine: endPosition.line + 1,
+      endCol: endPosition.character + 1,
+    });
+  }
+
+  console.log(`${numWarnings} warnings.`);
+};
+
+check();

development/validate.js

@@ -1,4 +1,5 @@
 import Builder from "./builder.js";
+import { createAnnotation, isCI } from "./ci-commands.js";
 import * as Colors from "./colors.js";
 
 const builder = new Builder("production");
@@ -15,10 +16,23 @@ if (errors.length === 0) {
       errors.length === 1 ? "file" : "files"
     } failed validation.${Colors.RESET}`
   );
+
   console.error("");
+
   for (const { fileName, error } of errors) {
     console.error(`${Colors.BOLD}${fileName}${Colors.RESET}: ${error}`);
+
+    if (isCI()) {
+      const nameWithoutLeadingSlash = fileName.replace(/^\//, "");
+      createAnnotation({
+        type: "error",
+        file: nameWithoutLeadingSlash,
+        title: "Validation error",
+        message: error,
+      });
+    }
   }
-  console.error(``);
+
+  console.error("");
   process.exit(1);
 }

globals.d.ts

@@ -5,15 +5,15 @@
 
 interface Element {
   /**
-  * requestFullscreen() but available in Safari.
-  */
+   * requestFullscreen() but available in Safari.
+   */
   webkitRequestFullscreen?(): unknown;
 }
 
 interface Document {
   /**
-  * exitFullscreen() but available in Safari.
-  */
+   * exitFullscreen() but available in Safari.
+   */
   webkitExitFullscreen?(): unknown;
   /**
    * fullscreenElement but available in Safari.
@@ -26,25 +26,35 @@ interface Document {
  */
 declare class NDEFReader extends EventTarget {
   constructor();
-  scan(options?: {signal?: AbortSignal}): Promise<void>;
-  onreading?(event: Event & {message: NDEFMessage}): void;
+  scan(options?: { signal?: AbortSignal }): Promise<void>;
+  onreading?(event: Event & { message: NDEFMessage }): void;
   onreadingerror?(event: Event): void;
 }
 
-type TypedArray = Uint8Array | Int8Array | Uint16Array | Int16Array | Uint32Array | Int32Array | BigUint64Array | BigInt64Array;
+type TypedArray =
+  | Uint8Array
+  | Int8Array
+  | Uint16Array
+  | Int16Array
+  | Uint32Array
+  | Int32Array
+  | BigUint64Array
+  | BigInt64Array;
 
 /**
  * https://developer.mozilla.org/en-US/docs/Web/API/NDEFMessage/NDEFMessage
  */
 declare class NDEFMessage {
-  constructor(records: Array<{
-    data?: string | ArrayBuffer | TypedArray | DataView | NDEFRecord[],
-    encoding?: string;
-    id?: string;
-    lang?: string;
-    mediaType?: string;
-    recordType?: string;
-  }>);
+  constructor(
+    records: Array<{
+      data?: string | ArrayBuffer | TypedArray | DataView | NDEFRecord[];
+      encoding?: string;
+      id?: string;
+      lang?: string;
+      mediaType?: string;
+      recordType?: string;
+    }>
+  );
   readonly records: NDEFRecord[];
 }
 
@@ -68,7 +78,15 @@ interface NetworkInformation {
   effectiveType: string;
   rtt: number;
   saveData: boolean;
-  type: 'bluetooth' | 'cellular' | 'ethernet' | 'none' | 'wifi' | 'wimax' | 'other' | 'unknown';
+  type:
+    | "bluetooth"
+    | "cellular"
+    | "ethernet"
+    | "none"
+    | "wifi"
+    | "wimax"
+    | "other"
+    | "unknown";
 }
 
 interface Navigator {

images/CST1229/zip.svg

@@ -16,7 +16,7 @@
     "check-format": "prettier . --check",
     "upload-translations": "node development/upload-translations.js",
     "download-translations": "node development/download-translations.js",
-    "check-types": "tsc"
+    "generate-type-warnings": "node development/generate-type-warnings.js"
   },
   "repository": {
     "type": "git",