@optique/core 1.0.15-dev.2824 → 1.0.15-dev.2835

package/dist/completion.cjs

@@ -62,6 +62,17 @@ function sanitizeForTransport(text) {
 	return text.replace(/[\t\n\r\0]/g, " ");
 }
 /**
+* Escapes literal values that would otherwise be interpreted as transport
+* directives.  Escape the escape prefix itself so decoding is unambiguous.
+* @param text The literal suggestion text.
+* @returns The sanitized and, if necessary, escaped literal text.
+* @internal
+*/
+function encodeLiteral(text) {
+	const sanitized = sanitizeForTransport(text);
+	return sanitized.startsWith("__FILE__:") || sanitized.startsWith("__LITERAL__:") ? `__LITERAL__:${sanitized}` : sanitized;
+}
+/**
 * The Bash shell completion generator.
 * @since 0.6.0
 */
@@ -308,10 +319,11 @@ function _${programName} () {
     __reply_prefix=""
     __file_current="$current"
     __literal=0
-    if [[ "$line" == __LITERAL__:* ]]; then
+    # Protocol tags are case-sensitive even when nocasematch is enabled.
+    if [ "\${line:0:12}" = '__LITERAL__:' ]; then
       line="\${line#__LITERAL__:}"
       __literal=1
-    elif [[ "$line" == __JOINED_FILE__:* ]]; then
+    elif [ "\${line:0:16}" = '__JOINED_FILE__:' ]; then
       line="\${line#__JOINED_FILE__:}"
       __reply_prefix="\${line%%:*}"
       __reply_prefix="\${__reply_prefix//%3A/:}"
@@ -332,7 +344,7 @@ function _${programName} () {
         __file_quote_offset=$((__file_quote_offset - \${#__reply_prefix}))
       fi
     fi
-    if [[ $__literal == 0 && "$line" == __FILE__:* ]]; then
+    if [ "$__literal" = 0 ] && [ "\${line:0:9}" = '__FILE__:' ]; then
       # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
       IFS=':' read -r _ type extensions pattern hidden <<< "$line"
       extensions="\${extensions//,\\./,}"; extensions="\${extensions#.}"
@@ -700,7 +712,12 @@ function _${programName.replace(/[^a-zA-Z0-9]/g, "_")} () {
       desc=\${line#*\$'\\0'}
       desc=\${desc%%\$'\\0'*}
 
-      if [[ "\$value" == __FILE__:* ]]; then
+      local __literal=0
+      if [[ "\$value" == __LITERAL__:* ]]; then
+        value="\${value#__LITERAL__:}"
+        __literal=1
+      fi
+      if [[ \$__literal == 0 && "\$value" == __FILE__:* ]]; then
         # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
         local type extensions pattern hidden
         IFS=':' read -r _ type extensions pattern hidden <<< "\$value"
@@ -816,7 +833,7 @@ fi
 	*encodeSuggestions(suggestions) {
 		for (const suggestion of suggestions) if (suggestion.kind === "literal") {
 			const description = suggestion.description == null ? "" : sanitizeForTransport(require_message.formatMessage(suggestion.description, { colors: false }));
-			yield `${sanitizeForTransport(suggestion.text)}\0${description}\0`;
+			yield `${encodeLiteral(suggestion.text)}\0${description}\0`;
 		} else {
 			const extensions = encodeExtensions(suggestion.extensions);
 			const hidden = suggestion.includeHidden ? "1" : "0";
@@ -875,7 +892,12 @@ function ${functionName}
 ${escapedArgs ? `    set -l output (${programName} ${escapedArgs} $prev $current 2>/dev/null)\n` : `    set -l output (${programName} $prev $current 2>/dev/null)\n`}
     # Process each line of output
     for line in $output
-        if string match -q '__FILE__:*' -- $line
+        set -l literal 0
+        if string match -q '__LITERAL__:*' -- $line
+            set line (string sub -s 13 -- $line)
+            set literal 1
+        end
+        if test $literal -eq 0; and string match -q '__FILE__:*' -- $line
             # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
             set -l directive (string split \\t -- $line)[1]
             set -l parts (string split ':' -- $directive)
@@ -1166,7 +1188,7 @@ complete -c ${programName} -f -a '(${functionName})'
 			if (i > 0) yield "\n";
 			if (suggestion.kind === "literal") {
 				const description = suggestion.description == null ? "" : sanitizeForTransport(require_message.formatMessage(suggestion.description, { colors: false }));
-				yield `${sanitizeForTransport(suggestion.text)}\t${description}`;
+				yield `${encodeLiteral(suggestion.text)}\t${description}`;
 			} else {
 				const extensions = encodeExtensions(suggestion.extensions);
 				const hidden = suggestion.includeHidden ? "1" : "0";
@@ -1405,8 +1427,10 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
   }
 
   # Process each line of output
-  $output | lines | each {|line|
-    if ($line | str starts-with '__FILE__:') {
+  $output | lines | each {|raw_line|
+    let literal = ($raw_line | str starts-with '__LITERAL__:')
+    let line = if $literal { $raw_line | str substring 12.. } else { $raw_line }
+    if (not $literal) and ($line | str starts-with '__FILE__:') {
       # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
       let directive = ($line | split row "\t" | first)
       let parts = ($directive | split row ':')
@@ -1466,22 +1490,26 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
       # Generate file completions based on type.
       # When the glob base contains wildcard characters, use it as-is;
       # otherwise append * to treat it as a prefix.
-      # Note: into glob is required so that ls expands wildcards from a variable
+      # Note: into glob is required so that ls expands wildcards from a variable.
+      # A literal prefix has its brackets wrapped as [[] and []] so that path
+      # text like "report[1]" is not parsed as a glob character class; a
+      # wildcard pattern is a glob as a whole, so its brackets stay classes.
       let has_glob = ($glob_base =~ '[*?]')
       let ls_pattern = if ($glob_base | is-empty) {
         "."
       } else if $has_glob {
         ($glob_base | into glob)
       } else {
-        ($glob_base + "*" | into glob)
+        (($glob_base | str replace -a -r '([\\[\\]])' '[$1]') + "*" | into glob)
       }
 
       # When using a glob pattern, also compute a directory listing pattern
-      # so that file/any modes can include directories for navigation
+      # so that file/any modes can include directories for navigation; its
+      # directory part is a literal path
       let glob_dir_pattern = if $has_glob {
         let dir_part = ($glob_base | path dirname)
         let dir = if ($dir_part | is-empty) or ($dir_part == $glob_base) { "." } else { $dir_part }
-        ($dir + "/*" | into glob)
+        (($dir | str replace -a -r '([\\[\\]])' '[$1]') + "/*" | into glob)
       } else {
         null
       }
@@ -1674,7 +1702,7 @@ ${functionName}-external
 			if (i > 0) yield "\n";
 			if (suggestion.kind === "literal") {
 				const description = suggestion.description == null ? "" : sanitizeForTransport(require_message.formatMessage(suggestion.description, { colors: false }));
-				yield `${sanitizeForTransport(suggestion.text)}\t${description}`;
+				yield `${encodeLiteral(suggestion.text)}\t${description}`;
 			} else {
 				const extensions = encodeExtensions(suggestion.extensions);
 				const hidden = suggestion.includeHidden ? "1" : "0";
@@ -1729,10 +1757,12 @@ ${escapedArgs ? `    \$completionArgs += @(${escapedArgs})
 
         # Parse tab-separated output and create CompletionResult objects
         \$output -split "\`n" | ForEach-Object {
+            \$literal = \$_.StartsWith('__LITERAL__:', [System.StringComparison]::Ordinal)
             \$line = \$_.Trim()
             if (-not \$line) { return }
+            if (\$literal) { \$line = \$line.Substring(12) }
 
-            if (\$line -match '^__FILE__:') {
+            if (-not \$literal -and \$_.StartsWith('__FILE__:', [System.StringComparison]::Ordinal)) {
                 # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
                 \$directive = (\$line -split "\`t")[0]
                 \$parts = \$directive -split ':', 5
@@ -1874,7 +1904,7 @@ ${escapedArgs ? `    \$completionArgs += @(${escapedArgs})
 			if (suggestion.kind === "literal") {
 				const description = suggestion.description == null ? "" : sanitizeForTransport(require_message.formatMessage(suggestion.description, { colors: false }));
 				const text = sanitizeForTransport(suggestion.text);
-				yield `${text}\t${text}\t${description}`;
+				yield `${encodeLiteral(suggestion.text)}\t${text}\t${description}`;
 			} else {
 				const extensions = encodeExtensions(suggestion.extensions);
 				const hidden = suggestion.includeHidden ? "1" : "0";

package/dist/completion.js

@@ -62,6 +62,17 @@ function sanitizeForTransport(text) {
 	return text.replace(/[\t\n\r\0]/g, " ");
 }
 /**
+* Escapes literal values that would otherwise be interpreted as transport
+* directives.  Escape the escape prefix itself so decoding is unambiguous.
+* @param text The literal suggestion text.
+* @returns The sanitized and, if necessary, escaped literal text.
+* @internal
+*/
+function encodeLiteral(text) {
+	const sanitized = sanitizeForTransport(text);
+	return sanitized.startsWith("__FILE__:") || sanitized.startsWith("__LITERAL__:") ? `__LITERAL__:${sanitized}` : sanitized;
+}
+/**
 * The Bash shell completion generator.
 * @since 0.6.0
 */
@@ -308,10 +319,11 @@ function _${programName} () {
     __reply_prefix=""
     __file_current="$current"
     __literal=0
-    if [[ "$line" == __LITERAL__:* ]]; then
+    # Protocol tags are case-sensitive even when nocasematch is enabled.
+    if [ "\${line:0:12}" = '__LITERAL__:' ]; then
       line="\${line#__LITERAL__:}"
       __literal=1
-    elif [[ "$line" == __JOINED_FILE__:* ]]; then
+    elif [ "\${line:0:16}" = '__JOINED_FILE__:' ]; then
       line="\${line#__JOINED_FILE__:}"
       __reply_prefix="\${line%%:*}"
       __reply_prefix="\${__reply_prefix//%3A/:}"
@@ -332,7 +344,7 @@ function _${programName} () {
         __file_quote_offset=$((__file_quote_offset - \${#__reply_prefix}))
       fi
     fi
-    if [[ $__literal == 0 && "$line" == __FILE__:* ]]; then
+    if [ "$__literal" = 0 ] && [ "\${line:0:9}" = '__FILE__:' ]; then
       # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
       IFS=':' read -r _ type extensions pattern hidden <<< "$line"
       extensions="\${extensions//,\\./,}"; extensions="\${extensions#.}"
@@ -700,7 +712,12 @@ function _${programName.replace(/[^a-zA-Z0-9]/g, "_")} () {
       desc=\${line#*\$'\\0'}
       desc=\${desc%%\$'\\0'*}
 
-      if [[ "\$value" == __FILE__:* ]]; then
+      local __literal=0
+      if [[ "\$value" == __LITERAL__:* ]]; then
+        value="\${value#__LITERAL__:}"
+        __literal=1
+      fi
+      if [[ \$__literal == 0 && "\$value" == __FILE__:* ]]; then
         # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
         local type extensions pattern hidden
         IFS=':' read -r _ type extensions pattern hidden <<< "\$value"
@@ -816,7 +833,7 @@ fi
 	*encodeSuggestions(suggestions) {
 		for (const suggestion of suggestions) if (suggestion.kind === "literal") {
 			const description = suggestion.description == null ? "" : sanitizeForTransport(formatMessage(suggestion.description, { colors: false }));
-			yield `${sanitizeForTransport(suggestion.text)}\0${description}\0`;
+			yield `${encodeLiteral(suggestion.text)}\0${description}\0`;
 		} else {
 			const extensions = encodeExtensions(suggestion.extensions);
 			const hidden = suggestion.includeHidden ? "1" : "0";
@@ -875,7 +892,12 @@ function ${functionName}
 ${escapedArgs ? `    set -l output (${programName} ${escapedArgs} $prev $current 2>/dev/null)\n` : `    set -l output (${programName} $prev $current 2>/dev/null)\n`}
     # Process each line of output
     for line in $output
-        if string match -q '__FILE__:*' -- $line
+        set -l literal 0
+        if string match -q '__LITERAL__:*' -- $line
+            set line (string sub -s 13 -- $line)
+            set literal 1
+        end
+        if test $literal -eq 0; and string match -q '__FILE__:*' -- $line
             # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
             set -l directive (string split \\t -- $line)[1]
             set -l parts (string split ':' -- $directive)
@@ -1166,7 +1188,7 @@ complete -c ${programName} -f -a '(${functionName})'
 			if (i > 0) yield "\n";
 			if (suggestion.kind === "literal") {
 				const description = suggestion.description == null ? "" : sanitizeForTransport(formatMessage(suggestion.description, { colors: false }));
-				yield `${sanitizeForTransport(suggestion.text)}\t${description}`;
+				yield `${encodeLiteral(suggestion.text)}\t${description}`;
 			} else {
 				const extensions = encodeExtensions(suggestion.extensions);
 				const hidden = suggestion.includeHidden ? "1" : "0";
@@ -1405,8 +1427,10 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
   }
 
   # Process each line of output
-  $output | lines | each {|line|
-    if ($line | str starts-with '__FILE__:') {
+  $output | lines | each {|raw_line|
+    let literal = ($raw_line | str starts-with '__LITERAL__:')
+    let line = if $literal { $raw_line | str substring 12.. } else { $raw_line }
+    if (not $literal) and ($line | str starts-with '__FILE__:') {
       # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
       let directive = ($line | split row "\t" | first)
       let parts = ($directive | split row ':')
@@ -1466,22 +1490,26 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
       # Generate file completions based on type.
       # When the glob base contains wildcard characters, use it as-is;
       # otherwise append * to treat it as a prefix.
-      # Note: into glob is required so that ls expands wildcards from a variable
+      # Note: into glob is required so that ls expands wildcards from a variable.
+      # A literal prefix has its brackets wrapped as [[] and []] so that path
+      # text like "report[1]" is not parsed as a glob character class; a
+      # wildcard pattern is a glob as a whole, so its brackets stay classes.
       let has_glob = ($glob_base =~ '[*?]')
       let ls_pattern = if ($glob_base | is-empty) {
         "."
       } else if $has_glob {
         ($glob_base | into glob)
       } else {
-        ($glob_base + "*" | into glob)
+        (($glob_base | str replace -a -r '([\\[\\]])' '[$1]') + "*" | into glob)
       }
 
       # When using a glob pattern, also compute a directory listing pattern
-      # so that file/any modes can include directories for navigation
+      # so that file/any modes can include directories for navigation; its
+      # directory part is a literal path
       let glob_dir_pattern = if $has_glob {
         let dir_part = ($glob_base | path dirname)
         let dir = if ($dir_part | is-empty) or ($dir_part == $glob_base) { "." } else { $dir_part }
-        ($dir + "/*" | into glob)
+        (($dir | str replace -a -r '([\\[\\]])' '[$1]') + "/*" | into glob)
       } else {
         null
       }
@@ -1674,7 +1702,7 @@ ${functionName}-external
 			if (i > 0) yield "\n";
 			if (suggestion.kind === "literal") {
 				const description = suggestion.description == null ? "" : sanitizeForTransport(formatMessage(suggestion.description, { colors: false }));
-				yield `${sanitizeForTransport(suggestion.text)}\t${description}`;
+				yield `${encodeLiteral(suggestion.text)}\t${description}`;
 			} else {
 				const extensions = encodeExtensions(suggestion.extensions);
 				const hidden = suggestion.includeHidden ? "1" : "0";
@@ -1729,10 +1757,12 @@ ${escapedArgs ? `    \$completionArgs += @(${escapedArgs})
 
         # Parse tab-separated output and create CompletionResult objects
         \$output -split "\`n" | ForEach-Object {
+            \$literal = \$_.StartsWith('__LITERAL__:', [System.StringComparison]::Ordinal)
             \$line = \$_.Trim()
             if (-not \$line) { return }
+            if (\$literal) { \$line = \$line.Substring(12) }
 
-            if (\$line -match '^__FILE__:') {
+            if (-not \$literal -and \$_.StartsWith('__FILE__:', [System.StringComparison]::Ordinal)) {
                 # Parse file completion directive: __FILE__:type:extensions:pattern:hidden
                 \$directive = (\$line -split "\`t")[0]
                 \$parts = \$directive -split ':', 5
@@ -1874,7 +1904,7 @@ ${escapedArgs ? `    \$completionArgs += @(${escapedArgs})
 			if (suggestion.kind === "literal") {
 				const description = suggestion.description == null ? "" : sanitizeForTransport(formatMessage(suggestion.description, { colors: false }));
 				const text = sanitizeForTransport(suggestion.text);
-				yield `${text}\t${text}\t${description}`;
+				yield `${encodeLiteral(suggestion.text)}\t${text}\t${description}`;
 			} else {
 				const extensions = encodeExtensions(suggestion.extensions);
 				const hidden = suggestion.includeHidden ? "1" : "0";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@optique/core",
-  "version": "1.0.15-dev.2824",
+  "version": "1.0.15-dev.2835",
   "description": "Type-safe combinatorial command-line interface parser",
   "keywords": [
     "CLI",