symlx 0.1.4 → 0.1.7

package/README.md

@@ -1,9 +1,39 @@
+## Quick Start
+
+In a CLI project with:
+
+```json
+{
+  "name": "awesome-cli",
+  "bin": {
+    "awesome-cli": "./dist/cli.js"
+  }
+}
+```
+
+run:
+
+```bash
+symlx link
+```
+
+Then use your CLI normally:
+
+```bash
+awesome-cli --help
+```
+
+Use `symlx serve` when you want temporary session-scoped links with auto-cleanup on exit.
+
+---
+
 # symlx
 
 Temporary command linker for local CLI development.
 
 `symlx serve` links command names from your project into a runnable bin directory for the lifetime of the process.
 When `symlx` stops, those links are cleaned up.
+`symlx link` creates the same links once and exits immediately.
 
 ## Why symlx
 
@@ -26,33 +56,6 @@ npx symlx serve
 npm i -g symlx
 ```
 
-## Quick Start
-
-In a CLI project with:
-
-```json
-{
-  "name": "my-cli",
-  "bin": {
-    "my-cli": "./dist/cli.js"
-  }
-}
-```
-
-run:
-
-```bash
-symlx serve
-```
-
-Then use your CLI normally:
-
-```bash
-my-cli --help
-```
-
-Stop `symlx` with `Ctrl+C` to clean links.
-
 ## Alias
 
 `symlx` can be clackful for power users, hence its alias: `cx`.
@@ -61,7 +64,9 @@ Equivalent commands:
 
 ```bash
 symlx serve
+symlx link
 cx serve
+cx link
 ```
 
 ## Command Reference
@@ -88,6 +93,20 @@ symlx serve --bin admin=dist/admin.js --bin worker=dist/worker.js
 symlx serve --bin-resolution-strategy merge
 ```
 
+## `symlx link`
+
+Links commands from resolved bin mappings and exits immediately.
+
+It uses the exact same options and resolution behavior as `symlx serve`, but it does not keep a live session.
+
+Examples:
+
+```bash
+symlx link
+symlx link --collision overwrite
+symlx link --bin admin=dist/admin.js
+```
+
 ## Bin Resolution Model
 
 `symlx` resolves options from three user sources plus defaults:
@@ -203,13 +222,13 @@ symlx serve --bin-dir ~/.symlx/bin
 
 ## Runtime Safety Checks
 
-Before linking, symlx validates each resolved bin target:
+Before linking, symlx prepares each resolved bin target:
 
 - file exists
 - target is not a directory
-- target is executable on unix-like systems
+- target is made executable automatically on unix-like systems when possible
 
-Invalid targets fail early with actionable messages.
+Missing targets, directories, and permission-update failures still fail early with actionable messages.
 
 ## Exit Behavior
 
@@ -227,12 +246,6 @@ Add a bin mapping in at least one place:
 - `symlx.config.json -> bin`
 - `--bin name=path`
 
-## "target is not executable"
-
-```bash
-chmod +x dist/cli.js # or your target executable
-```
-
 ## "command conflicts at ..."
 
 Use a collision mode:

package/dist/cli.js

@@ -36,11 +36,9 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 const commander_1 = require("commander");
 const log = __importStar(require("./ui/logger"));
+const link_1 = require("./commands/link");
 const serve_1 = require("./commands/serve");
