midi-shell-commands 1.1.1 → 1.2.0

package/.github/workflows/release.yml

@@ -0,0 +1,55 @@
+name: Release
+
+on:
+  merge_group:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+# Needed for semantic-release to create GitHub releases and publish to npm via OIDC
+permissions:
+  contents: write
+  issues: write
+  pull-requests: write
+  id-token: write
+
+concurrency:
+  group: Release
+  cancel-in-progress: false
+
+jobs:
+  release:
+    name: Semantic Release
+    environment: Release
+    # Ensure releases run only when code reaches main via GitHub Merge Queue, or when manually dispatched
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+          registry-url: 'https://registry.npmjs.org'
+      - name: Update npm
+        run: npm install -g npm@latest
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint
+      - name: Run unit tests
+        run: npm run test:ci
+      - name: Semantic Release
+        if: ${{ github.event_name == 'push' }}
+        uses: cycjimmy/semantic-release-action@9cc899c47e6841430bbaedb43de1560a568dfd16 # v5.0.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_CONFIG_PROVENANCE: true
+      - name: Publish to NPM
+        run: npm publish --provenance

package/.github/workflows/verify-pr.yml

@@ -0,0 +1,37 @@
+name: Verify PR
+
+on:
+  pull_request:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run ESLint
+        run: npm run lint
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+      - name: Setup Node.js
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+      - name: Install dependencies
+        run: npm ci
+      - name: Run unit tests
+        run: npm run test:ci

package/.nvmrc

@@ -1 +1 @@
-22
+24.11.0

package/.releaserc.json

@@ -0,0 +1,25 @@
+{
+  "branches": [
+    "main"
+  ],
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": false
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "package.json",
+          "package-lock.json"
+        ]
+      }
+    ],
+    "@semantic-release/github"
+  ]
+}

package/eslint.config.js

@@ -0,0 +1,12 @@
+import js from '@eslint/js';
+import { defineConfig } from 'eslint/config';
+import globals from 'globals';
+
+export default defineConfig([
+  {
+    files: ['**/*.{js,mjs,cjs}'],
+    plugins: { js },
+    extends: ['js/recommended'],
+    languageOptions: { globals: globals.node },
+  },
+]);

package/lib/check-inputs.js

@@ -0,0 +1,9 @@
+import easyMIDI from 'easymidi';
+import { listenToInput } from './listen-to-input.js';
+
+export function checkInputs() {
+  const inputNames = easyMIDI.getInputs();
+  for (const inputName of inputNames) {
+    listenToInput(inputName);
+  }
+}

package/lib/clean-up-inputs.js

@@ -0,0 +1,9 @@
+import { log } from './log.js';
+import { state } from './state.js';
+
+export function cleanUpInputs() {
+  for (const input of Object.values(state.watchedInputs)) {
+    input.close();
+  }
+  log('Cleaned up midi input watchers');
+}

package/lib/clean-up-watcher.js

@@ -0,0 +1,10 @@
+import { log } from './log.js';
+import { state } from './state.js';
+
+export function cleanUpWatcher() {
+  if (state.watcher) {
+    log('Stopped watching scripts directory');
+    state.watcher.close();
+    state.watcher = undefined;
+  }
+}

package/lib/escape-path.js

@@ -0,0 +1,7 @@
+export function escapePath(p) {
+  // Simple shell escaping for spaces
+  if (p.includes(' ')) {
+    return `'${p.replace(/'/g, '\'\\\'\'')}'`;
+  }
+  return p;
+}

package/lib/initialize-midi.js

@@ -0,0 +1,9 @@
+import { checkInputs } from './check-inputs.js';
+import { cleanUpInputs } from './clean-up-inputs.js';
+
+export function initializeMidi() {
+  const checkDelay = 60 * 1000 + (Math.random() * 3000) | 0;
+  checkInputs();
+  setInterval(checkInputs, checkDelay);
+  process.on('exit', cleanUpInputs);
+}

package/lib/initialize-scripts-directory.js

