@sap/cds-dk 10.1.2 → 10.2.0

package/bin/completion/index.js

@@ -1,6 +1,3 @@
-const fs = require('node:fs');
-const path = require('node:path');
-
 const cds = require('../../bin/cds');
 const { bold } = require('../../lib/util/term');
 const completionFs = require('./completionFs');
@@ -23,9 +20,13 @@ module.exports = Object.assign(completion, {
     FILE,
     DIR,
     COMMA,
+    // Exposed for the build-time script generator
+    buildCompletionMap,
+    filePs1,
+    POSITIONAL_KEY,
     options: ['--shell', '--curr', '--line', '--prev'],
     shortcuts: ['-s'],
-    flags: ['--add', '--profile', '--generate', '--remove'],
+    flags: ['--add', '--profile', '--remove'],
     help: `
 # SYNOPSIS
 
@@ -60,10 +61,6 @@ module.exports = Object.assign(completion, {
     *--profile* _(deprecated)_
         Print the path to the completion script for the given shell.
 
-    *--generate*
-        Generate a static completion script for the given shell and print it to stdout.
-        Used by 'npm run build:completion' to pre-build the bundled cache files.
-
     *--shell* <bash | fish | gitbash | ps | zsh>
         Force the shell completion code to be added to the correct shell profile file.
             bash: macOS, Linux, WSL
@@ -85,45 +82,17 @@ module.exports = Object.assign(completion, {
 
 `});
 
