rectangle-drawer 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,99 @@
+# Rectangle Drawer Library – Usage Guide
+
+*rectangle-drawer.mjs* is a utility module used to generate text-based rectangles using dots (.) and dashes (-).
+It returns rectangles as strings, which can be printed directly to the terminal or styled using color libraries such as **starlight-color**.
+
+
+
+
+## Importing the Library
+
+Use a relative import path when importing the module:
+
+`
+import {
+  solidRectangle,
+  hollowRectangle,
+  dashedRectangle,
+  dottedBorderRectangle,
+  checkerRectangle,
+  drawRectangle
+} from "./rectangle-drawer.mjs";
+`
+
+
+
+
+## Available Rectangle Types
+
+
+  - **solidRectangle(width, height)** – creates a fully filled rectangle using dots
+  - **hollowRectangle(width, height)** – creates a rectangle with dashed borders and dotted interior
+  - **dashedRectangle(width, height)** – creates a diagonal dashed pattern
+  - **dottedBorderRectangle(width, height)** – creates a dotted border with empty space inside
+  - **checkerRectangle(width, height)** – creates a checkerboard pattern using dots and dashes
+
+
+
+
+
+## Generic Rectangle Function
+
+**drawRectangle(width, height, type)** allows selecting a rectangle style dynamically.
+
+Supported *type* values:
+
+  - solid
+  - hollow
+  - dashed
+  - dotted
+  - checker
+
+
+
+
+
+## Example Usage
+
+`
+let rect = drawRectangle(10, 5, "hollow");
+print(rect);
+`
+
+
+
+
+## Validation Rules
+
+
+  - Width and height must be positive integers
+  - Hollow and border-based rectangles require width ≥ 2 and height ≥ 2
+  - An error is thrown for unknown rectangle types
+
+
+
+
+
+## Styling with Colors
+
+The returned rectangle is a plain string. You can apply colors using **starlight-color**:
+
+`
+print(green(solidRectangle(8, 4)));
+print(red(hollowRectangle(10, 5)));
+`
+
+
+
+
+### Summary
+
+This module is ideal for:
+
+  - CLI visual output
+  - ASCII art
+  - Teaching patterns and loops
+  - Terminal UI components
+
+
+**rectangle-drawer** focuses on simplicity, flexibility, and clean terminal rendering.

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "rectangle-drawer",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Draw rectangle shapes using dots and dashes",
   "type": "module",