@@ -0,0 +1,37 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { cleanUpWatcher } from './clean-up-watcher.js';
+import { log } from './log.js';
+import { refreshScripts } from './refresh-scripts.js';
+import { state } from './state.js';
+
+export function initializeScriptsDirectory() {
+  // Default to ~/Documents/MidiShellCommands if no directory is provided
+  let targetDirArg = process.argv[process.argv.length - 1];
+  if (process.argv.length === 2 || targetDirArg === '--daemon') {
+    targetDirArg = path.join(os.homedir(), 'Documents', 'MidiShellCommands');
+  }
+
+  // Ensure the directory exists
+  state.watchDir = path.resolve(targetDirArg);
+  try {
+    fs.mkdirSync(state.watchDir, { recursive: true });
+  }
+  catch (e) {
+    console.error('Failed to create or access scripts directory:', state.watchDir);
+    console.error(e);
+    process.exit(1);
+  }
+
+  refreshScripts();
+  try {
+    state.watcher = fs.watch(state.watchDir, { persistent: true }, refreshScripts);
+  }
+  catch {
+    // Non-fatal on some platforms
+  }
+  process.on('exit', cleanUpWatcher);
+
+  log(`Watching ${targetDirArg}`);
+}

package/lib/invoke-scripts.js

@@ -0,0 +1,23 @@
+import childProcess from 'node:child_process';
+import { recentlyInvoked } from './recently-invoked.js';
+import { log } from './log.js';
+import { mapMessageToFileNames } from './map-message-to-file-names.js';
+import { reportErrors } from './report-errors.js';
+import { state } from './state.js';
+
+export function invokeScripts(msg) {
+  const possibleFileNames = mapMessageToFileNames(msg);
+  log(possibleFileNames[0]);
+  for (const possibleFileName of possibleFileNames) {
+    for (let i = 0; i < state.scriptsWithoutExtension.length; i++) {
+      if (state.scriptsWithoutExtension[i] === possibleFileName) {
+        if (recentlyInvoked(state.scripts[i])) {
+          log('Skipping ' + state.scripts[i] + ' because it was invoked recently');
+        } else {
+          log('Executing ' + state.scripts[i]);
+          childProcess.exec(`./${state.scripts[i]}`, { cwd: state.watchDir }, reportErrors);
+        }
+      }
+    }
+  }
+}

package/lib/listen-to-input.js

@@ -0,0 +1,11 @@
+import easyMIDI from 'easymidi';
+import { invokeScripts } from './invoke-scripts.js';
+import { state } from './state.js';
+
+export function listenToInput(inputName) {
+  if (!state.watchedInputs[inputName]) {
+    const input = state.watchedInputs[inputName] = new easyMIDI.Input(inputName);
+    input.on('noteon', invokeScripts);
+    input.on('noteoff', invokeScripts);
+  }
+}

package/lib/log.js

@@ -0,0 +1,3 @@
+export function log(msg) {
+  console.log(`[midi-shell-commands] ${msg}`);
+}

package/lib/map-message-to-file-names.js

@@ -0,0 +1,7 @@
+export function mapMessageToFileNames(msg) {
+  return [
+    `${msg._type}.${msg.note}.${msg.channel}.${msg.velocity}`,
+    `${msg._type}.${msg.note}.${msg.channel}`,
+    `${msg._type}.${msg.note}`,
+  ];
+}

package/lib/{postinstall.js → post-install.js}

@@ -1,20 +1,14 @@
 #!/usr/local/bin/node
+import childProcess from 'node:child_process';
 /**
  * Postinstall script to set up a macOS LaunchAgent which runs midi-shell-commands
  * pointing at ~/Documents/MidiShellCommands.
  */
