Files
Move/CHANGELOG.md
T
nokeo08 db3310c247 Add pluggable movement strategies (v1.3.0)
Turn the hardcoded straight-line sweep into a strategy system behind three
seams so new patterns are easy to add and, for the first time, testable
without nut.js or a real screen:

- src/device.ts:     injectable Device seam over nut.js (autoDelayMs lives
                     here now); the only module that touches the native lib.
- src/strategies.ts: pure per-pattern path generators + registry + lenient
                     name resolution. Ships line, diagonal, jitter, walk,
                     arc, figureEight.
- src/executor.ts:   single executePath driver owning bounds policy
                     (abort/clamp/reflect), pacing, interrupt detection, and
                     restore-on-clean.

keeper.ts's simulateActivity now selects a strategy and delegates to the
executor; the default `line` pattern is byte-for-byte the previous behavior.

New config surface, layered CLI > file > default with strict validation:
- -p/--pattern <name>   movement strategy (names matched case/-/_-insensitive)
- -s/--step-size <px>   pixels per step; stepCount is now a step *count*

Robustness for the new edge-seeking patterns: interrupt detection compares
against the last commanded (rounded) point with a 2px tolerance, and
clamp/reflect stay a couple pixels off the screen edge, so sub-pixel cursor
placement on scaled/multi-monitor displays isn't misread as user activity.
jitter's radius scales with sweep length so it moves at the default stepSize.

Tests: new suites for strategies, the executor (all bounds policies,
rounding, interrupt, tolerance, pacing), and the keeper loop; config and
configFile suites extended for pattern/stepSize. editor.test.ts moved to
tests/ for consistency. 64 pass.
2026-08-13 15:36:22 -05:00

5.1 KiB

Changelog

All notable changes to move are documented here.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

1.3.0 - 2026-08-06

Added

  • Pluggable movement strategies. New -p, --pattern <name> flag and pattern config key select how the cursor moves: line (default, unchanged behavior), diagonal, jitter, walk, arc, figureEight.
  • -s, --step-size <pixels> decouples pixels-per-step from stepCount (which is now a step count, not a pixel distance). Default 1.
  • Pattern names are matched leniently: case and separators are ignored, so figureEight, figure-eight, figure_eight, and FIGUREEIGHT are all accepted (on the CLI and in the config file) and resolve to the canonical name.
  • src/device.ts: injectable Device seam over nut.js, enabling unit tests for movement without the native binary or a real screen.
  • src/strategies.ts: pure, per-pattern path generators plus the registry and name validation.
  • src/executor.ts: single executePath driver owning bounds policy (abort/clamp/reflect), pacing, interrupt detection, and restore.
  • Test suites for strategies, the executor (all bounds policies, rounding, interrupt), and the keeper loop.

Changed

  • simulateActivity no longer hardcodes a straight-line sweep; it selects a strategy from the registry and delegates execution to executePath. The default line pattern is byte-for-byte the previous behavior.
  • Interrupt detection now compares against the last commanded (rounded) point rather than an ideal target, so fractional/curved paths don't self-trip.
  • mouse.config.autoDelayMs = 0 moved from runKeeper into createNutDevice — the single place nut.js is wired up.
  • runKeeper(config, device?) accepts an injected device for testing.
  • jitter's radius now scales with the sweep length (like the other patterns) instead of stepSize alone, so it produces real cursor motion at the default stepSize of 1 rather than hovering within a 2px radius.
  • Interrupt detection tolerates a small (2px) gap between the commanded and read-back cursor position, and the clamp/reflect patterns stay a few pixels off the screen edge. Together these avoid false "user activity" aborts from sub-pixel cursor placement on scaled or multi-monitor setups, which the new edge-seeking patterns would otherwise hit. line (policy abort) is unaffected.

1.2.0 - 2026-06-17

Added

  • -e, --edit flag opens the resolved config file in $EDITOR.

Changed

  • keeper.ts (and @nut-tree-fork/nut-js) is lazy-imported, so --help and --version skip the nut.js load and start ~10x faster.

1.1.1 - 2026-06-17

Changed

  • Tests moved from src/ to a top-level tests/ directory.
  • tsconfig.json sets "types": ["bun"] so VS Code resolves bun:test.

Fixed

  • package.json version now matches the published tag.

1.1.0 - 2026-06-17

Added

  • JSON config file support at ${XDG_CONFIG_HOME:-~/.config}/move/config.json. Precedence: CLI flags > config file > defaults. Strict validation.
  • -C, --config <path> to override the default config path.
  • Installer seeds config.json with project defaults on fresh install only.
  • Bun test suite for resolveConfig and loadConfigFile.

Changed

  • Installer scripts now live in scripts/.
  • verbose is now a first-class Config field; resolveVerbose removed.
  • CliError extracted into src/errors.ts.
  • defaultConfigPath() throws when both $XDG_CONFIG_HOME and $HOME are unset.
  • mouse.config.autoDelayMs = 0 moved into runKeeper (no module-load side effect).
  • Runtime errors go through a failRuntime helper that mirrors failUser.
  • keeper.ts declares a named Logger interface.
  • dev-setup.sh is now POSIX sh.
  • tsconfig.json: enabled noUncheckedIndexedAccess and resolveJsonModule.

1.0.1 - 2026-06-17

Added

  • End-user install.sh runnable via curl ... | sh. XDG-respecting, idempotent.
  • uninstall.sh removes the wrapper and install tree; leaves Bun and user config alone.
  • dev-setup.sh for contributors.

Removed

  • DISTRIBUTION-PLAN.md (design notes, superseded by the implementation).

1.0.0 - 2026-06-15

Initial release.

Added

  • move CLI for keeping presence-tracking apps marked Available by nudging the cursor after a configurable idle period.
  • Flags: -h/--help, -v/--version, -m/--move-interval, -c/--check-interval, -d/--step-delay, -n/--step-count, -V/--verbose.
  • Quiet-by-default logging.
  • Source split into src/{move,cli,config,keeper}.ts.
  • bin entry + shebang so bun link registers move globally.