tidepool 1.0.1 → 1.0.3

package/.github/workflows/eslint.yml

@@ -0,0 +1,50 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# ESLint is a tool for identifying and reporting on patterns
+# found in ECMAScript/JavaScript code.
+# More details at https://github.com/eslint/eslint
+# and https://eslint.org
+
+name: ESLint
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '21 0 * * 3'
+
+jobs:
+  eslint:
+    name: Run eslint scanning
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+      actions: read # only required for a private repository by github/codeql-action/upload-sarif to get the Action run status
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install ESLint
+        run: |
+          npm install eslint@8.10.0
+          npm install @microsoft/eslint-formatter-sarif@2.1.7
+
+      - name: Run ESLint
+        run: npx eslint .
+          --config .eslintrc.js
+          --ext .js,.jsx,.ts,.tsx
+          --format @microsoft/eslint-formatter-sarif
+          --output-file eslint-results.sarif
+        continue-on-error: true
+
+      - name: Upload analysis results to GitHub
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: eslint-results.sarif
+          wait-for-processing: true

package/dist/objects/box.js

@@ -49,7 +49,7 @@ class Box {
                 }
             }
         }
-        for (let content of this.contents) {
+        for (const content of this.contents) {
             content.draw(screen, this.x + 1, this.y + 1, this.width - 2);
         }
     }

package/dist/screen.d.ts

@@ -7,14 +7,18 @@ export declare class TideScreen {
     components: TideObject[];
     fps: number | null;
     updateFunction: (() => void) | null;
-    constructor(width: number, height: number);
+    backgroundColor: string;
+    constructor(width: number, height: number, backgroundColor?: string);
     clearScreen(): void;
     clearBuffer(): void;
     addComponent(component: TideObject): void;
-    renderBuffer(): void;
-    render(): void;
+    private getBackgroundColorCode;
+    private renderBuffer;
+    applyBackgroundColor(): void;
+    private render;
     setUpdateFunction(fn: () => void): void;
     setFPS(fps: number): void;
+    nextFrame(): void;
     renderCycle(): void;
 }
 //# sourceMappingURL=screen.d.ts.map

