stay-gold 1.0.0 → 1.0.1

package/package.json

@@ -1,15 +1,38 @@
 {
   "name": "stay-gold",
-  "version": "1.0.0",
-  "description": "Checks and balances",
-  "main": "index.js",
+  "version": "1.0.1",
+  "description": "Checks and balances for code quality. Run as a dev dependency in any project.",
+  "main": "dist/index.js",
   "author": "Riley Bathurst <riley@rileybathurst.com> (https://rileybathurst.com)",
+  "files": [
+    "dist",
+    "named-colors.ts",
+    "README.md"
+  ],
+  "bin": {
+    "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"
+  },
   "scripts": {
-    "find": "node check-for-bang.ts",
-    "todos": "node check-todo.ts",
-    "variables": "node check-css-vars.ts",
-    "gold": "npm run find && npm run todos && npm run variables && echo 'All checks passed!' || echo 'Some checks failed!'"
+    "build": "tsc",
+    "find": "node dist/bang.js",
+    "todos": "node dist/todos.js",
+    "variables": "node dist/css-vars.js",
+    "named-colors": "node dist/css-named-colors.js",
+    "gold": "npm run find && npm run todos && npm run variables && npm run named-colors && echo 'All checks passed!' || echo 'Some checks failed!'"
   },
+  "keywords": [
+    "code-quality",
+    "lint",
+    "css",
+    "typescript",
+    "javascript",
+    "todos",
+    "variables",
+    "named-colors"
+  ],
   "license": "ISC",
   "devDependencies": {
     "@types/node": "^24.3.1",

package/bang.ts

@@ -1,51 +0,0 @@
-// check-for-bang.js
-// Script to check for the string "// !" in project files and exit with error if found
-
-import fs from "node:fs";
-import path from "node:path";
-
-const exts = [".js", ".ts", ".astro", ".css", ".tsx"];
-// Use CommonJS __dirname directly
-const rootDir = path.resolve(__dirname, "src");
-const publicDir = path.resolve(__dirname, "public");
-
-function walk(dir: string): string[] {
-  let results: string[] = [];
-  const list: string[] = fs.readdirSync(dir);
-  list.forEach((file: string) => {
-    const filePath: string = path.join(dir, file);
-    const stat: fs.Stats = fs.statSync(filePath);
-    if (stat?.isDirectory()) {
-      results = results.concat(walk(filePath));
-    } else if (exts.includes(path.extname(file))) {
-      results.push(filePath);
-    }
-  });
-  return results;
-}
-
-function checkFiles(files: string[]): boolean {
-  let found: boolean = false;
-  files.forEach((file: string) => {
-    const content: string = fs.readFileSync(file, "utf8");
-    if (
-      content.includes("// !") ||
-      content.includes("<!-- !") ||
-      content.includes("{/* !")
-    ) {
-      console.error(`Forbidden string found in: ${file}`);
-      found = true;
-    }
-  });
-  return found;
-}
-
-const srcFiles = walk(rootDir);
-const publicFiles = walk(publicDir);
-const allFiles = srcFiles.concat(publicFiles);
-
-if (checkFiles(allFiles)) {
-  process.exit(1);
-} else {
-  console.log("No forbidden string found.");
-}

package/css-named-colors.ts

@@ -1,45 +0,0 @@
-// 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 { namedColors } from "./named-colors.js";
-
-const __dirname = path.resolve();
-const stylesDir = path.resolve(__dirname, "src/styles");
-const exts = [".css"];
-
-// List of named CSS colors (partial, can be expanded)
-
-
-function walkCssFiles(dir: string): string[] {
-    return fs.readdirSync(dir)
-        .filter((f: string) => exts.includes(path.extname(f)))
-        .map((f: string) => path.join(dir, f));
-}
-
-function checkNamedColors(files: string[]): number {
-    let totalCount = 0;
-    files.forEach((file: string) => {
-        const content: string = fs.readFileSync(file, "utf8");
-        namedColors.forEach((color: string) => {
-        const regex = new RegExp(`\\b${color}\\b`, "gi");
-        const matches = content.match(regex);
-        if (matches && matches.length > 0) {
-            console.log(`Found ${matches.length} named color(s) '${color}' in: ${file}`);
-            totalCount += matches.length;
-        }
-        });
-    });
-    return totalCount;
-}
-
-const cssFiles = walkCssFiles(stylesDir);
-const namedColorCount = checkNamedColors(cssFiles);
-
-if (namedColorCount > 0) {
-    console.error(`Total named CSS colors found: ${namedColorCount}`);
-    process.exit(1);
-} else {
-    console.log("No named CSS colors found.");
-}

package/css-vars.ts

@@ -1,66 +0,0 @@
-// 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");
-
-function getDefinedVars(file: string): Set<string> {
-    const content: string = fs.readFileSync(file, "utf8");
-    const varRegex: RegExp = /--([\w-]+):/g;
-    const vars: Set<string> = new Set();
-    let match: RegExpExecArray | null = varRegex.exec(content);
-    while (match !== null) {
-        vars.add(match[1]);
-        match = varRegex.exec(content);
-    }
-    return vars;
-}
-
-function getUsedVars(file: string): Set<string> {
-    const content: string = fs.readFileSync(file, "utf8");
-    const useRegex: RegExp = /var\(--([\w-]+)\)/g;
-    const used: Set<string> = new Set();
-    let match: RegExpExecArray | null = useRegex.exec(content);
-    while (match !== null) {
-        used.add(match[1]);
-        match = useRegex.exec(content);
-    }
-    return used;
-}
-
-function walkCssFiles(dir: string): string[] {
-    return fs
-        .readdirSync(dir)
-        .filter((f: string) => f.endsWith(".css") && f !== "variables.css")
-        .map((f: string) => path.join(dir, f));
-}
-
-const definedVars = getDefinedVars(variablesFile);
-const cssFiles = walkCssFiles(stylesDir);
-let hasError = false;
-
-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)}`,
-        );
-        hasError = true;
-        }
-    });
-});
-
-if (hasError) {
-    process.exit(1);
-} else {
-    console.log("All CSS variables used are defined.");
-}

package/index.ts

@@ -1,4 +0,0 @@
-export * from "./bang.js";
-export * from "./css-named-colors.js";
-export * from "./css-vars.js";
-export * from "./todos.js";

package/todos.ts

@@ -1,52 +0,0 @@
-// check-todo.ts
-// Script to check for the string "TODO:" in project files and count occurrences
-
-import fs from "node:fs";
-import path from "node:path";
-
-const exts = [".js", ".ts", ".astro", ".css", ".tsx"];
-const mainFilename = require.main?.filename ?? __filename;
-const __dirname = path.dirname(mainFilename);
-const rootDir = path.resolve(__dirname, "src");
-const publicDir = path.resolve(__dirname, "public");
-
-function walk(dir: string): string[] {
-    let results: string[] = [];
-    const list: string[] = fs.readdirSync(dir);
-    list.forEach((file: string) => {
-        const filePath: string = path.join(dir, file);
-        const stat: fs.Stats = fs.statSync(filePath);
-        if (stat?.isDirectory()) {
-        results = results.concat(walk(filePath));
-        } else if (exts.includes(path.extname(file))) {
-        results.push(filePath);
-        }
-    });
-    return results;
-}
-
-function checkTodos(files: string[]): number {
-    let totalCount = 0;
-    files.forEach((file: string) => {
-        const content: string = fs.readFileSync(file, "utf8");
-        const matches = content.match(/TODO:/g);
-        if (matches && matches.length > 0) {
-        console.log(`Found ${matches.length} TODO(s) in: ${file}`);
-        totalCount += matches.length;
-        }
-    });
-    return totalCount;
-}
-
-const srcFiles = walk(rootDir);
-const publicFiles = walk(publicDir);
-const allFiles = srcFiles.concat(publicFiles);
-
-const todoCount = checkTodos(allFiles);
-
-if (todoCount > 0) {
-    console.warn(`Total TODOs found: ${todoCount}`);
-    process.exit(1);
-} else {
-    console.log("No TODOs found.");
-}

package/tsconfig.json

@@ -1,14 +0,0 @@
-{
-    "compilerOptions": {
-        "target": "ES2019",
-        "module": "NodeNext",
-        "declaration": true,
-        "outDir": "dist",
-        "moduleResolution": "nodenext",
-        "strict": true,
-        "esModuleInterop": true,
-    "skipLibCheck": true,
-    "types": ["node"]
-    },
-    "include": ["*.ts"]
-}