command-cmd 1.0.5 → 1.0.6

package/cmd.js

@@ -129,6 +129,10 @@ const CLICK_MODE = Object.freeze({
 });
 
 let robotCache;
+const MAPER_POLL_INTERVAL = 50;
+let maperInterval = null;
+let maperLastPosition = null;
+let maperPrintedLine = false;
 
 export function cmd(message) {
   if (typeof message !== 'string') {
@@ -298,6 +302,81 @@ export function extractFirstCommand(message) {
   return first || null;
 }
 
+export async function maper(enabled) {
+  const shouldEnable = parseBooleanValue(enabled);
+  if (shouldEnable === null) {
+    throw new Error('maper_requires_boolean_true_or_false');
+  }
+
+  if (!shouldEnable) {
+    if (maperInterval) {
+      clearInterval(maperInterval);
+      maperInterval = null;
+    }
+
+    maperLastPosition = null;
+
+    if (maperPrintedLine && process.stdout && typeof process.stdout.write === 'function') {
+      process.stdout.write('\n');
+    }
+
+    maperPrintedLine = false;
+    return { active: false, pollInterval: MAPER_POLL_INTERVAL };
+  }
+
+  const robot = await getRobot();
+
+  const printPosition = (position) => {
+    const line = `[maper] x: ${position.x} | y: ${position.y}`;
+
+    if (process.stdout && process.stdout.isTTY && typeof process.stdout.write === 'function') {
+      process.stdout.write(`\r${line}`);
+      maperPrintedLine = true;
+      return;
+    }
+
+    console.log(line);
+  };
+
+  const pollPosition = () => {
+    let position;
+    try {
+      position = robot.getMousePos();
+    } catch (error) {
+      return;
+    }
+
+    if (!position || !Number.isFinite(position.x) || !Number.isFinite(position.y)) {
+      return;
+    }
+
+    if (
+      maperLastPosition &&
+      position.x === maperLastPosition.x &&
+      position.y === maperLastPosition.y
+    ) {
+      return;
+    }
+
+    maperLastPosition = { x: position.x, y: position.y };
+    printPosition(position);
+  };
+
+  if (maperInterval) {
+    return { active: true, pollInterval: MAPER_POLL_INTERVAL };
+  }
+
+  maperLastPosition = null;
+  pollPosition();
+  maperInterval = setInterval(pollPosition, MAPER_POLL_INTERVAL);
+
+  if (typeof maperInterval.unref === 'function') {
+    maperInterval.unref();
+  }
+
+  return { active: true, pollInterval: MAPER_POLL_INTERVAL };
+}
+
 export async function initMap(options = {}) {
   const config = buildCursorConfig(options);
   const mapAlreadyExists = await pathExists(config.mapPath);

package/doc.md

@@ -9,6 +9,7 @@ Exported functions:
 - `cursor`
 - `initMap`
 - `initDoc`
+- `maper`
 
 ## Installation
 
@@ -19,7 +20,7 @@ npm install command-cmd
 ## Import
 
 ```js
-import { cmd, extractFirstCommand, cursor, initMap, initDoc } from 'command-cmd';
+import { cmd, extractFirstCommand, cursor, initMap, initDoc, maper } from 'command-cmd';
 ```
 
 ## 1) `cmd(message)`
@@ -156,6 +157,21 @@ Optional keys:
 - `includeMapDocs`
 - `files` (e.g. `['doc', 'docPTBR', 'map', 'mapPTBR']`)
 
+## 6) `maper(enabled)`
+
+Turns terminal mouse position mapping on/off.
+
+- pass `true` to start mapping
+- pass `false` to stop mapping
+- while active, it prints current `x/y` only when mouse position changes
+
+Example:
+
+```js
+await maper(true);  // starts mapper
+await maper(false); // stops mapper
+```
+
 ### App and button names (important)
 
 You can name apps and buttons however you want.

package/docPTBR.md

@@ -9,6 +9,7 @@ Funcoes exportadas:
 - `cursor`
 - `initMap`
 - `initDoc`
+- `maper`
 
 ## Instalacao
 
@@ -24,7 +25,8 @@ import {
   extractFirstCommand as extrairPrimeiroComando,
   cursor as executarCursor,
   initMap as iniciarMap,
-  initDoc as iniciarDoc
+  initDoc as iniciarDoc,
+  maper
 } from 'command-cmd';
 ```
 
@@ -162,6 +164,21 @@ Campos opcionais:
 - `includeMapDocs`
 - `files` (ex.: `['doc', 'docPTBR', 'map', 'mapPTBR']`)
 
+## 6) `maper(enabled)`
+
+Liga/desliga o mapeador de posicao do mouse no terminal.
+
+- passe `true` para ativar
+- passe `false` para desativar
+- enquanto ativo, ele mostra `x/y` apenas quando a posicao muda
+
+Exemplo:
+
+```js
+await maper(true);  // inicia o mapeador
+await maper(false); // encerra o mapeador
+```
+
 ### Nome dos apps e botoes (importante)
 
 Voce pode chamar apps e botoes como quiser.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "command-cmd",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "main": "cmd.js",
   "type": "module",
   "scripts": {