-  "main": "starlight-txt-to-pdf.mjs",
+  "main": "rectangle-drawer.mjs",
   "keywords": [
     "rectangle",
     "ascii",

package/rectangle-drawer.mjs

@@ -1,116 +1,109 @@
-/**
- * Rectangle Drawer Library
- * Draw rectangles using dots (.) and dashes (-)
- */
-
-/* Solid filled rectangle */
 function solidRectangle(width, height) {
-  validate(width, height);
+  validate(width, height)
 
-  const rows = [];
+  const rows = []
   for (let y = 0; y < height; y++) {
-    rows.push(".".repeat(width));
+    rows.push(".".repeat(width))
   }
-  return rows.join("\n");
+  return rows.join("\n")
 }
 
-/* Hollow rectangle (border only) */
 function hollowRectangle(width, height) {
-  validate(width, height);
-
-  if (width < 2 || height < 2) {
-    throw new Error("Hollow rectangles require width and height >= 2");
-  }
-
-  const rows = [];
-  rows.push("-".repeat(width));
+  validate(width, height)
+  if (width < 2 || height < 2) throw new Error("Hollow rectangles require width and height >= 2")
 
+  const rows = []
+  rows.push("-".repeat(width))
   for (let y = 0; y < height - 2; y++) {
-    rows.push("-" + ".".repeat(width - 2) + "-");
+    rows.push("-" + ".".repeat(width - 2) + "-")
   }
-
-  rows.push("-".repeat(width));
-  return rows.join("\n");
+  rows.push("-".repeat(width))
+  return rows.join("\n")
 }
 
-/* Dashed rectangle */
 function dashedRectangle(width, height) {
-  validate(width, height);
+  validate(width, height)
 
-  const rows = [];
+  const rows = []
   for (let y = 0; y < height; y++) {
-    let row = "";
+    let row = ""
     for (let x = 0; x < width; x++) {
-      row += (x + y) % 2 === 0 ? "-" : ".";
+      row += (x + y) % 2 === 0 ? "-" : "."
     }
-    rows.push(row);
+    rows.push(row)
   }
-  return rows.join("\n");
+  return rows.join("\n")
 }
 
-/* Border-only dotted rectangle */
 function dottedBorderRectangle(width, height) {
-  validate(width, height);
-
-  if (width < 2 || height < 2) {
-    throw new Error("Border rectangles require width and height >= 2");
-  }
-
-  const rows = [];
-  rows.push(".".repeat(width));
+  validate(width, height)
+  if (width < 2 || height < 2) throw new Error("Border rectangles require width and height >= 2")
 
+  const rows = []
+  rows.push(".".repeat(width))
   for (let y = 0; y < height - 2; y++) {
-    rows.push("." + " ".repeat(width - 2) + ".");
+    rows.push("." + " ".repeat(width - 2) + ".")
   }
-
-  rows.push(".".repeat(width));
-  return rows.join("\n");
+  rows.push(".".repeat(width))
+  return rows.join("\n")
 }
 
-/* Checkerboard rectangle */
 function checkerRectangle(width, height) {
-  validate(width, height);
+  validate(width, height)
 
-  const rows = [];
+  const rows = []
   for (let y = 0; y < height; y++) {
-    let row = "";
+    let row = ""
     for (let x = 0; x < width; x++) {
-      row += (x % 2 === 0) ? "." : "-";
+      row += (x % 2 === 0) ? "." : "-"
     }
-    rows.push(row);
+    rows.push(row)
   }
-  return rows.join("\n");
+  return rows.join("\n")
+}
+
+// Draw text inside a rectangle, automatically centered
+function rectangleWithText(rect, text) {
+  const lines = rect.split("\n")
+  const mid = Math.floor(lines.length / 2)
+  const raw = lines[mid]
+  let pad = Math.floor((raw.length - text.length) / 2)
+  if (pad < 0) pad = 0
+  const newLine = raw.slice(0, pad) + text + raw.slice(pad + text.length)
+  lines[mid] = newLine
+  return lines.join("\n")
 }
 
-/* Generic rectangle dispatcher */
-function drawRectangle(width, height, type = "solid") {
+function drawRectangle(width, height, type = "solid", text = "") {
+  let rect
   switch (type) {
     case "solid":
-      return solidRectangle(width, height);
+      rect = solidRectangle(width, height)
+      break
     case "hollow":
-      return hollowRectangle(width, height);
+      rect = hollowRectangle(width, height)
+      break
     case "dashed":
-      return dashedRectangle(width, height);
+      rect = dashedRectangle(width, height)
+      break
     case "dotted":
-      return dottedBorderRectangle(width, height);
+      rect = dottedBorderRectangle(width, height)
+      break
     case "checker":
-      return checkerRectangle(width, height);
+      rect = checkerRectangle(width, height)
+      break
     default:
-      throw new Error(`Unknown rectangle type: ${type}`);
+      throw new Error(`Unknown rectangle type: ${type}`)
   }
+  if (text) rect = rectangleWithText(rect, text)
+  return rect
 }
 
-/* Internal validation */
 function validate(width, height) {
-  if (!Number.isInteger(width) || !Number.isInteger(height)) {
-    throw new Error("Width and height must be integers");
-  }
-  if (width <= 0 || height <= 0) {
-    throw new Error("Width and height must be positive");
-  }
+  if (!Number.isInteger(width) || !Number.isInteger(height)) throw new Error("Width and height must be integers")
+  if (width <= 0 || height <= 0) throw new Error("Width and height must be positive")
 }
 
-/* Exports (ONLY at the end) */
 export {
   solidRectangle,
   hollowRectangle,
@@ -118,4 +111,4 @@ export {
   dottedBorderRectangle,
   checkerRectangle,
   drawRectangle
-};
+}