-function getScriptFile(shell) {
-    switch (shell) {
-        case 'bash':
-        case 'gitbash': return 'cds.sh';
-        case 'fish':    return 'cds.fish';
-        case 'ps':      return 'cds.ps1';
-        case 'zsh':     return 'cds.zsh';
-        default:
-            if (!shell) throw 'Internal error: option --shell is missing';
-            throw `Internal error: unsupported shell: ${shell}, supported shells are ${completionSetup.supportedShells.join(', ')}`;
-    }
+async function install(options) {
+    await completionSetup.setup(options.add, options);
 }
 
 async function completion(_argv, options) {
     if (options.profile) {
-        const scriptFile = getScriptFile(options.shell);
-        return console.log(path.join(__dirname, 'scripts', scriptFile));
-    }
-
-    if (options.generate) {
-        if (options.shell) {
-            const content = await generateStaticScript(options.shell);
-            return content ? process.stdout.write(content) : undefined;
-        }
-        const shells = { sh: 'bash', zsh: 'zsh', fish: 'fish', ps1: 'ps' };
-        const scriptsDir = path.join(__dirname, 'scripts');
-        fs.mkdirSync(scriptsDir, { recursive: true });
-        for (const [ext, shell] of Object.entries(shells)) {
-            const content = await generateStaticScript(shell);
-            if (content) {
-                fs.writeFileSync(path.join(scriptsDir, `cds.${ext}`), content);
-                console.log(`Generated cds.${ext}`);
-            }
-        }
-        return;
+        return console.log(completionSetup.resolveScriptPath(options.shell));
     }
 
     if (options.add || options.remove) {
-        await completionSetup.setup(options.add, options);
+        await install(options);
         return;
     }
 
@@ -154,6 +123,7 @@ async function completion(_argv, options) {
     reply(completions);
 }
 
+// Serializes every command's completion metadata into one map; consumed by the build-time script generator in .github/scripts/completion.
 async function buildCompletionMap() {
     const commands = cds.cmds ?? [];
     const commandMap = {};
@@ -190,414 +160,6 @@ async function buildCompletionMap() {
     return { commands, shortcuts: cds.Shortcuts, commandMap };
 }
 
-async function generateStaticScript(shell) {
-    const map = await buildCompletionMap();
-    switch (shell) {
-        case 'bash':
-        case 'gitbash': return generateBash(map);
-        case 'zsh':     return generateZsh(map);
-        case 'fish':    return generateFish(map);
-        case 'ps':      return generatePs(map);
-        default:
-            throw `Internal error: unsupported shell: ${shell}`;
-    }
-}
-
-// --- Code generation helpers ---
-
-// Serialises an array of strings for embedding in a shell word-list (e.g. compgen -W "...").
-function shellQuoteList(arr) {
-    return arr.map(s => JSON.stringify(s)).join(' ');
-}
-
-// Returns the single-char shortcuts from the global shortcuts map.
-function singleCharShortcuts(shortcuts) {
-    return Object.entries(shortcuts).filter(([k]) => /^[a-z]$/.test(k));
-}
-
-// Returns the merged, deduplicated, sorted list of all flags/options for a command.
-function sortedFlags(e) {
-    return [...new Set([...e.options, ...e.flags])].sort();
-}
-
-// Generates the bash/zsh case block that resolves single-char shortcuts to canonical names.
-function shortcutCaseBlock(shortcuts, indent = '    ') {
-    const entries = singleCharShortcuts(shortcuts)
-        .map(([k, v]) => `${indent}    ${k}) cmd=${v} ;;`)
-        .join('\n');
-    if (!entries) return '';
-    return `${indent}case "$cmd" in\n${entries}\n${indent}esac\n`;
-}
-
-// Bash: expression that completes to files matching a sentinel's extensions.
-function bashFileExpr(sentinel) {
-    if (!sentinel.ext) return 'compgen -f -- "$current"';
-    const files = `compgen -f -- "$current" | grep -E '\\.(${sentinel.ext.join('|')})$'`;
-    if (!sentinel.dirs) return files;
-    return `{ ${files}; compgen -d -- "$current"; }`;
-}
-
-// Zsh: compadd call that completes to files matching a sentinel's extensions.
-// _path_files is used instead of _files to avoid the '*:all-files' fallback tier
-// that _files always appends, which would show every file type regardless of the glob.
-// Multiple extensions are passed as space-separated patterns in one -g argument
-// (e.g. '*.cds *.json') — _path_files word-splits the value, no extendedglob needed.
-function zshFileComp(sentinel) {
-    if (!sentinel.ext) return '_path_files';
-    const glob = sentinel.ext.map(e => `*.${e}`).join(' ');
-    if (!sentinel.dirs) return `_path_files -g '${glob}'`;
-    return `_path_files -g '${glob}' -/`;
-}
-
-// Fish: expression that completes to files matching a sentinel's extensions.
-function fishFileComp(sentinel) {
-    if (!sentinel.ext) return '__fish_complete_path';
-    const files = `string match -r '\\.(${sentinel.ext.join('|')})\\$' -- (__fish_complete_path)`;
-    if (!sentinel.dirs) return files;
-    return `${files}; __fish_complete_directories`;
-}
-
-// Reads a shell template and substitutes {{PLACEHOLDER}} tokens.
-// Note: replacement strings go through String.replaceAll, so '$' must be doubled
-// ('$$$$' → '$$' → '$') to prevent JS from interpreting '$1' etc. as back-references.
-async function applyTemplate(templateFile, replacements) {
-    const tmpl = await fs.promises.readFile(path.join(__dirname, 'templates', templateFile), 'utf8');
-    return Object.entries(replacements).reduce(
-        (s, [k, v]) => s.replaceAll(`{{${k}}}`, v.replaceAll('$', '$$$$')),
-        tmpl
-    );
-}
-
-// --- Per-shell case-block generators ---
-
-// Bash/zsh: option-value completions (previous word is a known flag → offer its values).
-function optionValueCases(commandMap, emitLine) {
-    return Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const innerLines = [];
-            for (const [flag, val] of Object.entries(e.optionValues ?? {})) {
-                innerLines.push(emitLine(flag, val, null));
-            }
-            for (const [flag, sentinel] of Object.entries(e.fileCases ?? {})) {
-                if (flag === POSITIONAL_KEY) continue;
-                innerLines.push(emitLine(flag, null, sentinel));
-            }
-            if (!innerLines.length) return '';
-            return `        ${cmd})\n            case "$previous" in\n${innerLines.join('\n')}\n            esac ;;\n`;
-        })
-        .filter(Boolean)
-        .join('');
-}
-
-function bashOptionValueCases(commandMap) {
-    return optionValueCases(commandMap, (flag, val, sentinel) => {
-        const expr = sentinel
-            ? (sentinel === DIR() ? 'compgen -d -- "$current"' : bashFileExpr(sentinel))
-            : `compgen -W "${shellQuoteList(val)}" -- "$current"`;
-        return `            ${flag}) COMPREPLY=( $(${expr}) ) ; return 0 ;;`;
-    });
-}
-
-function zshOptionValueCases(commandMap) {
-    return optionValueCases(commandMap, (flag, val, sentinel) => {
-        const comp = sentinel
-            ? (sentinel === DIR() ? '_files -/' : zshFileComp(sentinel))
-            : `compadd -S '' -- ${shellQuoteList([...val].sort())}`;
-        const prefix = sentinel ? `compstate[nomatches]='' ; ` : '';
-        return `            ${flag}) ${prefix}${comp} ; return ;;`;
-    });
-}
-
-// Bash/zsh: comma-separated option completions.
-// Entries keyed by POSITIONAL_KEY match any previous word (when user didn't type a flag);
-// a guard skips them if the previous word is itself a flag (consuming an option value).
-function bashCommaCases(commandMap) {
-    const S = '$'; // prevent JS template literal from interpolating shell variables
-    return Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            // Sort so POSITIONAL_KEY ('_') entries come last — they use a catch-all pattern.
-            const entries = Object.entries(e.commaCases ?? {}).sort(([a], [b]) =>
-                a === POSITIONAL_KEY ? 1 : b === POSITIONAL_KEY ? -1 : 0
-            );
-            if (!entries.length) return '';
-            const innerLines = entries.map(([flag, val]) => {
-                const list    = shellQuoteList(val);
-                const pattern = flag === POSITIONAL_KEY ? '*' : flag;
-                // For positional entries: skip if previous word looks like a flag (it's consuming a value).
-                const guard   = flag === POSITIONAL_KEY
-                    ? `                [[ "$previous" == -* ]] && return 0\n`
-                    : '';
-                const body = [
-                    guard + `                local prefix="" partial="" IFS=,`,
-                    `                if [[ "$current" == *,* ]]; then`,
-                    `                    prefix="` + S + `{current%,*},"`,
-                    `                    partial="` + S + `{current##*,}"`,
-                    `                else`,
-                    `                    partial="$current"`,
-                    `                fi`,
-                    `                local -a _used`,
-                    `                read -ra _used <<< "` + S + `{prefix%,}"`,
-                    `                local _all=(${list})`,
-                    `                for v in "` + S + `{_all[@]}"; do`,
-                    `                    [[ " ` + S + `{_used[*]} " == *" $v "* ]] && continue`,
-                    `                    [[ "$v" == "$partial"* ]] && COMPREPLY+=("$prefix$v")`,
-                    `                done`,
-                    `                [[ ` + S + `{#COMPREPLY[@]} -gt 0 ]] && { compopt -o nospace; return 0; } ;;`,
-                ].join('\n');
-                return `            ${pattern})\n${body}`;
-            });
-            return `        ${cmd})\n            case "$previous" in\n${innerLines.join('\n')}\n            esac ;;\n`;
-        })
-        .filter(Boolean)
-        .join('');
-}
-
-function zshCommaCases(commandMap) {
-    const S = '$'; // prevent JS template literal from interpolating shell variables
-    return Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const entries = Object.entries(e.commaCases ?? {}).sort(([a], [b]) =>
-                a === POSITIONAL_KEY ? 1 : b === POSITIONAL_KEY ? -1 : 0
-            );
-            if (!entries.length) return '';
-            const innerLines = entries.map(([flag, val]) => {
-                const list    = shellQuoteList(val);
-                const pattern = flag === POSITIONAL_KEY ? `*)` : `${flag})`;
-                // For positional entries: skip if previous word looks like a flag (it's consuming a value).
-                const guard   = flag === POSITIONAL_KEY
-                    ? `                [[ "$previous" == -* ]] && return\n`
-                    : '';
-                const body = [
-                    guard + `                local -a _used=("` + S + `{(s:,:)current}")`,
-                    `                local prefix="` + S + `{(j:,:)_used[1,-2]}" partial="` + S + `{_used[-1]}"`,
-                    `                [[ -n "$prefix" ]] && prefix="$prefix,"`,
-                    `                local -a _all=(${list}) _result=()`,
-                    `                for v in "` + S + `{_all[@]}"; do`,
-                    `                    (( ` + S + `{_used[(Ie)$v]} )) && continue`,
-                    `                    [[ "$v" == "$partial"* ]] && _result+=("$v")`,
-                    `                done`,
-                    `                compadd -p "$prefix" -S '' -- "` + S + `{_result[@]}" ; return ;;`,
-                ].join('\n');
-                return `            ${pattern}\n${body}`;
-            });
-            return `        ${cmd})\n            case "$previous" in\n${innerLines.join('\n')}\n            esac ;;\n`;
-        })
-        .filter(Boolean)
-        .join('');
-}
-
-// --- Static script generators ---
-
-async function generateBash(map) {
-    const { commands, shortcuts, commandMap } = map;
-
-    const flagCases = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const flags = sortedFlags(e);
-            if (!flags.length) return '';
-            return `            ${cmd}) COMPREPLY=( $(compgen -W "${shellQuoteList(flags)}" -- "$current") ) ;;`;
-        })
-        .filter(Boolean)
-        .join('\n');
-
-    const fileCases = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const sentinel = e.fileCases?.[POSITIONAL_KEY];
-            if (!sentinel) return '';
-            const expr = sentinel === DIR() ? 'compgen -d -- "$current"' : bashFileExpr(sentinel);
-            return `            ${cmd}) COMPREPLY=( $(${expr}) ) ;;`;
-        })
-        .filter(Boolean)
-        .join('\n');
-
-    const stringPositionalCases = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            if (e.fileCases?.[POSITIONAL_KEY] || !e.positionals?.length) return '';
-            return `            ${cmd}) COMPREPLY=( $(compgen -W "${shellQuoteList([...e.positionals].sort())}" -- "$current") ) ;;`;
-        })
-        .filter(Boolean)
-        .join('\n');
-
-    return applyTemplate('cds-tmpl.sh', {
-        SHORTCUT_CASE:           shortcutCaseBlock(shortcuts),
-        COMMANDS:                shellQuoteList(commands),
-        FLAG_CASES:              flagCases,
-        OPTION_VALUE_CASES:      bashOptionValueCases(commandMap),
-        COMMA_CASES:             bashCommaCases(commandMap),
-        FILE_CASES:              fileCases,
-        STRING_POSITIONAL_CASES: stringPositionalCases,
-    });
-}
-
-async function generateZsh(map) {
-    const { commands, shortcuts, commandMap } = map;
-
-    const flagCases = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const flags = sortedFlags(e);
-            if (!flags.length) return '';
-            return `        ${cmd}) compadd -S '' -- ${shellQuoteList(flags)} ;;`;
-        })
-        .filter(Boolean)
-        .join('\n');
-
-    const fileCases = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const sentinel = e.fileCases?.[POSITIONAL_KEY];
-            if (!sentinel) return '';
-            const comp = sentinel === DIR() ? '_files -/' : zshFileComp(sentinel);
-            return `        ${cmd}) compstate[nomatches]='' ; ${comp} ; return ;;`;
-        })
-        .filter(Boolean)
-        .join('\n');
-
-    const stringPositionalCases = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            if (e.fileCases?.[POSITIONAL_KEY] || !e.positionals?.length) return '';
-            return `        ${cmd}) compadd -S '' -- ${shellQuoteList([...e.positionals].sort())} ; return ;;`;
-        })
-        .filter(Boolean)
-        .join('\n');
-
-    return applyTemplate('cds-tmpl.zsh', {
-        SHORTCUT_CASE:           shortcutCaseBlock(shortcuts),
-        COMMANDS:                shellQuoteList(commands),
-        FLAG_CASES:              flagCases,
-        OPTION_VALUE_CASES:      zshOptionValueCases(commandMap),
-        COMMA_CASES:             zshCommaCases(commandMap),
-        FILE_CASES:              fileCases,
-        STRING_POSITIONAL_CASES: stringPositionalCases,
-    });
-}
-
-async function generateFish(map) {
-    const { commands, shortcuts, commandMap } = map;
-
-    // Reverse map: canonical command name → its single-char shortcut(s).
-    const cmdShortcuts = {};
-    for (const [shortcut, cmd] of singleCharShortcuts(shortcuts)) {
-        (cmdShortcuts[cmd] ??= []).push(shortcut);
-    }
-
-    // Fish condition: fires when the subcommand (or one of its shortcuts) is already on the line.
-    const seenCmd = (cmd) =>
-        `__fish_seen_subcommand_from ${[cmd, ...(cmdShortcuts[cmd] ?? [])].join(' ')}`;
-
-    const allCmdsAndShortcuts = [
-        ...commands,
-        ...singleCharShortcuts(shortcuts).map(([k]) => k),
-    ].join(' ');
-
-    const lines = [];
-
-    // Top-level commands — only shown before any subcommand is committed.
-    for (const cmd of commands) {
-        lines.push(`complete -c cds -f -n '__fish_use_subcommand' -a '${cmd}'`);
-    }
-
-    for (const [cmd, e] of Object.entries(commandMap)) {
-        const hasFileSentinel = !!e.fileCases?.[POSITIONAL_KEY];
-
-        // File-sentinel positionals (e.g. *.cds, *.json for compile).
-        for (const [flag, sentinel] of Object.entries(e.fileCases ?? {})) {
-            const fishComp = sentinel === DIR() ? '__fish_complete_directories' : fishFileComp(sentinel);
-            const cond = flag === POSITIONAL_KEY
-                ? seenCmd(cmd)
-                : `${seenCmd(cmd)} && __fish_prev_arg_in ${flag}`;
-            lines.push(`complete -c cds -f -n '${cond}' -a "(${fishComp})"`);
-        }
-
-        // String positionals (e.g. command names for `cds help`).
-        for (const pos of [...(e.positionals ?? [])].sort()) {
-            lines.push(`complete -c cds -f -n '${seenCmd(cmd)}' -a '${pos}'`);
-        }
-
-        // Flags — gated on current token starting with '-' when a file sentinel is present,
-        // so that `cds compile <tab>` shows files only and `cds compile --<tab>` shows flags.
-        const flagCond = hasFileSentinel
-            ? `${seenCmd(cmd)} && string match -q -- "-*" (commandline -ct)`
-            : seenCmd(cmd);
-        for (const token of sortedFlags(e)) {
-            lines.push(`complete -c cds -f -n '${flagCond}' -a '${token}'`);
-        }
-
-        // Option values (previous word is a known flag → offer its static values).
-        for (const [flag, val] of Object.entries(e.optionValues ?? {})) {
-            lines.push(`complete -c cds -f -n '${seenCmd(cmd)} && __fish_prev_arg_in ${flag}' -a '${[...val].sort().join(' ')}'`);
-        }
-
-        // Comma-separated values — delegated to the _cdsCommaComplete helper in the template.
-        for (const [flag, val] of Object.entries(e.commaCases ?? {})) {
-            const values = [...val].sort().join(' ');
-            const cond = flag === POSITIONAL_KEY
-                ? seenCmd(cmd)
-                : `${seenCmd(cmd)} && __fish_prev_arg_in ${flag}`;
-            lines.push(`complete -c cds -f -n '${cond}' -a "(_cdsCommaComplete ${values})"`);
-        }
-    }
-
-    return applyTemplate('cds-tmpl.fish', {
-        COMMAND_COMPLETIONS:     lines.join('\n'),
-        CMD_LIST:                commands.join(' '),
-        CMD_LIST_WITH_SHORTCUTS: allCmdsAndShortcuts,
-    });
-}
-
-async function generatePs(map) {
-    const { commands, shortcuts, commandMap } = map;
-
-    const cmdArray = commands.map(c => `'${c}'`).join(', ');
-
-    const shortcutEntries = singleCharShortcuts(shortcuts)
-        .map(([k, v]) => `    '${k}' = '${v}'`)
-        .join(";\n");
-
-    const cmdEntries = Object.entries(commandMap)
-        .map(([cmd, e]) => {
-            const flags = sortedFlags(e).map(t => `'${t}'`).join(', ');
-            return `    '${cmd}' = @(${flags})`;
-        })
-        .join(";\n");
-
-    const positionalEntries = Object.entries(commandMap)
-        .filter(([, e]) => e.positionals?.length)
-        .map(([cmd, e]) => `    '${cmd}' = @(${[...e.positionals].sort().map(p => `'${p}'`).join(', ')})`)
-        .join(";\n");
-
-    const optionValueEntries = Object.entries(commandMap)
-        .filter(([, e]) => Object.keys(e.optionValues ?? {}).length || Object.keys(e.fileCases ?? {}).length)
-        .map(([cmd, e]) => {
-            const inner = [];
-            for (const [flag, val] of Object.entries(e.optionValues ?? {})) {
-                inner.push(`        '${flag}' = @(${[...val].sort().map(v => `'${v}'`).join(', ')})`);
-            }
-            for (const [flag, sentinel] of Object.entries(e.fileCases ?? {})) {
-                inner.push(`        '${flag}' = ${filePs1(sentinel)}`);
-            }
-            return `    '${cmd}' = @{\n${inner.join(";\n")}\n    }`;
-        })
-        .join(";\n");
-
-    const commaEntries = Object.entries(commandMap)
-        .filter(([, e]) => Object.keys(e.commaCases ?? {}).length)
-        .map(([cmd, e]) => {
-            const inner = Object.entries(e.commaCases).map(([flag, val]) =>
-                `        '${flag}' = @(${[...val].sort().map(v => `'${v}'`).join(', ')})`
-            );
-            return `    '${cmd}' = @{\n${inner.join(";\n")}\n    }`;
-        })
-        .join(";\n");
-
-    return applyTemplate('cds-tmpl.ps1', {
-        CMD_ARRAY:            cmdArray,
-        SHORTCUT_ENTRIES:     shortcutEntries,
-        POSITIONAL_ENTRIES:   positionalEntries,
-        OPTION_VALUE_ENTRIES: optionValueEntries,
-        COMMA_ENTRIES:        commaEntries,
-        CMD_ENTRIES:          cmdEntries,
-    });
-}
-
 // --- Completion engine ---
 
 function reply(values) {