tidepool 1.0.0 → 1.0.2

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/{src/index.ts → dist/index.d.ts}

@@ -1,5 +1,5 @@
-import { Box } from "./objects/box";
-import { Text } from "./objects/text";
-import { TideScreen } from "./screen";
-
-export { Box, Text, TideScreen };
+import { Box } from "./objects/box";
+import { Text } from "./objects/text";
+import { TideScreen } from "./screen";
+export { Box, Text, TideScreen };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,eAAe,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACtC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC"}

package/{src/interfaces.ts → dist/interfaces.d.ts}

@@ -1,4 +1,5 @@
-export interface TideObject {
-    zIndex: number;
-    draw: Function;
-}
+export interface TideObject {
+    zIndex: number;
+    draw: Function;
+}
+//# sourceMappingURL=interfaces.d.ts.map

package/dist/interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.d.ts","sourceRoot":"","sources":["../src/interfaces.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,UAAU;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,CAAC;CAClB"}

package/dist/objects/box.d.ts

@@ -0,0 +1,17 @@
+import { TideObject } from "../interfaces";
+export declare class Box implements TideObject {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    color: string;
+    title: string;
+    contents: TideObject[];
+    zIndex: number;
+    constructor(x: number, y: number, width: number, height: number, color?: string, title?: string, zIndex?: number);
+    addContent(content: TideObject): void;
+    clear(screen: string[][]): void;
+    draw(screen: string[][]): void;
+    move(dx: number, dy: number): void;
+}
+//# sourceMappingURL=box.d.ts.map

package/dist/objects/box.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"box.d.ts","sourceRoot":"","sources":["../../src/objects/box.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,qBAAa,GAAI,YAAW,UAAU;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,MAAM,EAAE,MAAM,CAAC;gBAEH,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,SAAU,EAAE,KAAK,SAAK,EAAE,MAAM,SAAI;IAWxG,UAAU,CAAC,OAAO,EAAE,UAAU;IAI9B,KAAK,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;IAQxB,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE;IAoCvB,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;CAI5B"}

package/dist/objects/text.d.ts

@@ -0,0 +1,11 @@
+import { TideObject } from "../interfaces";
+export declare class Text implements TideObject {
+    relativeX: number;
+    relativeY: number;
+    text: string;
+    color: string;
+    zIndex: number;
+    constructor(x: number, y: number, text: string, color?: string, zIndex?: number);
+    draw(screen: string[][], boxX: number, boxY: number, boxWidth: number): void;
+}
+//# sourceMappingURL=text.d.ts.map

package/dist/objects/text.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text.d.ts","sourceRoot":"","sources":["../../src/objects/text.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAG3C,qBAAa,IAAK,YAAW,UAAU;IACnC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;gBAEH,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,SAAU,EAAE,MAAM,SAAI;IAQ3E,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;CAetE"}

package/dist/screen.d.ts

@@ -0,0 +1,20 @@
+import { TideObject } from "./interfaces";
+export declare class TideScreen {
+    width: number;
+    height: number;
+    screen: string[][];
+    buffer: string[][];
+    components: TideObject[];
+    fps: number | null;
+    updateFunction: (() => void) | null;
+    constructor(width: number, height: number);
+    clearScreen(): void;
+    clearBuffer(): void;
+    addComponent(component: TideObject): void;
+    renderBuffer(): void;
+    render(): void;
+    setUpdateFunction(fn: () => void): void;
+    setFPS(fps: number): void;
+    renderCycle(): void;
+}
+//# sourceMappingURL=screen.d.ts.map

package/dist/screen.d.ts.map

@@ -0,0 +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"}

package/dist/util.d.ts

@@ -0,0 +1,3 @@
+export declare function getColorCode(color: string): string;
+export declare function wrapText(text: string, maxWidth: number): string[];
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,UAczC;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,YAetD"}

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.0",
+  "version": "1.0.2",
   "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/*"
   }
 }

package/src/objects/box.ts

@@ -1,78 +0,0 @@
-import { TideObject } from "../interfaces";
-import { getColorCode } from "../util";
-
-export class Box implements TideObject {
-    x: number;
-    y: number;
-    width: number;
-    height: number;
-    color: string;
-    title: string;
-    contents: TideObject[];
-    zIndex: number;
-
-    constructor(x: number, y: number, width: number, height: number, color = 'reset', title = '', zIndex = 0) {
-      this.x = x;
-      this.y = y;
-      this.width = width;
-      this.height = height;
-      this.color = color;
-      this.title = title;
-      this.contents = [];
-      this.zIndex = zIndex;
-    }
-  
-    addContent(content: TideObject) {
-      this.contents.push(content);
-    }
-  
-    clear(screen: string[][]) {
-      for (let i = this.y; i < this.y + this.height; i++) {
-        for (let j = this.x; j < this.x + this.width; j++) {
-          screen[i][j] = ' ';
-        }
-      }
-    }
-  
-    draw(screen: string[][]) {
-      this.clear(screen);
-  
-      const colorCode = getColorCode(this.color);
-      const titleColorCode = getColorCode('magenta');
-  
-      for (let i = this.x + 1; i < this.x + this.width - 1; i++) {
-        screen[this.y][i] = `${colorCode}─\x1b[0m`;
-      }
-      for (let i = this.x + 1; i < this.x + this.width - 1; i++) {
-        screen[this.y + this.height - 1][i] = `${colorCode}─\x1b[0m`;
-      }
-      for (let i = this.y + 1; i < this.y + this.height - 1; i++) {
-        screen[i][this.x] = `${colorCode}│\x1b[0m`;
-        screen[i][this.x + this.width - 1] = `${colorCode}│\x1b[0m`;
-      }
-  
-      screen[this.y][this.x] = `${colorCode}┌\x1b[0m`;
-      screen[this.y][this.x + this.width - 1] = `${colorCode}┐\x1b[0m`;
-      screen[this.y + this.height - 1][this.x] = `${colorCode}└\x1b[0m`;
-      screen[this.y + this.height - 1][this.x + this.width - 1] = `${colorCode}┘\x1b[0m`;
-  
-      if (this.title) {
-        const titlePosition = Math.max(this.x + 2, Math.min(this.x + this.width - 2 - this.title.length, this.x + 2));
-        for (let i = 0; i < this.title.length; i++) {
-          if (titlePosition + i < screen[0].length && this.y < screen.length) {
-            screen[this.y][titlePosition + i] = `${titleColorCode}${this.title[i]}\x1b[0m`;
-          }
-        }
-      }
-  
-      for (let content of this.contents) {
-        content.draw(screen, this.x + 1, this.y + 1, this.width - 2);
-      }
-    }
-  
-    move(dx: number, dy: number) {
-      this.x += dx;
-      this.y += dy;
-    }
-  }
-  

