113 lines
4.7 KiB
JavaScript
113 lines
4.7 KiB
JavaScript
'use strict';
|
|
|
|
const { canonicalizeRuntimeName, resolveRuntimeNameFromCandidates } = require('./runtime-name-policy.cjs');
|
|
|
|
/**
|
|
* runtime-slash.cjs — single source of truth for emitting GSD slash-command
|
|
* references in user-facing runtime output (recommended-actions JSON, persisted
|
|
* ROADMAP.md entries, verify/validate fix hints, error messages, etc.).
|
|
*
|
|
* Background: #2808 unified all GSD skill installs to register under the hyphen
|
|
* form (`name: gsd-<cmd>`). The legacy colon form `/gsd:<cmd>` is no longer
|
|
* routable by Claude Code skill installs, but ~50 runtime emissions in
|
|
* bin/lib/*.cjs still hardcoded it (#3584). Codex installs need the shell-var
|
|
* `$gsd-<cmd>` form. This module is the only place the runtime should decide
|
|
* which shape to emit.
|
|
*
|
|
* - codex: $gsd-<cmd> (shell-var syntax)
|
|
* - claude, cursor, opencode, kilo, etc.: /gsd-<cmd>
|
|
*
|
|
* The colon form is never emitted.
|
|
*/
|
|
|
|
function formatGsdSlash(commandName, runtime) {
|
|
if (typeof commandName !== 'string') return commandName;
|
|
if (commandName === '') return commandName;
|
|
|
|
// Strip any existing leading prefix so the helper is idempotent and accepts
|
|
// both legacy `/gsd:<name>` and canonical hyphen-form input (plus the bare
|
|
// `gsd:<name>` shorthand and codex `$gsd-<name>` shell-var input).
|
|
const stripped = commandName.replace(/^[/$]?gsd[-:]/i, '');
|
|
// If the regex matched nothing (no prefix), the input is already a bare name.
|
|
const bare = stripped === commandName ? commandName : stripped;
|
|
// Defensive: a degenerate input like `/gsd:`, `gsd-`, or whitespace-only
|
|
// normalizes to empty. Returning the original colon-form would re-emit the
|
|
// deprecated shape that this module exists to suppress (#3584). Return an
|
|
// empty string so callers see "no command" rather than the broken input.
|
|
if (bare === '' || bare.trim() === '') return '';
|
|
|
|
// Split on the first whitespace so only the command token is rewritten —
|
|
// anything after the first space is caller-supplied arguments (phase
|
|
// numbers, --flags, --paths C:\\Users\\Me, etc.) that must round-trip
|
|
// untouched. Codex lowercases only the command token; preserving the
|
|
// argument tail prevents path/flag corruption on case-sensitive systems.
|
|
const wsMatch = bare.match(/^(\S+)(\s[\s\S]*)?$/);
|
|
const token = wsMatch ? wsMatch[1] : bare;
|
|
const tail = wsMatch && wsMatch[2] ? wsMatch[2] : '';
|
|
|
|
const runtimeText = String(runtime || 'claude').toLowerCase();
|
|
const rt = canonicalizeRuntimeName(runtimeText) || runtimeText;
|
|
if (rt === 'codex') {
|
|
// Codex skills are invoked as $gsd-<cmd> (shell-var syntax). The command
|
|
// token is lowercased because shell-var identifiers are conventionally
|
|
// lowercase; matches the convertCodexSlash() projection in bin/install.js.
|
|
return `$gsd-${token.toLowerCase()}${tail}`;
|
|
}
|
|
return `/gsd-${token}${tail}`;
|
|
}
|
|
|
|
/**
|
|
* Resolve the effective runtime for a project directory.
|
|
*
|
|
* process.env.GSD_RUNTIME > config.runtime > 'claude'
|
|
*
|
|
* Mirrors the precedence already used by profile-output.cjs and the rest of
|
|
* the runtime resolution chain. Returns a lowercased string so downstream
|
|
* comparisons can be case-blind.
|
|
*
|
|
* @param {string|null|undefined} projectDir
|
|
* @returns {string}
|
|
*/
|
|
function resolveRuntime(projectDir) {
|
|
const envRuntime = resolveRuntimeNameFromCandidates(process.env.GSD_RUNTIME);
|
|
if (envRuntime) return envRuntime;
|
|
if (projectDir) {
|
|
try {
|
|
// Read config.json directly (not via loadConfig). loadConfig has a side
|
|
// effect of normalizing and re-writing legacy keys back to disk, which
|
|
// would mutate the project file just to read the runtime name. We only
|
|
// need the literal `runtime:` value, so a plain JSON read is sufficient
|
|
// and side-effect-free.
|
|
const fs = require('fs');
|
|
const path = require('path');
|
|
const configPath = path.join(projectDir, '.planning', 'config.json');
|
|
if (fs.existsSync(configPath)) {
|
|
const raw = fs.readFileSync(configPath, 'utf-8');
|
|
const parsed = JSON.parse(raw);
|
|
if (parsed && typeof parsed === 'object' && parsed.runtime) {
|
|
const configRuntime = resolveRuntimeNameFromCandidates(parsed.runtime);
|
|
if (configRuntime) return configRuntime;
|
|
}
|
|
}
|
|
} catch {
|
|
// Fall through to default — a missing/broken config must not crash
|
|
// runtime output formatting.
|
|
}
|
|
}
|
|
return 'claude';
|
|
}
|
|
|
|
/**
|
|
* Convenience: format using the runtime resolved from a project directory.
|
|
* Equivalent to `formatGsdSlash(name, resolveRuntime(projectDir))`.
|
|
*/
|
|
function formatGsdSlashFor(projectDir, commandName) {
|
|
return formatGsdSlash(commandName, resolveRuntime(projectDir));
|
|
}
|
|
|
|
module.exports = {
|
|
formatGsdSlash,
|
|
resolveRuntime,
|
|
formatGsdSlashFor,
|
|
};
|