stay-gold 1.0.3 → 1.1.0

package/dist/bang.js

@@ -1,29 +1,12 @@
 #!/usr/bin/env node
 // check-for-bang.js
 // Script to check for the string "// !" in project files and exit with error if found
-import { readdirSync, statSync, readFileSync } from "node:fs";
-import { resolve, join, extname, dirname } from "node:path";
-import { fileURLToPath } from "node:url";
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = dirname(__filename);
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { walk } from "./walk.js";
 const exts = [".js", ".ts", ".astro", ".css", ".tsx"];
 const rootDir = resolve(process.cwd(), "src");
 const publicDir = resolve(process.cwd(), "public");
-function walk(dir) {
-    let results = [];
-    const list = readdirSync(dir);
-    list.forEach((file) => {
-        const filePath = join(dir, file);
-        const stat = statSync(filePath);
-        if (stat === null || stat === void 0 ? void 0 : stat.isDirectory()) {
-            results = results.concat(walk(filePath));
-        }
-        else if (exts.includes(extname(file))) {
-            results.push(filePath);
-        }
-    });
-    return results;
-}
 function checkFiles(files) {
     let found = false;
     files.forEach((file) => {
@@ -37,8 +20,8 @@ function checkFiles(files) {
     });
     return found;
 }
-const srcFiles = walk(rootDir);
-const publicFiles = walk(publicDir);
+const srcFiles = walk(rootDir, exts);
+const publicFiles = walk(publicDir, exts);
 const allFiles = srcFiles.concat(publicFiles);
 if (checkFiles(allFiles)) {
     process.exit(1);

package/dist/css-named-colors.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/dist/css-named-colors.js

@@ -1,21 +1,20 @@
+#!/usr/bin/env node
 // check-css-named-colors.ts
 // Script to check for usage of named CSS colors in styles folder
-import fs from "node:fs";
-import path from "node:path";
+import { readFileSync, readdirSync } from "node:fs";
+import { resolve, join, extname } from "node:path";
 import { namedColors } from "./named-colors.js";
-const __dirname = path.resolve();
-const stylesDir = path.resolve(__dirname, "src/styles");
+const stylesDir = resolve(process.cwd(), "src/styles");
 const exts = [".css"];
-// List of named CSS colors (partial, can be expanded)
 function walkCssFiles(dir) {
-    return fs.readdirSync(dir)
-        .filter((f) => exts.includes(path.extname(f)))
-        .map((f) => path.join(dir, f));
+    return readdirSync(dir)
+        .filter((f) => exts.includes(extname(f)))
+        .map((f) => join(dir, f));
 }
 function checkNamedColors(files) {
     let totalCount = 0;
     files.forEach((file) => {
-        const content = fs.readFileSync(file, "utf8");
+        const content = readFileSync(file, "utf8");
         namedColors.forEach((color) => {
             const regex = new RegExp(`\\b${color}\\b`, "gi");
             const matches = content.match(regex);

package/dist/css-vars.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/dist/css-vars.js

@@ -1,16 +1,12 @@
+#!/usr/bin/env node
 // check-css-vars.ts
 // Script to check for usage of undefined CSS variables in styles folder
-import fs from "node:fs";
-import path from "node:path";
-// Use CommonJS __dirname directly
-if (!require.main || !require.main.filename) {
-    throw new Error("Cannot determine __dirname: require.main or require.main.filename is undefined.");
-}
-const __dirname = path.dirname(require.main.filename);
-const stylesDir = path.resolve(__dirname, "src/styles");
-const variablesFile = path.join(stylesDir, "variables.css");
+import { readFileSync, readdirSync } from "node:fs";
+import { resolve, join, basename } from "node:path";
+const stylesDir = resolve(process.cwd(), "src/styles");
+const variablesFile = join(stylesDir, "variables.css");
 function getDefinedVars(file) {
-    const content = fs.readFileSync(file, "utf8");
+    const content = readFileSync(file, "utf8");
     const varRegex = /--([\w-]+):/g;
     const vars = new Set();
     let match = varRegex.exec(content);
@@ -21,7 +17,7 @@ function getDefinedVars(file) {
     return vars;
 }
 function getUsedVars(file) {
-    const content = fs.readFileSync(file, "utf8");
+    const content = readFileSync(file, "utf8");
     const useRegex = /var\(--([\w-]+)\)/g;
     const used = new Set();
     let match = useRegex.exec(content);
@@ -32,10 +28,9 @@ function getUsedVars(file) {
     return used;
 }
 function walkCssFiles(dir) {
-    return fs
-        .readdirSync(dir)
+    return readdirSync(dir)
         .filter((f) => f.endsWith(".css") && f !== "variables.css")
-        .map((f) => path.join(dir, f));
+        .map((f) => join(dir, f));
 }
 const definedVars = getDefinedVars(variablesFile);
 const cssFiles = walkCssFiles(stylesDir);
@@ -44,7 +39,7 @@ cssFiles.forEach((file) => {
     const usedVars = getUsedVars(file);
     usedVars.forEach((v) => {
         if (!definedVars.has(v)) {
-            console.error(`Undefined CSS variable --${v} used in ${path.basename(file)}`);
+            console.error(`Undefined CSS variable --${v} used in ${basename(file)}`);
             hasError = true;
         }
     });

package/dist/index.d.ts

@@ -1,4 +1,2 @@
-export * from "./bang.js";
-export * from "./css-named-colors.js";
-export * from "./css-vars.js";
-export * from "./todos.js";
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -1,4 +1,52 @@
-export * from "./bang.js";
-export * from "./css-named-colors.js";
-export * from "./css-vars.js";
-export * from "./todos.js";
+#!/usr/bin/env node
+// index.ts
+// Main script to run all stay-gold checks in sequence
+import { spawn } from "node:child_process";
+const checks = [
+    { name: "Bang Check", script: "./dist/bang.js" },
+    { name: "TODO Check", script: "./dist/todos.js" },
+    { name: "CSS Variables Check", script: "./dist/css-vars.js" },
+    { name: "CSS Named Colors Check", script: "./dist/css-named-colors.js" }
+];
+async function runCheck(script, name) {
+    return new Promise((resolve) => {
+        console.log(`\n--- Running ${name} ---`);
+        const child = spawn("node", [script], {
+            stdio: "inherit",
+            cwd: process.cwd()
+        });
+        child.on("close", (code) => {
+            if (code === 0) {
+                console.log(`✅ ${name} passed`);
+                resolve(true);
+            }
+            else {
+                console.log(`❌ ${name} failed`);
+                resolve(false);
+            }
+        });
+    });
+}
+async function runAllChecks() {
+    console.log("🚀 Running all Stay Gold checks...\n");
+    let allPassed = true;
+    for (const check of checks) {
+        const passed = await runCheck(check.script, check.name);
+        if (!passed) {
+            allPassed = false;
+        }
+    }
+    console.log("\n" + "=".repeat(50));
+    if (allPassed) {
+        console.log("🎉 All checks passed! Your code stays gold! ✨");
+        process.exit(0);
+    }
+    else {
+        console.log("💥 Some checks failed. Please fix the issues above.");
+        process.exit(1);
+    }
+}
+runAllChecks().catch((error) => {
+    console.error("Error running checks:", error);
+    process.exit(1);
+});

package/dist/stay-gold.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/stay-gold.test.js

@@ -0,0 +1,305 @@
+import { describe, it, expect, beforeAll, afterAll } from "vitest";
+import { execSync } from "node:child_process";
+import { mkdirSync, writeFileSync, rmSync, existsSync } from "node:fs";
+import { join } from "node:path";
+describe("stay-gold command", () => {
+    const testDir = join(process.cwd(), "test-project");
+    const srcDir = join(testDir, "src");
+    const publicDir = join(testDir, "public");
+    const stylesDir = join(srcDir, "styles");
+    beforeAll(() => {
+        // Create test project structure
+        if (existsSync(testDir)) {
+            rmSync(testDir, { recursive: true, force: true });
+        }
+        mkdirSync(srcDir, { recursive: true });
+        mkdirSync(publicDir, { recursive: true });
+        mkdirSync(stylesDir, { recursive: true });
+        // Create clean test files
+        writeFileSync(join(srcDir, "clean.ts"), "// This is a clean file\nconst x = 1;\n");
+        writeFileSync(join(stylesDir, "variables.css"), ":root {\n  --primary: #000;\n  --secondary: #fff;\n}\n");
+        writeFileSync(join(stylesDir, "styles.css"), ".test { color: var(--primary); }\n");
+        // Build the project to ensure dist exists
+        try {
+            execSync("npm run build", { cwd: process.cwd(), stdio: "pipe" });
+        }
+        catch (error) {
+            console.error("Build failed:", error);
+        }
+    });
+    afterAll(() => {
+        // Cleanup test directory
+        if (existsSync(testDir)) {
+            rmSync(testDir, { recursive: true, force: true });
+        }
+    });
+    describe("1. Command runs successfully without errors", () => {
+        it("should execute without throwing errors on clean project", () => {
+            expect(() => {
+                execSync("npm run find", {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+            }).not.toThrow();
+        });
+        it("should execute todos checker without errors", () => {
+            expect(() => {
+                execSync("npm run todos", {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+            }).not.toThrow();
+        });
+        it("should execute variables checker without errors on valid CSS", () => {
+            expect(() => {
+                execSync("npm run variables", {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+            }).not.toThrow();
+        });
+        it("should execute named-colors checker without errors", () => {
+            expect(() => {
+                execSync("npm run named-colors", {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+            }).not.toThrow();
+        });
+        it("should run all checks via gold command on clean project", () => {
+            const result = execSync("npm run gold", {
+                cwd: testDir,
+                stdio: "pipe",
+                encoding: "utf-8",
+            });
+            expect(result).toBeDefined();
+        });
+    });
+    describe("2. Command correctly executes all sub-commands", () => {
+        it("should detect forbidden bang comments", () => {
+            var _a, _b;
+            writeFileSync(join(srcDir, "with-bang.ts"), "// ! This should be detected\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+                expect.fail("Should have exited with error code 1");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+                const stderr = ((_a = error.stderr) === null || _a === void 0 ? void 0 : _a.toString()) || "";
+                const stdout = ((_b = error.stdout) === null || _b === void 0 ? void 0 : _b.toString()) || "";
+                const output = stderr + stdout;
+                expect(output).toContain("Forbidden string found");
+            }
+            finally {
+                // Cleanup
+                rmSync(join(srcDir, "with-bang.ts"), { force: true });
+            }
+        });
+        it("should detect and count TODO comments", () => {
+            writeFileSync(join(srcDir, "with-todo.ts"), "// TODO: Fix this later\nconst x = 1;\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/todos.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+                expect.fail("Should have exited with error code 1");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+                expect(error.stdout.toString()).toContain("TODO(s) in");
+                expect(error.stderr.toString()).toContain("Total TODOs found: 1");
+            }
+            finally {
+                // Cleanup
+                rmSync(join(srcDir, "with-todo.ts"), { force: true });
+            }
+        });
+        it("should detect undefined CSS variables", () => {
+            writeFileSync(join(stylesDir, "bad-vars.css"), ".test { color: var(--undefined-var); }\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/css-vars.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+                expect.fail("Should have exited with error code 1");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+                expect(error.stderr.toString()).toContain("Undefined CSS variable");
+                expect(error.stderr.toString()).toContain("undefined-var");
+            }
+            finally {
+                // Cleanup
+                rmSync(join(stylesDir, "bad-vars.css"), { force: true });
+            }
+        });
+        it("should detect named CSS colors", () => {
+            writeFileSync(join(stylesDir, "named-colors.css"), ".test { color: red; background: blue; }\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/css-named-colors.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+                expect.fail("Should have exited with error code 1");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+                expect(error.stdout.toString()).toContain("named color");
+                expect(error.stderr.toString()).toContain("Total named CSS colors");
+            }
+            finally {
+                // Cleanup
+                rmSync(join(stylesDir, "named-colors.css"), { force: true });
+            }
+        });
+        it("should pass all checks when project is clean", () => {
+            const output = execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                cwd: testDir,
+                stdio: "pipe",
+                encoding: "utf-8",
+            });
+            expect(output).toContain("No forbidden string found");
+        });
+    });
+    describe("3. Command handles various input arguments or flags", () => {
+        it("should handle execution from different working directories", () => {
+            const output = execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                cwd: testDir,
+                stdio: "pipe",
+                encoding: "utf-8",
+            });
+            expect(output).toBeDefined();
+        });
+        it("should work when called via npm bin script", () => {
+            const output = execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                cwd: testDir,
+                stdio: "pipe",
+                encoding: "utf-8",
+            });
+            expect(output).toContain("No forbidden string found");
+        });
+        it("should handle projects with no src directory gracefully", () => {
+            const emptyTestDir = join(process.cwd(), "test-empty");
+            mkdirSync(emptyTestDir, { recursive: true });
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: emptyTestDir,
+                    stdio: "pipe",
+                    encoding: "utf-8",
+                });
+            }
+            catch (error) {
+                // Should handle missing directories
+                expect(error).toBeDefined();
+            }
+            finally {
+                rmSync(emptyTestDir, { recursive: true, force: true });
+            }
+        });
+        it("should process multiple file types correctly", () => {
+            // Create files with different extensions
+            writeFileSync(join(srcDir, "test.js"), "const x = 1;\n");
+            writeFileSync(join(srcDir, "test.ts"), "const x: number = 1;\n");
+            writeFileSync(join(srcDir, "test.tsx"), "const x = <div />;\n");
+            writeFileSync(join(srcDir, "test.astro"), "---\nconst x = 1;\n---\n");
+            const output = execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                cwd: testDir,
+                stdio: "pipe",
+                encoding: "utf-8",
+            });
+            expect(output).toContain("No forbidden string found");
+            // Cleanup
+            rmSync(join(srcDir, "test.js"), { force: true });
+            rmSync(join(srcDir, "test.ts"), { force: true });
+            rmSync(join(srcDir, "test.tsx"), { force: true });
+            rmSync(join(srcDir, "test.astro"), { force: true });
+        });
+        it("should handle all comment styles for bang detection", () => {
+            // Test JavaScript style
+            writeFileSync(join(srcDir, "js-bang.js"), "// ! Error\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                });
+                expect.fail("Should detect // ! style");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+            }
+            finally {
+                rmSync(join(srcDir, "js-bang.js"), { force: true });
+            }
+            // Test HTML style
+            writeFileSync(join(srcDir, "html-bang.astro"), "<!-- ! Error -->\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                });
+                expect.fail("Should detect <!-- ! style");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+            }
+            finally {
+                rmSync(join(srcDir, "html-bang.astro"), { force: true });
+            }
+            // Test JSX style
+            writeFileSync(join(srcDir, "jsx-bang.tsx"), "{/* ! Error */}\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                });
+                expect.fail("Should detect {/* ! style");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+            }
+            finally {
+                rmSync(join(srcDir, "jsx-bang.tsx"), { force: true });
+            }
+        });
+        it("should exit with proper exit codes", () => {
+            // Test success exit code
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                });
+                // If no error thrown, exit code was 0 (success)
+                expect(true).toBe(true);
+            }
+            catch (error) {
+                expect.fail("Should exit with code 0 on clean project");
+            }
+            // Test failure exit code
+            writeFileSync(join(srcDir, "fail.ts"), "// ! Error\n");
+            try {
+                execSync(`node ${join(process.cwd(), "dist/bang.js")}`, {
+                    cwd: testDir,
+                    stdio: "pipe",
+                });
+                expect.fail("Should exit with code 1 on violations");
+            }
+            catch (error) {
+                expect(error.status).toBe(1);
+            }
+            finally {
+                rmSync(join(srcDir, "fail.ts"), { force: true });
+            }
+        });
+    });
+});

package/dist/todos.d.ts

@@ -1 +1,2 @@
+#!/usr/bin/env node
 export {};

package/dist/todos.js

@@ -1,32 +1,16 @@
+#!/usr/bin/env node
 // check-todo.ts
 // Script to check for the string "TODO:" in project files and count occurrences
-var _a, _b;
-import fs from "node:fs";
-import path from "node:path";
+import { readFileSync } from "node:fs";
+import { resolve } from "node:path";
+import { walk } from "./walk.js";
 const exts = [".js", ".ts", ".astro", ".css", ".tsx"];
-const mainFilename = (_b = (_a = require.main) === null || _a === void 0 ? void 0 : _a.filename) !== null && _b !== void 0 ? _b : __filename;
-const __dirname = path.dirname(mainFilename);
-const rootDir = path.resolve(__dirname, "src");
-const publicDir = path.resolve(__dirname, "public");
-function walk(dir) {
-    let results = [];
-    const list = fs.readdirSync(dir);
-    list.forEach((file) => {
-        const filePath = path.join(dir, file);
-        const stat = fs.statSync(filePath);
-        if (stat === null || stat === void 0 ? void 0 : stat.isDirectory()) {
-            results = results.concat(walk(filePath));
-        }
-        else if (exts.includes(path.extname(file))) {
-            results.push(filePath);
-        }
-    });
-    return results;
-}
+const rootDir = resolve(process.cwd(), "src");
+const publicDir = resolve(process.cwd(), "public");
 function checkTodos(files) {
     let totalCount = 0;
     files.forEach((file) => {
-        const content = fs.readFileSync(file, "utf8");
+        const content = readFileSync(file, "utf8");
         const matches = content.match(/TODO:/g);
         if (matches && matches.length > 0) {
             console.log(`Found ${matches.length} TODO(s) in: ${file}`);
@@ -35,8 +19,8 @@ function checkTodos(files) {
     });
     return totalCount;
 }
-const srcFiles = walk(rootDir);
-const publicFiles = walk(publicDir);
+const srcFiles = walk(rootDir, exts);
+const publicFiles = walk(publicDir, exts);
 const allFiles = srcFiles.concat(publicFiles);
 const todoCount = checkTodos(allFiles);
 if (todoCount > 0) {

package/dist/vitest.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/dist/vitest.config.js

@@ -0,0 +1,9 @@
+import { defineConfig } from "vitest/config";
+export default defineConfig({
+    test: {
+        globals: true,
+        environment: "node",
+        testTimeout: 30000,
+        hookTimeout: 30000,
+    },
+});

package/dist/walk.d.ts

@@ -0,0 +1,2 @@
+declare function walk(dir: string, exts: string[]): string[];
+export { walk };

package/dist/walk.js

@@ -0,0 +1,18 @@
+import { readdirSync, statSync } from "node:fs";
+import { extname, join } from "node:path";
+function walk(dir, exts) {
+    let results = [];
+    const list = readdirSync(dir);
+    list.forEach((file) => {
+        const filePath = join(dir, file);
+        const stat = statSync(filePath);
+        if (stat === null || stat === void 0 ? void 0 : stat.isDirectory()) {
+            results = results.concat(walk(filePath, exts));
+        }
+        else if (exts.includes(extname(file))) {
+            results.push(filePath);
+        }
+    });
+    return results;
+}
+export { walk };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stay-gold",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "type": "module",
   "description": "Checks and balances for code quality. Run as a dev dependency in any project.",
   "main": "dist/index.js",
@@ -14,10 +14,13 @@
     "stay-gold-find": "dist/bang.js",
     "stay-gold-todos": "dist/todos.js",
     "stay-gold-css-vars": "dist/css-vars.js",
-    "stay-gold-css-named-colors": "dist/css-named-colors.js"
+    "stay-gold-css-named-colors": "dist/css-named-colors.js",
+    "stay-gold": "dist/index.js"
   },
   "scripts": {
     "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "find": "node dist/bang.js",
     "todos": "node dist/todos.js",
     "variables": "node dist/css-vars.js",
@@ -37,7 +40,9 @@
   "license": "ISC",
   "devDependencies": {
     "@types/node": "^24.3.1",
+    "@vitest/ui": "^4.0.5",
+    "string-checker": "latest",
     "typescript": "^5.9.2",
-    "string-checker": "latest"
+    "vitest": "^4.0.5"
   }
 }