package/src/objects/text.ts

@@ -1,34 +0,0 @@
-import { TideObject } from "../interfaces";
-import { getColorCode, wrapText } from "../util";
-
-export class Text implements TideObject {
-    relativeX: number;
-    relativeY: number;
-    text: string;
-    color: string;
-    zIndex: number;
-    
-    constructor(x: number, y: number, text: string, color = 'reset', zIndex = 0) {
-      this.relativeX = x;
-      this.relativeY = y;
-      this.text = text;
-      this.color = color;
-      this.zIndex = zIndex;
-    }
-  
-    draw(screen: string[][], boxX: number, boxY: number, boxWidth: number) {
-      const colorCode = getColorCode(this.color);
-      const lines = wrapText(this.text, boxWidth);
-      
-      for (let i = 0; i < lines.length; i++) {
-        const line = lines[i];
-        for (let j = 0; j < line.length; j++) {
-          const screenX = boxX + this.relativeX + j;
-          const screenY = boxY + this.relativeY + i;
-          if (screenX < screen[0].length && screenY < screen.length) {
-            screen[screenY][screenX] = `${colorCode}${line[j]}\x1b[0m`;
-          }
-        }
-      }
-    }
-  }

package/src/screen.ts

@@ -1,70 +0,0 @@
-import { TideObject } from "./interfaces";
-
-export class TideScreen {
-    width: number;
-    height: number;
-    screen: string[][];
-    buffer: string[][];
-    components: TideObject[];
-    fps: number | null = null;
-    updateFunction: (() => void) | null = null;
-
-    constructor(width: number, height: number) {
-        this.width = width;
-        this.height = height;
-        this.screen = Array.from({ length: height }, () => Array(width).fill(' '));
-        this.buffer = Array.from({ length: height }, () => Array(width).fill(' '));
-        this.components = [];
-    }
-
-    clearScreen() {
-        this.screen = Array.from({ length: this.height }, () => Array(this.width).fill(' '));
-    }
-
-    clearBuffer() {
-        this.buffer = Array.from({ length: this.height }, () => Array(this.width).fill(' '));
-    }
-
-    addComponent(component: TideObject) {
-        this.components.push(component);
-    }
-
-    renderBuffer() {
-        this.clearBuffer();
-        this.components.sort((a, b) => b.zIndex - a.zIndex);
-        this.components.forEach(component => component.draw(this.buffer));
-    }
-
-    render() {
-        console.clear();
-        const output = this.buffer.map(row => row.join('')).join('\n');
-        console.log(output);
-    }
-
-    setUpdateFunction(fn: () => void) {
-        this.updateFunction = fn;
-    }
-
-    setFPS(fps: number) {
-        this.fps = fps;
-    }
-
-    renderCycle() {
-        if (this.fps === null) {
-            throw new Error("FPS must be set before starting the render cycle.");
-        }
-
-        const interval = 1000 / this.fps;
-
-        const loop = () => {
-            if (this.updateFunction) {
-                this.updateFunction();
-            }
-            this.renderBuffer(); // Prepare the buffer with updated content
-            this.render(); // Output the buffer to the screen
-            setTimeout(loop, interval);
-        };
-
-        loop();
-    }
-}

package/src/util.ts

@@ -1,32 +0,0 @@
-export function getColorCode(color: string) {
-    const colors: { [key: string]: string } = {
-      reset: '\x1b[0m',
-      black: '\x1b[30m',
-      red: '\x1b[31m',
-      green: '\x1b[32m',
-      yellow: '\x1b[33m',
-      blue: '\x1b[34m',
-      magenta: '\x1b[35m',
-      cyan: '\x1b[36m',
-      white: '\x1b[37m',
-    };
-    
-    return colors[color.toLowerCase()] || colors['reset'];
-}
-
-export function wrapText(text: string, maxWidth: number) {
-    const lines = [];
-    let currentLine = '';
-  
-    for (const word of text.split(' ')) {
-      if ((currentLine + word).length > maxWidth) {
-        lines.push(currentLine.trim());
-        currentLine = word + ' ';
-      } else {
-        currentLine += word + ' ';
-      }
-    }
-    lines.push(currentLine.trim());
-  
-    return lines;
-}