-function collectBinEntry(value, previous = []) {
-    previous.push(value);
-    return previous;
-}
+const options_1 = require("./options");
 async function main() {
     // Commander orchestrates top-level commands/options and help output.
     const program = new commander_1.Command();
@@ -51,12 +49,21 @@ async function main() {
     program
         .command('serve')
         .description("Link this project's bin commands until symlx exits")
-        .option('--bin-dir <dir>', 'target bin directory (default: ~/.symlx/bin)')
-        .option('--collision <policy>', 'collision mode: prompt|skip|fail|overwrite', 'prompt')
-        .option('--bin-resolution-strategy <strategy>', 'bin precedence strategy: replace|merge', 'replace')
-        .option('--non-interactive', 'disable interactive prompts', false)
-        .option('--bin <name=path>', 'custom bin mapping (repeatable), e.g. --bin my-cli=dist/cli.js', collectBinEntry, [])
+        .option(...options_1.binDirOption)
+        .option(...options_1.collisionOption)
+        .option(...options_1.binResolutionStrategyOption)
+        .option(...options_1.nonInteractiveOption)
+        .option(...options_1.binOption)
         .action(serve_1.serveCommand);
+    program
+        .command('link')
+        .description("Link this project's bin commands once and exit")
+        .option(...options_1.binDirOption)
+        .option(...options_1.collisionOption)
+        .option(...options_1.binResolutionStrategyOption)
+        .option(...options_1.nonInteractiveOption)
+        .option(...options_1.binOption)
+        .action(link_1.linkCommand);
     await program.parseAsync(process.argv);
 }
 // Centralized fatal error boundary for command execution.

package/dist/commands/link.js

@@ -0,0 +1,66 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.linkCommand = linkCommand;
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const log = __importStar(require("../ui/logger"));
+const serve_output_1 = require("../ui/serve-output");
+const options_1 = require("../lib/options");
+const schema_1 = require("../lib/schema");
+const bin_targets_1 = require("../lib/bin-targets");
+const link_manager_1 = require("../lib/link-manager");
+const session_store_1 = require("../lib/session-store");
+const constants_1 = require("../lib/constants");
+async function linkCommand(inlineOptions) {
+    const cwd = process.cwd();
+    const homeDirectory = node_os_1.default.homedir();
+    const sessionDir = node_path_1.default.join(homeDirectory, '.symlx', 'sessions');
+    const options = (0, options_1.resolveOptions)(cwd, schema_1.serveInlineOptionsSchema, inlineOptions);
+    const internalCollisionOption = (0, options_1.resolveInternalCollisionOption)(options.collision, options.nonInteractive);
+    (0, session_store_1.cleanupStaleSessions)(sessionDir);
+    (0, session_store_1.ensureSymlxDirectories)(options.binDir, sessionDir);
+    (0, bin_targets_1.prepareBinTargets)(options.bin);
+    const linkResult = await (0, link_manager_1.createLinks)(options.bin, options.binDir, internalCollisionOption);
+    (0, link_manager_1.assertLinksCreated)(linkResult);
+    if (options.collision === 'prompt' && internalCollisionOption !== 'prompt') {
+        log.warn(constants_1.PROMPT_FALLBACK_WARNING);
+    }
+    (0, serve_output_1.printLinkOutcome)(options.binDir, linkResult);
+    (0, serve_output_1.printPathHintIfNeeded)(options.binDir, process.env.PATH);
+}

package/dist/commands/serve copy.js

@@ -0,0 +1,169 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serveCommand = serveCommand;
+const path_1 = __importDefault(require("path"));
+const node_os_1 = __importDefault(require("node:os"));
+const log = __importStar(require("../ui/logger"));
+const utils_1 = require("../lib/utils");
+const link_manager_1 = require("../lib/link-manager");
+const bin_targets_1 = require("../lib/bin-targets");
+const lifecycle_1 = require("../lib/lifecycle");
+const session_store_1 = require("../lib/session-store");
+const prompts_1 = require("../ui/prompts");
+const options_1 = require("../lib/options");
+const schema_1 = require("../lib/schema");
+// Prompts require an interactive terminal; scripts/CI should avoid prompt mode.
+function isInteractiveSession() {
+    return Boolean(process.stdin.isTTY && process.stdout.isTTY);
+}
+function prepareRuntimeDirectories(binDirectory, sessionDirectory) {
+    (0, session_store_1.ensureSymlxDirectories)(binDirectory, sessionDirectory);
+    (0, session_store_1.cleanupStaleSessions)(sessionDirectory);
+}
+function resolveRuntimeCollisionMode(options) {
+    if (options.collision !== 'prompt') {
+        return { policy: options.collision };
+    }
+    const canPromptForCollision = !options.nonInteractive && isInteractiveSession();
+    if (canPromptForCollision) {
+        return {
+            policy: 'prompt',
+            resolver: prompts_1.promptCollisionDecision,
+        };
+    }
+    log.warn('prompt collision mode requested but session is non-interactive; falling back to skip (use --collision overwrite|fail to avoid skips)');
+    return { policy: 'skip' };
+}
+function buildServeRuntime(options) {
+    const currentWorkingDirectory = process.cwd();
+    const sessionDirectory = path_1.default.join(node_os_1.default.homedir(), '.symlx', 'sessions');
+    prepareRuntimeDirectories(options.binDir, sessionDirectory);
+    (0, bin_targets_1.assertValidBinTargets)(options.bin);
+    return {
+        cwd: currentWorkingDirectory,
+        options,
+        sessionDirectory,
+        bins: new Map(Object.entries(options.bin)),
+        collisionMode: resolveRuntimeCollisionMode(options),
+    };
+}
+async function createRuntimeLinks(runtime) {
+    return (0, link_manager_1.createLinks)({
+        bins: runtime.bins,
+        binDir: runtime.options.binDir,
+        policy: runtime.collisionMode.policy,
+        collisionResolver: runtime.collisionMode.resolver,
+    });
+}
+function formatSkippedLinks(skippedLinks) {
+    const maxVisibleSkips = 5;
+    const visibleSkips = skippedLinks.slice(0, maxVisibleSkips);
+    const visibleSkipLines = visibleSkips
+        .map((skip) => `- ${skip.name}: ${skip.reason}`)
+        .join('\n');
+    const hiddenSkipsCount = skippedLinks.length - maxVisibleSkips;
+    const hiddenSkipsLine = hiddenSkipsCount > 0 ? `\n- ...and ${hiddenSkipsCount} more` : '';
+    return `${visibleSkipLines}${hiddenSkipsLine}`;
+}
+function assertLinkCreationSucceeded(linkResult) {
+    if (linkResult.created.length > 0) {
+        return;
+    }
+    if (linkResult.skipped.length === 0) {
+        throw new Error('no links were created');
+    }
+    throw new Error([
+        'no links were created because all candidate commands were skipped.',
+        formatSkippedLinks(linkResult.skipped),
+        'use --collision overwrite or --collision fail for stricter behavior.',
+    ].join('\n'));
+}
+function persistServeSession(runtime, links) {
+    const sessionPath = (0, session_store_1.createSessionFilePath)(runtime.sessionDirectory);
+    const record = {
+        pid: process.pid,
+        cwd: runtime.cwd,
+        createdAt: new Date().toISOString(),
+        links,
+    };
+    (0, session_store_1.persistSession)(sessionPath, record);
+    return { sessionPath, record };
+}
+function registerServeSessionCleanup(session) {
+    (0, lifecycle_1.registerLifecycleCleanup)(() => {
+        (0, session_store_1.cleanupSession)(session.sessionPath, session.record.links);
+    });
+}
+function reportLinkCreation(runtime, linkResult) {
+    const createdLinks = linkResult.created;
+    log.info(`linked ${createdLinks.length} command${createdLinks.length > 1 ? 's' : ''} into ${runtime.options.binDir}`);
+    for (const link of createdLinks) {
+        log.info(`${link.name} -> ${link.target}`);
+    }
+    for (const skippedLink of linkResult.skipped) {
+        log.warn(`skip "${skippedLink.name}": ${skippedLink.reason} (${skippedLink.linkPath})`);
+    }
+}
+function reportPathHint(binDirectory) {
+    if ((0, utils_1.pathContainsDir)(process.env.PATH, binDirectory)) {
+        return;
+    }
+    log.info(`add this to your shell config if needed:\nexport PATH="${binDirectory}:$PATH"`);
+}
+function waitUntilProcessExit() {
+    return new Promise(() => {
+        setInterval(() => undefined, 60_000);
+    });
+}
+async function run(options) {
+    const runtime = buildServeRuntime(options);
+    const linkResult = await createRuntimeLinks(runtime);
+    assertLinkCreationSucceeded(linkResult);
+    const session = persistServeSession(runtime, linkResult.created);
+    registerServeSessionCleanup(session);
+    reportLinkCreation(runtime, linkResult);
+    reportPathHint(runtime.options.binDir);
+    log.info('running. press Ctrl+C to cleanup links.');
+    await waitUntilProcessExit();
+}
+function serveCommand(inlineOptions) {
+    const currentWorkingDirectory = process.cwd();
+    const options = (0, options_1.resolveOptions)(currentWorkingDirectory, schema_1.serveInlineOptionsSchema, inlineOptions);
+    return run(options);
+}

package/dist/commands/serve.js

@@ -37,124 +37,46 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.serveCommand = serveCommand;
-const path_1 = __importDefault(require("path"));
 const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
 const log = __importStar(require("../ui/logger"));
-const utils_1 = require("../lib/utils");
-const link_manager_1 = require("../lib/link-manager");
-const bin_targets_1 = require("../lib/bin-targets");
-const lifecycle_1 = require("../lib/lifecycle");
-const session_store_1 = require("../lib/session-store");
-const prompts_1 = require("../ui/prompts");
+const serve_output_1 = require("../ui/serve-output");
 const options_1 = require("../lib/options");
 const schema_1 = require("../lib/schema");
-// Prompts require an interactive terminal; scripts/CI should avoid prompt mode.
-function isInteractiveSession() {
-    return Boolean(process.stdin.isTTY && process.stdout.isTTY);
-}
-function prepareRuntimeDirectories(binDir, sessionDir) {
-    (0, session_store_1.cleanupStaleSessions)(sessionDir);
-    (0, session_store_1.ensureSymlxDirectories)(binDir, sessionDir);
-}
-function resolveCollisionHandling(options) {
-    if (options.collision !== 'prompt') {
-        return { policy: options.collision };
-    }
-    const canPrompt = !options.nonInteractive && isInteractiveSession();
-    if (!canPrompt) {
-        log.warn('prompt collision mode requested but session is non-interactive; falling back to skip (use --collision overwrite|fail to avoid skips)');
-        return { policy: 'skip' };
-    }
-    return {
-        policy: 'prompt',
-        collisionResolver: prompts_1.promptCollisionDecision,
-    };
-}
-async function linkCommands(options, collisionHandling) {
-    return (0, link_manager_1.createLinks)({
-        bins: new Map(Object.entries(options.bin)),
-        binDir: options.binDir,
-        policy: collisionHandling.policy,
-        collisionResolver: collisionHandling.collisionResolver,
-    });
-}
-function ensureLinksWereCreated(linkResult) {
-    if (linkResult.created.length === 0) {
-        if (linkResult.skipped.length === 0) {
-            throw new Error('no links were created');
-        }
-        const details = linkResult.skipped
-            .slice(0, 5)
-            .map((skip) => `- ${skip.name}: ${skip.reason}`)
-            .join('\n');
-        const remainingCount = linkResult.skipped.length - 5;
-        const remaining = remainingCount > 0 ? `\n- ...and ${remainingCount} more` : '';
-        throw new Error([
-            'no links were created because all candidate commands were skipped.',
-            details,
-            `${remaining}\nuse --collision overwrite or --collision fail for stricter behavior.`,
-        ].join('\n'));
-    }
-}
-function persistActiveSession(params) {
-    const { sessionDir, cwd, links } = params;
-    const sessionPath = (0, session_store_1.createSessionFilePath)(sessionDir);
-    const sessionRecord = {
-        pid: process.pid,
-        cwd,
-        createdAt: new Date().toISOString(),
-        links,
-    };
-    (0, session_store_1.persistSession)(sessionPath, sessionRecord);
-    return { sessionPath, sessionRecord };
-}
-function registerSessionCleanup(sessionPath, links) {
-    (0, lifecycle_1.registerLifecycleCleanup)(() => {
-        (0, session_store_1.cleanupSession)(sessionPath, links);
-    });
-}
-function printLinkOutcome(binDir, linkResult) {
-    const createdLinks = linkResult.created;
-    log.info(`linked ${createdLinks.length} command${createdLinks.length > 1 ? 's' : ''} into ${binDir}`);
-    for (const link of createdLinks) {
-        log.info(`${link.name} -> ${link.target}`);
-    }
-    for (const skip of linkResult.skipped) {
-        log.warn(`skip "${skip.name}": ${skip.reason} (${skip.linkPath})`);
-    }
-}
-function printPathHintIfNeeded(binDir) {
-    if ((0, utils_1.pathContainsDir)(process.env.PATH, binDir)) {
-        return;
-    }
-    log.info(`add this to your shell config if needed:\nexport PATH="${binDir}:$PATH"`);
-}
-function waitIndefinitely() {
+const bin_targets_1 = require("../lib/bin-targets");
+const link_manager_1 = require("../lib/link-manager");
+const session_store_1 = require("../lib/session-store");
+const constants_1 = require("../lib/constants");
+function waitUntilStopped() {
     return new Promise(() => {
         setInterval(() => undefined, 60_000);
     });
 }
-async function run(options) {
-    const cwd = process.cwd();
-    const sessionDir = path_1.default.join(node_os_1.default.homedir(), '.symlx', 'sessions');
-    prepareRuntimeDirectories(options.binDir, sessionDir);
-    (0, bin_targets_1.assertValidBinTargets)(options.bin);
-    const collisionHandling = resolveCollisionHandling(options);
-    const linkResult = await linkCommands(options, collisionHandling);
-    ensureLinksWereCreated(linkResult);
-    const { sessionPath, sessionRecord } = persistActiveSession({
-        sessionDir,
-        cwd,
-        links: linkResult.created,
-    });
-    registerSessionCleanup(sessionPath, sessionRecord.links);
-    printLinkOutcome(options.binDir, linkResult);
-    printPathHintIfNeeded(options.binDir);
-    log.info('running. press Ctrl+C to cleanup links.');
-    await waitIndefinitely();
-}
-function serveCommand(inlineOptions) {
+async function serveCommand(inlineOptions) {
     const cwd = process.cwd();
+    const homeDirectory = node_os_1.default.homedir();
+    const sessionDir = node_path_1.default.join(homeDirectory, '.symlx', 'sessions');
+    // resolve options by merge or otherwise and resolve collision based on interactiveness
     const options = (0, options_1.resolveOptions)(cwd, schema_1.serveInlineOptionsSchema, inlineOptions);
-    return run(options);
+    const internalCollisionOption = (0, options_1.resolveInternalCollisionOption)(options.collision, options.nonInteractive);
+    // prepare
+    (0, session_store_1.cleanupStaleSessions)(sessionDir);
+    (0, session_store_1.ensureSymlxDirectories)(options.binDir, sessionDir);
+    (0, bin_targets_1.prepareBinTargets)(options.bin);
+    // link creation
+    const linkResult = await (0, link_manager_1.createLinks)(options.bin, options.binDir, internalCollisionOption);
+    (0, link_manager_1.assertLinksCreated)(linkResult);
+    // session management
+    const sessionPath = (0, session_store_1.generateSessionFilePath)(sessionDir);
+    const sessionRecord = (0, session_store_1.generateSessionRecord)(cwd, linkResult.created);
+    (0, session_store_1.persistSession)(sessionPath, sessionRecord);
+    (0, session_store_1.registerLifecycleSessionCleanup)(sessionPath, sessionRecord.links);
+    // logs
+    if (options.collision === 'prompt' && internalCollisionOption !== 'prompt') {
+        log.warn(constants_1.PROMPT_FALLBACK_WARNING);
+    }
+    (0, serve_output_1.printLinkOutcome)(options.binDir, linkResult);
+    (0, serve_output_1.printPathHintIfNeeded)(options.binDir, process.env.PATH);
+    log.info('running. press Ctrl+C to cleanup links.');
+    await waitUntilStopped();
 }