filegrc 0.3.2 → 0.3.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "filegrc",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Zero-dependency Git-native GRC engine",
   "license": "MIT",
   "repository": {

package/src/build.js

@@ -1,6 +1,6 @@
 import { mkdir, writeFile } from "node:fs/promises";
 import { join } from "node:path";
-import { FAVICON_PNG } from "./favicon.js";
+import { FAVICON_PNG, LOGO_MARK_PNG } from "./favicon.js";
 import { resolveWorkspacePath, resolveWorkspaceRoot } from "./paths.js";
 import { createAppState } from "./state.js";
 import { APP_SCRIPT, APP_STYLES, renderIndex } from "./web.js";
@@ -12,6 +12,7 @@ export async function buildWorkspace(input = process.cwd(), options = {}) {
   const paths = {
     html: resolveWorkspacePath(root, join(outputOption, "index.html")),
     favicon: resolveWorkspacePath(root, join(outputOption, "favicon.png")),
+    logoMark: resolveWorkspacePath(root, join(outputOption, "logo-mark-white.png")),
     script: resolveWorkspacePath(root, join(outputOption, "filegrc-app.js")),
     styles: resolveWorkspacePath(root, join(outputOption, "filegrc.css"))
   };
@@ -20,6 +21,7 @@ export async function buildWorkspace(input = process.cwd(), options = {}) {
   await Promise.all([
     writeFile(paths.html, renderIndex(state), "utf8"),
     writeFile(paths.favicon, FAVICON_PNG),
+    writeFile(paths.logoMark, LOGO_MARK_PNG),
     writeFile(paths.script, APP_SCRIPT, "utf8"),
     writeFile(paths.styles, APP_STYLES, "utf8")
   ]);

package/src/cli.js

@@ -29,6 +29,7 @@ import { markdownEntries } from "./resource-markdown.js";
 import { searchResources } from "./search.js";
 import { serveWorkspace } from "./server.js";
 import { planWorkspaceSetup, setupWorkspace, summarizeSetupResult } from "./setup.js";
+import { printGithubStarMessage } from "./startup.js";
 import { createAppState } from "./state.js";
 import { currentCalendarDate } from "./time.js";
 import { validateWorkspace } from "./validate.js";
@@ -64,13 +65,19 @@ export async function runCli(argv = process.argv.slice(2)) {
       host: flags.host ?? process.env.FILEGRC_HOST,
       port: flags.port ?? process.env.FILEGRC_PORT
     });
-    console.log(`filegrc workspace: ${result.url}`);
-    console.log(`Data: ${result.root}/data`);
-    return await new Promise((resolvePromise) => {
-      const stop = () => result.server.close(resolvePromise);
+    const stopped = new Promise((resolvePromise) => {
+      const stop = () => {
+        process.removeListener("SIGINT", stop);
+        process.removeListener("SIGTERM", stop);
+        result.server.close(resolvePromise);
+      };
       process.once("SIGINT", stop);
       process.once("SIGTERM", stop);
     });
+    console.log(`filegrc workspace: ${result.url}`);
+    console.log(`Data: ${result.root}/data`);
+    printGithubStarMessage();
+    return await stopped;
   }
   if (command === "setup") {
     const payload = positionals[0] ? await readSetupPayload(positionals[0]) : {};

package/src/favicon.js

@@ -1,109 +1,4 @@
-import { deflateSync } from "node:zlib";
+import { readFileSync } from "node:fs";
 
-const SIZE = 64;
-const WHITE = [248, 249, 255, 255];
-
-export const FAVICON_PNG = createFavicon();
-
-function createFavicon() {
-  const pixels = Buffer.alloc(SIZE * SIZE * 4);
-
-  for (let y = 0; y < SIZE; y += 1) {
-    for (let x = 0; x < SIZE; x += 1) {
-      if (!insideRoundedSquare(x, y, 11)) continue;
-      setPixel(pixels, x, y, backgroundColor(x, y));
-    }
-  }
-
-  drawStroke(pixels, [
-    [18, 8],
-    [39, 8],
-    [51, 20],
-    [51, 50],
-    [50, 53],
-    [47, 55],
-    [17, 55],
-    [14, 54],
-    [12, 51],
-    [12, 13],
-    [14, 10],
-    [18, 8]
-  ], 2.3, WHITE);
-  drawStroke(pixels, [[39, 8], [39, 20], [51, 20]], 2.3, WHITE);
-
-  const rows = Buffer.alloc((SIZE * 4 + 1) * SIZE);
-  for (let y = 0; y < SIZE; y += 1) {
-    const rowOffset = y * (SIZE * 4 + 1);
-    rows[rowOffset] = 0;
-    pixels.copy(rows, rowOffset + 1, y * SIZE * 4, (y + 1) * SIZE * 4);
-  }
-
-  const header = Buffer.alloc(13);
-  header.writeUInt32BE(SIZE, 0);
-  header.writeUInt32BE(SIZE, 4);
-  header.set([8, 6, 0, 0, 0], 8);
-
-  return Buffer.concat([
-    Buffer.from([137, 80, 78, 71, 13, 10, 26, 10]),
-    pngChunk("IHDR", header),
-    pngChunk("IDAT", deflateSync(rows)),
-    pngChunk("IEND", Buffer.alloc(0))
-  ]);
-}
-
-function insideRoundedSquare(x, y, radius) {
-  const cornerX = x < radius ? radius - 1 : x >= SIZE - radius ? SIZE - radius : x;
-  const cornerY = y < radius ? radius - 1 : y >= SIZE - radius ? SIZE - radius : y;
-  return Math.hypot(x - cornerX, y - cornerY) <= radius;
-}
-
-function backgroundColor(x, y) {
-  const progress = Math.min(1, (x + y) / ((SIZE - 1) * 1.2));
-  return [0, 0, Math.round(112 + (53 - 112) * progress), 255];
-}
-
-function drawStroke(pixels, points, radius, color) {
-  for (let y = 0; y < SIZE; y += 1) {
-    for (let x = 0; x < SIZE; x += 1) {
-      const onStroke = points.slice(1).some((point, index) => (
-        distanceToSegment(x, y, points[index], point) <= radius
-      ));
-      if (onStroke) setPixel(pixels, x, y, color);
-    }
-  }
-}
-
-function distanceToSegment(x, y, start, end) {
-  const dx = end[0] - start[0];
-  const dy = end[1] - start[1];
-  const lengthSquared = dx * dx + dy * dy;
-  const progress = lengthSquared
-    ? Math.max(0, Math.min(1, ((x - start[0]) * dx + (y - start[1]) * dy) / lengthSquared))
-    : 0;
-  return Math.hypot(x - (start[0] + progress * dx), y - (start[1] + progress * dy));
-}
-
-function setPixel(pixels, x, y, color) {
-  pixels.set(color, (y * SIZE + x) * 4);
-}
-
-function pngChunk(type, data) {
-  const typeBuffer = Buffer.from(type, "ascii");
-  const chunk = Buffer.alloc(data.length + 12);
-  chunk.writeUInt32BE(data.length, 0);
-  typeBuffer.copy(chunk, 4);
-  data.copy(chunk, 8);
-  chunk.writeUInt32BE(crc32(Buffer.concat([typeBuffer, data])), data.length + 8);
-  return chunk;
-}
-
-function crc32(buffer) {
-  let value = 0xffffffff;
-  for (const byte of buffer) {
-    value ^= byte;
-    for (let bit = 0; bit < 8; bit += 1) {
-      value = (value >>> 1) ^ (value & 1 ? 0xedb88320 : 0);
-    }
-  }
-  return (value ^ 0xffffffff) >>> 0;
-}
+export const FAVICON_PNG = readFileSync(new URL("./favicon.png", import.meta.url));
+export const LOGO_MARK_PNG = readFileSync(new URL("./logo-mark-white.png", import.meta.url));

package/src/server.js

@@ -5,7 +5,7 @@ import { getResourceDefinition } from "../model/index.js";
 import { prepareAuditWorkspace } from "./audit-preparation.js";
 import { generateEvidencePacket, prepareEvidencePacket } from "./evidence-packet.js";
 import { ensureEvidenceTestDrafts } from "./evidence-tests.js";
-import { FAVICON_PNG } from "./favicon.js";
+import { FAVICON_PNG, LOGO_MARK_PNG } from "./favicon.js";
 import { createResource, deleteResource, updateContent, updateResource } from "./files.js";
 import { commitAndPushWorkspace, getFileHistory, pullWorkspace, pushWorkspace } from "./git.js";
 import { completeObligationOccurrence, createObligationEvent, planObligations } from "./obligations.js";
@@ -137,6 +137,7 @@ export function createFilegrcServer(input = process.cwd(), options = {}) {
         }
       }
       if (request.method === "GET" && url.pathname === "/favicon.png") return text(response, 200, FAVICON_PNG, "image/png");
+      if (request.method === "GET" && url.pathname === "/logo-mark-white.png") return text(response, 200, LOGO_MARK_PNG, "image/png");
       if (request.method === "GET" && url.pathname === "/filegrc-app.js") return text(response, 200, APP_SCRIPT, "text/javascript; charset=utf-8");
       if (request.method === "GET" && url.pathname === "/filegrc.css") return text(response, 200, APP_STYLES, "text/css; charset=utf-8");
       if (request.method === "GET" && url.pathname.startsWith("/packet/")) {

package/src/startup.js

@@ -0,0 +1,5 @@
+const GITHUB_STAR_MESSAGE = "\n\x1b[38;2;255;184;0m⭐️  → ❤️  https://github.com/Sunpeak-AI/filegrc\x1b[0m\n";
+
+export function printGithubStarMessage() {
+  console.log(GITHUB_STAR_MESSAGE);
+}

package/src/web.js

@@ -174,7 +174,7 @@ function buildNavigation(route) {
   const organizationCurrent = route.name === "organization" || route.name === "repository" || ["workspace", "renderer-settings"].includes(route.type);
   const organizationName = state.workspace.organizationName || "Organization";
   const initial = organizationName.trim().charAt(0).toUpperCase() || "O";
-  return '<aside class="sidebar" id="sidebar-navigation"><button class="nav-close" type="button" aria-label="Close navigation">×</button><a href="#/" class="brand"' + (route.name === "home" ? ' aria-current="page"' : "") + '><img class="mark" src="./favicon.png" alt="" width="39" height="39"><span><strong>filegrc</strong><small>SOC 2 workspace</small></span></a><nav class="sidebar-nav">' + stages + '</nav><div class="sidebar-footer"><a class="organization-nav ' + (organizationCurrent ? "current" : "") + '" href="#/organization"><span class="organization-mark">' + esc(initial) + '</span><span><strong>' + esc(organizationName) + '</strong><small>Organization</small></span><span class="organization-arrow">›</span></a></div></aside><button class="nav-scrim" type="button" aria-label="Close navigation"></button>';
+  return '<aside class="sidebar" id="sidebar-navigation"><button class="nav-close" type="button" aria-label="Close navigation">×</button><a href="#/" class="brand"' + (route.name === "home" ? ' aria-current="page"' : "") + '><img class="mark" src="./logo-mark-white.png" alt="" width="39" height="39"><span><strong>filegrc</strong><small>SOC 2 workspace</small></span></a><nav class="sidebar-nav">' + stages + '</nav><div class="sidebar-footer"><a class="organization-nav ' + (organizationCurrent ? "current" : "") + '" href="#/organization"><span class="organization-mark">' + esc(initial) + '</span><span><strong>' + esc(organizationName) + '</strong><small>Organization</small></span><span class="organization-arrow">›</span></a></div></aside><button class="nav-scrim" type="button" aria-label="Close navigation"></button>';
 }
 
 function readinessStageForRoute(route) {