package/dist/screen.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../src/screen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,UAAU;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnB,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC1B,cAAc,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAQ;gBAE/B,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAQzC,WAAW;IAIX,WAAW;IAIX,YAAY,CAAC,SAAS,EAAE,UAAU;IAIlC,YAAY;IAMZ,MAAM;IAMN,iBAAiB,CAAC,EAAE,EAAE,MAAM,IAAI;IAIhC,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,WAAW;CAkBd"}
+{"version":3,"file":"screen.d.ts","sourceRoot":"","sources":["../src/screen.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,qBAAa,UAAU;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnB,MAAM,EAAE,MAAM,EAAE,EAAE,CAAC;IACnB,UAAU,EAAE,UAAU,EAAE,CAAC;IACzB,GAAG,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC1B,cAAc,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,CAAQ;IAC3C,eAAe,EAAE,MAAM,CAAC;gBAEZ,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,eAAe,GAAE,MAAsB;IASlF,WAAW;IAIX,WAAW;IAIX,YAAY,CAAC,SAAS,EAAE,UAAU;IAIlC,OAAO,CAAC,sBAAsB;IAgB9B,OAAO,CAAC,YAAY;IAMpB,oBAAoB;IAUpB,OAAO,CAAC,MAAM;IAOd,iBAAiB,CAAC,EAAE,EAAE,MAAM,IAAI;IAIhC,MAAM,CAAC,GAAG,EAAE,MAAM;IAIlB,SAAS;IAQT,WAAW;CAkBd"}

package/dist/screen.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TideScreen = void 0;
 class TideScreen {
-    constructor(width, height) {
+    constructor(width, height, backgroundColor = 'transparent') {
         this.fps = null;
         this.updateFunction = null;
         this.width = width;
@@ -10,6 +10,7 @@ class TideScreen {
         this.screen = Array.from({ length: height }, () => Array(width).fill(' '));
         this.buffer = Array.from({ length: height }, () => Array(width).fill(' '));
         this.components = [];
+        this.backgroundColor = backgroundColor;
     }
     clearScreen() {
         this.screen = Array.from({ length: this.height }, () => Array(this.width).fill(' '));
@@ -20,12 +21,36 @@ class TideScreen {
     addComponent(component) {
         this.components.push(component);
     }
+    getBackgroundColorCode(color) {
+        const colors = {
+            black: '\x1b[40m',
+            red: '\x1b[41m',
+            green: '\x1b[42m',
+            yellow: '\x1b[43m',
+            blue: '\x1b[44m',
+            magenta: '\x1b[45m',
+            cyan: '\x1b[46m',
+            white: '\x1b[47m',
+            transparent: '\x1b[49m',
+        };
+        return colors[color.toLowerCase()] || colors['black'];
+    }
     renderBuffer() {
         this.clearBuffer();
         this.components.sort((a, b) => b.zIndex - a.zIndex);
         this.components.forEach(component => component.draw(this.buffer));
     }
+    applyBackgroundColor() {
+        const bgColorCode = this.getBackgroundColorCode(this.backgroundColor);
+        const resetCode = '\x1b[0m';
+        for (let i = 0; i < this.height; i++) {
+            for (let j = 0; j < this.width; j++) {
+                this.buffer[i][j] = `${bgColorCode}${this.buffer[i][j] || ' '}${resetCode}`;
+            }
+        }
+    }
     render() {
+        this.applyBackgroundColor();
         console.clear();
         const output = this.buffer.map(row => row.join('')).join('\n');
         console.log(output);
@@ -36,6 +61,13 @@ class TideScreen {
     setFPS(fps) {
         this.fps = fps;
     }
+    nextFrame() {
+        if (this.updateFunction) {
+            this.updateFunction();
+        }
+        this.renderBuffer();
+        this.render();
+    }
     renderCycle() {
         if (this.fps === null) {
             throw new Error("FPS must be set before starting the render cycle.");
@@ -45,8 +77,8 @@ class TideScreen {
             if (this.updateFunction) {
                 this.updateFunction();
             }
-            this.renderBuffer(); // Prepare the buffer with updated content
-            this.render(); // Output the buffer to the screen
+            this.renderBuffer();
+            this.render();
             setTimeout(loop, interval);
         };
         loop();

package/eslint.config.mjs

@@ -0,0 +1,38 @@
+import typescriptEslint from "@typescript-eslint/eslint-plugin";
+import globals from "globals";
+import tsParser from "@typescript-eslint/parser";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import js from "@eslint/js";
+import { FlatCompat } from "@eslint/eslintrc";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const compat = new FlatCompat({
+    baseDirectory: __dirname,
+    recommendedConfig: js.configs.recommended,
+    allConfig: js.configs.all
+});
+
+export default [
+    ...compat.extends("eslint:recommended", "plugin:@typescript-eslint/recommended"),
+    {
+        plugins: {
+            "@typescript-eslint": typescriptEslint,
+        },
+
+        languageOptions: {
+            globals: {
+                ...globals.node,
+            },
+
+            parser: tsParser,
+            ecmaVersion: 12,
+            sourceType: "module",
+        },
+
+        rules: {
+            "@typescript-eslint/no-unsafe-function-type": "off",
+        },
+    },
+];

package/package.json

@@ -1,15 +1,22 @@
 {
   "name": "tidepool",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "author": "stuncs69",
   "main": "dist/index.js",
   "devDependencies": {
+    "@eslint/js": "^9.9.0",
     "@types/node": "^22.2.0",
-    "typescript": "^5.5.4"
+    "@typescript-eslint/eslint-plugin": "^8.1.0",
+    "@typescript-eslint/parser": "^8.1.0",
+    "eslint": "^9.9.0",
+    "globals": "^15.9.0",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.1.0"
   },
   "description": "A CLI rendering engine in TypeScript.",
   "license": "ISC",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "eslint ./src/*"
   }
 }