-const fs = require('fs');
-const os = require('os');
-const path = require('path');
-const childProcess = require('child_process');
-
-function log(msg) {
-  try {
-    // Best-effort: npm may suppress some outputs; still try.
-    console.log(`[midi-shell-commands] ${msg}`);
-  }
-  catch {}
-}
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import { escapePath } from './escape-path.js';
+import { log } from './log.js';
 
 (function main() {
   const platform = process.platform;
@@ -85,8 +79,10 @@ function log(msg) {
     <key>StandardErrorPath</key>
     <string>${stderrPath}</string>
     <key>EnvironmentVariables</key>
-    <key>PATH</key>
-    <string>/usr/local/bin:/usr/local/sbin:/usr/bin:/bin:/usr/sbin:/sbin</string>
+    <dict>
+      <key>PATH</key>
+      <string>/usr/local/bin:/usr/local/sbin:/usr/bin:/bin:/usr/sbin:/sbin</string>
+    </dict>
   </dict>
 </plist>`;
 
@@ -111,7 +107,9 @@ function log(msg) {
     try {
       childProcess.execSync(`launchctl unload ${escapePath(plistPath)}`, { stdio: 'ignore' });
     }
-    catch {}
+    catch {
+      // Unload failed, proceed forward.
+    }
 
     // Preferred modern approach: bootstrap into the current user session
     const uid = process.getuid && process.getuid();
@@ -121,7 +119,9 @@ function log(msg) {
         log('LaunchAgent bootstrapped.');
         return;
       }
-      catch {}
+      catch {
+        console.log('Current user session bootstrap failed, falling back to legacy load.');
+      }
     }
 
     // Fallback to legacy load
@@ -133,10 +133,3 @@ function log(msg) {
   }
 })();
 
-function escapePath(p) {
-  // Simple shell escaping for spaces
-  if (p.includes(' ')) {
-    return `'${p.replace(/'/g, '\'\\\'\'')}'`;
-  }
-  return p;
-}

package/lib/recently-invoked.js

@@ -0,0 +1,16 @@
+const invocationMap = new Map();
+
+const recently = 1000; // once per second.
+
+export function recentlyInvoked(script, now = Date.now()) {
+  if (!invocationMap.has(script)) {
+    invocationMap.set(script, now);
+    return false;
+  }
+  const lastInvocation = invocationMap.get(script);
+  if (lastInvocation + recently > now) {
+    return true;
+  }
+  invocationMap.set(script, now);
+  return false;
+}

package/lib/refresh-scripts.js

@@ -0,0 +1,13 @@
+import fs from 'node:fs';
+import { state } from './state.js';
+
+export function refreshScripts() {
+  try {
+    state.scripts = fs.readdirSync(state.watchDir).filter(f => f[0] !== '.');
+    state.scriptsWithoutExtension = state.scripts.map(script => script.split('.').slice(0, -1).join('.'));
+  }
+  catch (e) {
+    console.error('Failed to read scripts directory:', state.watchDir);
+    console.error(e);
+  }
+}

package/lib/report-errors.js

@@ -0,0 +1,5 @@
+export function reportErrors(err) {
+  if (err) {
+    console.error(err);
+  }
+}

package/lib/state.js

@@ -0,0 +1,7 @@
+export const state = {
+  scripts: [],
+  scriptsWithoutExtension: [],
+  watchedInputs: {},
+  watchDir: undefined,
+  watcher: undefined,
+};

package/midi-shell-commands.js

@@ -1,104 +1,8 @@
 #!/usr/bin/env node
-const childProcess = require('child_process');
-const easyMIDI = require('easymidi');
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
+import { initializeMidi } from './lib/initialize-midi.js';
+import { initializeScriptsDirectory } from './lib/initialize-scripts-directory.js';
+import { log } from './lib/log.js';
 
-console.log('Midi Shell Commands starting up!');
-
-// Default to ~/Documents/MidiShellCommands if no directory is provided
-let targetDirArg = process.argv[process.argv.length - 1];
-if (process.argv.length === 2 || targetDirArg === '--daemon') {
-  targetDirArg = path.join(os.homedir(), 'Documents', 'MidiShellCommands');
-}
-console.log(`Watching ${targetDirArg}`);
-
-const watchDir = path.resolve(targetDirArg);
-
-// Ensure the directory exists
-try {
-  fs.mkdirSync(watchDir, { recursive: true });
-}
-catch (e) {
-  console.error('Failed to create or access scripts directory:', watchDir);
-  console.error(e);
-  process.exit(1);
-}
-
-let scripts = [];
-let scriptsWithoutExtension = [];
-
-process.on('exit', cleanUpInputs);
-refreshScripts();
-try {
-  fs.watch(watchDir, { persistent: true }, refreshScripts);
-}
-catch (e) {
-  // Non-fatal on some platforms
-}
-
-const checkDelay = 60 * 1000 + (Math.random() * 3000) | 0;
-const watchedInputs = {};
-checkInputs();
-setInterval(checkInputs, checkDelay);
-
-function refreshScripts() {
-  try {
-    scripts = fs.readdirSync(watchDir).filter(f => f[0] !== '.');
-    scriptsWithoutExtension = scripts.map(script => script.split('.').slice(0, -1).join('.'));
-  }
-  catch (e) {
-    console.error('Failed to read scripts directory:', watchDir);
-    console.error(e);
-  }
-}
-
-function checkInputs() {
-  const inputNames = easyMIDI.getInputs();
-  for (const inputName of inputNames) {
-    listenToInput(inputName);
-  }
-}
-
-function listenToInput(inputName) {
-  if (watchedInputs[inputName]) {
-    return;
-  }
-  const input = watchedInputs[inputName] = new easyMIDI.Input(inputName);
-  input.on('noteon', invokeScripts);
-  input.on('noteoff', invokeScripts);
-}
-
-function invokeScripts(msg) {
-  const possibleFileNames = mapMessageToFileNames(msg);
-  console.log(possibleFileNames[0]);
-  for (const possibleFileName of possibleFileNames) {
-    for (let i = 0; i < scriptsWithoutExtension.length; i++) {
-      if (scriptsWithoutExtension[i] === possibleFileName) {
-        console.log('Executing ' + scripts[i]);
-        childProcess.exec(`./${scripts[i]}`, { cwd: watchDir }, reportErrors);
-      }
-    }
-  }
-}
-
-function mapMessageToFileNames(msg) {
-  return [
-    `${msg._type}.${msg.note}.${msg.channel}.${msg.velocity}`,
-    `${msg._type}.${msg.note}.${msg.channel}`,
-    `${msg._type}.${msg.note}`,
-  ];
-}
-
-function reportErrors(err) {
-  if (err) {
-    console.error(err);
-  }
-}
-
-function cleanUpInputs() {
-  for (const input of Object.values(watchedInputs)) {
-    input.close();
-  }
-}
+log('Starting up!');
+initializeScriptsDirectory();
+initializeMidi();

package/package.json

@@ -1,20 +1,44 @@
 {
   "name": "midi-shell-commands",
-  "version": "1.1.1",
-  "main": "midi-shell-commands.js",
-  "bin": {
-    "midi-shell-commands": "midi-shell-commands.js"
-  },
+  "version": "1.2.0",
+  "author": "Dawson Toth",
+  "repository": "https://github.com/dawsontoth/midi-shell-commands.git",
   "scripts": {
     "start": "node midi-shell-commands.js ./scripts",
-    "postinstall": "node lib/postinstall.js",
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "postinstall": "node lib/post-install.js",
+    "test": "vitest",
+    "test:ci": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
   },
+  "description": "Execute shell scripts on MIDI note events; supports macOS daemon mode via LaunchAgent.",
+  "type": "module",
   "keywords": [],
-  "author": "",
+  "main": "midi-shell-commands.js",
+  "bin": {
+    "midi-shell-commands": "midi-shell-commands.js"
+  },
   "license": "ISC",
-  "description": "Execute shell scripts on MIDI note events; supports macOS daemon mode via LaunchAgent.",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "tag": "latest",
+    "provenance": true
+  },
   "dependencies": {
     "easymidi": "^3.1.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.39.1",
+    "@semantic-release/commit-analyzer": "^13.0.1",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^12.0.2",
+    "@semantic-release/npm": "^13.1.1",
+    "@semantic-release/release-notes-generator": "^14.1.0",
+    "@vitest/coverage-v8": "^4.0.8",
+    "eslint": "^9.39.1",
+    "globals": "^16.5.0",
+    "semantic-release": "^25.0.2",
+    "vitest": "^4.0.8"
   }
 }

package/renovate.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:recommended"
+  ],
+  "lockFileMaintenance": {
+    "enabled": true,
+    "automerge": true
+  },
+  "packageRules": [
+    {
+      "matchDepTypes": [
+        "action"
+      ],
+      "pinDigests": true
+    },
+    {
+      "matchUpdateTypes": [
+        "minor",
+        "patch"
+      ],
+      "matchCurrentVersion": "!/^0/",
+      "automerge": true
+    }
+  ]
+}