@optique/core 1.0.15-dev.2813 → 1.0.15-dev.2822

package/dist/completion.cjs

@@ -1174,62 +1174,189 @@ const nu = {
 		const safeName = programName.replace(/[^a-zA-Z0-9]+/g, "-");
 		const functionName = `nu-complete-${safeName}`;
 		return `
-# Helper to split args respecting quotes and whitespace
+# Helper to split a command line into the arguments Nushell would pass to
+# an external command.  Words are found the way Nushell's lexer finds them
+# (quotes and raw strings may contain whitespace), then each word is decoded
+# like an external argument.  A final empty argument is added when the line
+# ends in unquoted whitespace, for the word about to be completed.
 def args-split []: string -> list<string> {
-  let STATE_NORMAL = 0
-  let STATE_IN_SINGLE_QUOTE = 1
-  let STATE_IN_DOUBLE_QUOTE = 2
-  let STATE_ESCAPE = 3
   let WHITESPACES = [" " "\\t" "\\n" "\\r"]
+  let QUOTES = ["'" '"' "\`"]
 
-  mut state = $STATE_NORMAL
-  mut current_token = ""
-  mut result: list<string> = []
-  mut prev_state = $STATE_NORMAL
+  # Decodes one word.  An unterminated word is the one still being typed,
+  # so its open quote is taken as if it were closed.
+  let decode = {|word: string, unterminated: bool|
+    let hashes = if ($word | str starts-with "r#") {
+      $word | str replace -r '(?s)^r(#+).*$' '$1'
+    } else {
+      ""
+    }
+    if ($hashes | is-not-empty) {
+      let prefix = "r" + $hashes + "'"
+      let suffix = "'" + $hashes
+      let size = ($hashes | str length)
+      if ($word | str starts-with $prefix) and ($word | str ends-with $suffix) and (($word | str length) >= ($size * 2 + 3)) {
+        $word | str replace $prefix "" | str replace -r ($suffix + '$') ""
+      } else if $unterminated and ($word | str starts-with $prefix) {
+        $word | str replace $prefix ""
+      } else {
+        $word
+      }
+    } else {
+      mut result = ""
+      mut quote = ""
+      mut quoted = ""
+      mut escaped = false
+      for char in ($word | split chars) {
+        if $quote == "" {
+          if ($char in $QUOTES) {
+            $quote = $char
+            $quoted = ""
+          } else {
+            $result = $result + $char
+          }
+        } else if $escaped {
+          $quoted = $quoted + $char
+          $escaped = false
+        } else if $char == $quote {
+          let body = $quoted
+          $result = $result + (if $quote == '"' {
+            try { '"' + $body + '"' | from nuon } catch { $body }
+          } else {
+            $body
+          })
+          $quote = ""
+        } else {
+          $quoted = $quoted + $char
+          $escaped = ($quote == '"' and $char == '\\')
+        }
+      }
+      if $quote != "" {
+        let body = $quoted
+        $result = $result + (if not $unterminated {
+          $quote + $body
+        } else if $quote == '"' {
+          try { '"' + $body + '"' | from nuon } catch { $body }
+        } else {
+          $body
+        })
+      }
+      $result
+    }
+  }
+
+  mut words: list<string> = []
+  mut word = ""
+  mut in_word = false
+  mut quote = ""
+  mut escaped = false
+  mut raw_hashes = ""
+  mut raw_pending = ""
+  mut prev = ""
+  mut trailing_space = false
 
   for char in ($in | split chars) {
-    if $state == $STATE_ESCAPE {
-      $current_token = $current_token + $char
-      $state = $prev_state
-    } else if $char == '\\\\' {
-      $prev_state = $state
-      $state = $STATE_ESCAPE
-    } else if $state == $STATE_NORMAL {
-      if $char == "'" {
-        $state = $STATE_IN_SINGLE_QUOTE
-      } else if $char == '"' {
-        $state = $STATE_IN_DOUBLE_QUOTE
-      } else if ($char in $WHITESPACES) {
-        if ($current_token | is-not-empty) {
-          $result = $result | append $current_token
-          $current_token = ""
-        }
+    $trailing_space = false
+    if $quote == "#" and $char != "#" and $char != "'" {
+      # Not a raw string after all; lex this character normally
+      $quote = ""
+    }
+    if $quote == "r" {
+      # Inside a raw string, which ends at ' followed by the same number of #
+      if ($raw_pending | is-not-empty) and $char == "#" {
+        $raw_pending = $raw_pending + $char
+      } else if $char == "'" {
+        $raw_pending = $char
       } else {
-        $current_token = $current_token + $char
+        $raw_pending = ""
+      }
+      if $raw_pending == ("'" + $raw_hashes) {
+        $quote = ""
+        $raw_pending = ""
       }
-    } else if $state == $STATE_IN_SINGLE_QUOTE {
-      if $char == "'" {
-        $state = $STATE_NORMAL
+      $word = $word + $char
+    } else if $quote == "#" {
+      # Between r# and the opening ' of a raw string
+      $word = $word + $char
+      if $char == "#" {
+        $raw_hashes = $raw_hashes + $char
       } else {
-        $current_token = $current_token + $char
+        $quote = "r"
       }
-    } else if $state == $STATE_IN_DOUBLE_QUOTE {
-      if $char == '"' {
-        $state = $STATE_NORMAL
+    } else if $quote != "" {
+      $word = $word + $char
+      if $escaped {
+        $escaped = false
+      } else if $char == $quote {
+        $quote = ""
       } else {
-        $current_token = $current_token + $char
+        $escaped = ($quote == '"' and $char == '\\')
+      }
+    } else if ($char in $WHITESPACES) {
+      if $in_word {
+        $words = $words | append (do $decode $word false)
+        $word = ""
+        $in_word = false
+      }
+      $trailing_space = true
+    } else {
+      if ($char in $QUOTES) {
+        $quote = $char
+      } else if $char == "#" and $prev == "r" {
+        $quote = "#"
+        $raw_hashes = "#"
       }
+      $word = $word + $char
+      $in_word = true
     }
+    $prev = $char
   }
-  if ($current_token | is-not-empty) {
-    $result = $result | append $current_token
+  if $in_word {
+    $words = $words | append (do $decode $word ($quote != ""))
+  } else if $trailing_space {
+    $words = $words | append ""
+  }
+  $words
+}
+
+# Helper to tell whether Nushell would not read a value back verbatim as a
+# single argument.  A leading ! is included because the line editor expands
+# history (e.g., !!) there.  With --allow-expansion, a leading tilde and n-dot
+# path segments (e.g., ...) are allowed to expand.
+def needs-quote [--allow-expansion]: string -> bool {
+  let value = $in
+  let special = ["'" '"' '\`' "#" "(" ")" "[" "]" "{" "}" "|" ";" "&" "$" "*" "?" "<" ">"]
+  (
+    ($value =~ '\\s')
+    or ($special | any {|c| $value | str contains $c })
+    or ($value =~ '^(\\+\\+|[-+*/])?=$')
+    or ($value | str starts-with '!')
+    or ((not $allow_expansion) and (
+      ($value | str starts-with '~')
+      or ($value | split row -r '[/\\\\]' | any {|s| $s =~ '^\\.{3,}$' })
+    ))
+  )
+}
+
+# Helper to quote a value so that Nushell reads it back verbatim as a
+# single argument.  The line editor expands history at a ! that follows
+# whitespace even inside quotes, so such a ! is put between two quoted parts,
+# right after a quote, where it is left alone.
+def quote-arg []: string -> string {
+  let value = $in
+  if ($value | is-empty) or not ($value | needs-quote) {
+    $value
+  } else if ($value | str contains "'") {
+    '"' + ($value | str replace -a '\\' '\\\\' | str replace -a '"' '\\"' | str replace -ar '(\\s)!' '\${1}"!"') + '"'
+  } else {
+    "'" + ($value | str replace -ar '(\\s)!' "\${1}'!'") + "'"
   }
-  $result
 }
 
 # Completion command that calls back to the CLI
 export def "${functionName}" [context: string] {
-  # Split context into tokens, handling quotes properly
+  # Split context into the arguments Nushell would pass, including an empty
+  # one for a new word when the context ends in unquoted whitespace
   let tokens = $context | args-split
 
   # Remove the command name (first token) to get arguments
@@ -1239,18 +1366,11 @@ export def "${functionName}" [context: string] {
     []
   }
 
-  # If context ends with whitespace, add empty string to represent the new argument
-  let args_with_empty = if ($context | str ends-with ' ') {
-    $args | append ''
-  } else {
-    $args
-  }
-
   # Ensure at least one argument (empty string) to get completions not script
-  let final_args = if ($args_with_empty | is-empty) {
+  let final_args = if ($args | is-empty) {
     ['']
   } else {
-    $args_with_empty
+    $args
   }
 
   let output = try {
@@ -1432,19 +1552,45 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
         if ($parsed.parent | is-empty) { "" } else if ($parsed.parent | str ends-with "/") { $parsed.parent } else { $parsed.parent + "/" }
       }
 
-      # Format file completions
+      # Format file completions, quoting names that Nushell would not read
+      # back as a single argument
       $filtered | each {|item|
-        let name = if $item.type == dir {
-          $dir_prefix + ($item.name | path basename) + "/"
+        let base = if $item.type == dir {
+          ($item.name | path basename) + "/"
         } else {
-          $dir_prefix + ($item.name | path basename)
+          $item.name | path basename
+        }
+        let name = $dir_prefix + $base
+        # Nushell expands a leading tilde even in a file name, but not after ./
+        let spelled = if ($dir_prefix | is-empty) and ($base | str starts-with '~') {
+          './' + $base
+        } else {
+          $name
+        }
+        # A tilde or n-dot prefix typed by the user is meant to be expanded
+        # by Nushell, which quoting would prevent, so expand such a prefix
+        # here when the value has to be quoted
+        let literal_ndots = ($base | str replace -r '[/\\\\]$' '') =~ '^\\.{3,}$'
+        let expandable = ($dir_prefix | str starts-with '~') or ($dir_prefix | split row -r '[/\\\\]' | any {|s| $s =~ '^\\.{3,}$' })
+        let value = if not ($literal_ndots or ($spelled | needs-quote --allow-expansion)) {
+          $spelled
+        } else if $expandable {
+          let expanded_prefix = ($dir_prefix | path expand --no-symlink)
+          let expanded_prefix = if ($expanded_prefix | str ends-with "/") { $expanded_prefix } else { $expanded_prefix + "/" }
+          ($expanded_prefix + $base) | quote-arg
+        } else {
+          $spelled | quote-arg
+        }
+        if $value == $name {
+          { value: $value }
+        } else {
+          { value: $value, display_override: $name }
         }
-        { value: $name }
       }
     } else {
       # Regular literal completion - split by tab
       let parts = ($line | split row "\t")
-      if ($parts | length) >= 2 {
+      let record = if ($parts | length) >= 2 {
         # value\\tdescription format
         { value: ($parts | get 0), description: ($parts | get 1) }
       } else if ($parts | length) == 1 and ($parts | get 0 | is-not-empty) {
@@ -1453,6 +1599,18 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
       } else {
         null
       }
+      # Quote values that Nushell would not read back as a single argument,
+      # while the menu keeps showing them as they are
+      if $record == null {
+        null
+      } else {
+        let value = ($record.value | quote-arg)
+        if $value == $record.value {
+          $record
+        } else {
+          $record | upsert value $value | insert display_override $record.value
+        }
+      }
     }
   } | flatten | compact
 }

package/dist/completion.js

@@ -1174,62 +1174,189 @@ const nu = {
 		const safeName = programName.replace(/[^a-zA-Z0-9]+/g, "-");
 		const functionName = `nu-complete-${safeName}`;
 		return `
-# Helper to split args respecting quotes and whitespace
+# Helper to split a command line into the arguments Nushell would pass to
+# an external command.  Words are found the way Nushell's lexer finds them
+# (quotes and raw strings may contain whitespace), then each word is decoded
+# like an external argument.  A final empty argument is added when the line
+# ends in unquoted whitespace, for the word about to be completed.
 def args-split []: string -> list<string> {
-  let STATE_NORMAL = 0
-  let STATE_IN_SINGLE_QUOTE = 1
-  let STATE_IN_DOUBLE_QUOTE = 2
-  let STATE_ESCAPE = 3
   let WHITESPACES = [" " "\\t" "\\n" "\\r"]
+  let QUOTES = ["'" '"' "\`"]
 
-  mut state = $STATE_NORMAL
-  mut current_token = ""
-  mut result: list<string> = []
-  mut prev_state = $STATE_NORMAL
+  # Decodes one word.  An unterminated word is the one still being typed,
+  # so its open quote is taken as if it were closed.
+  let decode = {|word: string, unterminated: bool|
+    let hashes = if ($word | str starts-with "r#") {
+      $word | str replace -r '(?s)^r(#+).*$' '$1'
+    } else {
+      ""
+    }
+    if ($hashes | is-not-empty) {
+      let prefix = "r" + $hashes + "'"
+      let suffix = "'" + $hashes
+      let size = ($hashes | str length)
+      if ($word | str starts-with $prefix) and ($word | str ends-with $suffix) and (($word | str length) >= ($size * 2 + 3)) {
+        $word | str replace $prefix "" | str replace -r ($suffix + '$') ""
+      } else if $unterminated and ($word | str starts-with $prefix) {
+        $word | str replace $prefix ""
+      } else {
+        $word
+      }
+    } else {
+      mut result = ""
+      mut quote = ""
+      mut quoted = ""
+      mut escaped = false
+      for char in ($word | split chars) {
+        if $quote == "" {
+          if ($char in $QUOTES) {
+            $quote = $char
+            $quoted = ""
+          } else {
+            $result = $result + $char
+          }
+        } else if $escaped {
+          $quoted = $quoted + $char
+          $escaped = false
+        } else if $char == $quote {
+          let body = $quoted
+          $result = $result + (if $quote == '"' {
+            try { '"' + $body + '"' | from nuon } catch { $body }
+          } else {
+            $body
+          })
+          $quote = ""
+        } else {
+          $quoted = $quoted + $char
+          $escaped = ($quote == '"' and $char == '\\')
+        }
+      }
+      if $quote != "" {
+        let body = $quoted
+        $result = $result + (if not $unterminated {
+          $quote + $body
+        } else if $quote == '"' {
+          try { '"' + $body + '"' | from nuon } catch { $body }
+        } else {
+          $body
+        })
+      }
+      $result
+    }
+  }
+
+  mut words: list<string> = []
+  mut word = ""
+  mut in_word = false
+  mut quote = ""
+  mut escaped = false
+  mut raw_hashes = ""
+  mut raw_pending = ""
+  mut prev = ""
+  mut trailing_space = false
 
   for char in ($in | split chars) {
-    if $state == $STATE_ESCAPE {
-      $current_token = $current_token + $char
-      $state = $prev_state
-    } else if $char == '\\\\' {
-      $prev_state = $state
-      $state = $STATE_ESCAPE
-    } else if $state == $STATE_NORMAL {
-      if $char == "'" {
-        $state = $STATE_IN_SINGLE_QUOTE
-      } else if $char == '"' {
-        $state = $STATE_IN_DOUBLE_QUOTE
-      } else if ($char in $WHITESPACES) {
-        if ($current_token | is-not-empty) {
-          $result = $result | append $current_token
-          $current_token = ""
-        }
+    $trailing_space = false
+    if $quote == "#" and $char != "#" and $char != "'" {
+      # Not a raw string after all; lex this character normally
+      $quote = ""
+    }
+    if $quote == "r" {
+      # Inside a raw string, which ends at ' followed by the same number of #
+      if ($raw_pending | is-not-empty) and $char == "#" {
+        $raw_pending = $raw_pending + $char
+      } else if $char == "'" {
+        $raw_pending = $char
       } else {
-        $current_token = $current_token + $char
+        $raw_pending = ""
+      }
+      if $raw_pending == ("'" + $raw_hashes) {
+        $quote = ""
+        $raw_pending = ""
       }
-    } else if $state == $STATE_IN_SINGLE_QUOTE {
-      if $char == "'" {
-        $state = $STATE_NORMAL
+      $word = $word + $char
+    } else if $quote == "#" {
+      # Between r# and the opening ' of a raw string
+      $word = $word + $char
+      if $char == "#" {
+        $raw_hashes = $raw_hashes + $char
       } else {
-        $current_token = $current_token + $char
+        $quote = "r"
       }
-    } else if $state == $STATE_IN_DOUBLE_QUOTE {
-      if $char == '"' {
-        $state = $STATE_NORMAL
+    } else if $quote != "" {
+      $word = $word + $char
+      if $escaped {
+        $escaped = false
+      } else if $char == $quote {
+        $quote = ""
       } else {
-        $current_token = $current_token + $char
+        $escaped = ($quote == '"' and $char == '\\')
+      }
+    } else if ($char in $WHITESPACES) {
+      if $in_word {
+        $words = $words | append (do $decode $word false)
+        $word = ""
+        $in_word = false
+      }
+      $trailing_space = true
+    } else {
+      if ($char in $QUOTES) {
+        $quote = $char
+      } else if $char == "#" and $prev == "r" {
+        $quote = "#"
+        $raw_hashes = "#"
       }
+      $word = $word + $char
+      $in_word = true
     }
+    $prev = $char
   }
-  if ($current_token | is-not-empty) {
-    $result = $result | append $current_token
+  if $in_word {
+    $words = $words | append (do $decode $word ($quote != ""))
+  } else if $trailing_space {
+    $words = $words | append ""
+  }
+  $words
+}
+
+# Helper to tell whether Nushell would not read a value back verbatim as a
+# single argument.  A leading ! is included because the line editor expands
+# history (e.g., !!) there.  With --allow-expansion, a leading tilde and n-dot
+# path segments (e.g., ...) are allowed to expand.
+def needs-quote [--allow-expansion]: string -> bool {
+  let value = $in
+  let special = ["'" '"' '\`' "#" "(" ")" "[" "]" "{" "}" "|" ";" "&" "$" "*" "?" "<" ">"]
+  (
+    ($value =~ '\\s')
+    or ($special | any {|c| $value | str contains $c })
+    or ($value =~ '^(\\+\\+|[-+*/])?=$')
+    or ($value | str starts-with '!')
+    or ((not $allow_expansion) and (
+      ($value | str starts-with '~')
+      or ($value | split row -r '[/\\\\]' | any {|s| $s =~ '^\\.{3,}$' })
+    ))
+  )
+}
+
+# Helper to quote a value so that Nushell reads it back verbatim as a
+# single argument.  The line editor expands history at a ! that follows
+# whitespace even inside quotes, so such a ! is put between two quoted parts,
+# right after a quote, where it is left alone.
+def quote-arg []: string -> string {
+  let value = $in
+  if ($value | is-empty) or not ($value | needs-quote) {
+    $value
+  } else if ($value | str contains "'") {
+    '"' + ($value | str replace -a '\\' '\\\\' | str replace -a '"' '\\"' | str replace -ar '(\\s)!' '\${1}"!"') + '"'
+  } else {
+    "'" + ($value | str replace -ar '(\\s)!' "\${1}'!'") + "'"
   }
-  $result
 }
 
 # Completion command that calls back to the CLI
 export def "${functionName}" [context: string] {
-  # Split context into tokens, handling quotes properly
+  # Split context into the arguments Nushell would pass, including an empty
+  # one for a new word when the context ends in unquoted whitespace
   let tokens = $context | args-split
 
   # Remove the command name (first token) to get arguments
@@ -1239,18 +1366,11 @@ export def "${functionName}" [context: string] {
     []
   }
 
-  # If context ends with whitespace, add empty string to represent the new argument
-  let args_with_empty = if ($context | str ends-with ' ') {
-    $args | append ''
-  } else {
-    $args
-  }
-
   # Ensure at least one argument (empty string) to get completions not script
-  let final_args = if ($args_with_empty | is-empty) {
+  let final_args = if ($args | is-empty) {
     ['']
   } else {
-    $args_with_empty
+    $args
   }
 
   let output = try {
@@ -1432,19 +1552,45 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
         if ($parsed.parent | is-empty) { "" } else if ($parsed.parent | str ends-with "/") { $parsed.parent } else { $parsed.parent + "/" }
       }
 
-      # Format file completions
+      # Format file completions, quoting names that Nushell would not read
+      # back as a single argument
       $filtered | each {|item|
-        let name = if $item.type == dir {
-          $dir_prefix + ($item.name | path basename) + "/"
+        let base = if $item.type == dir {
+          ($item.name | path basename) + "/"
         } else {
-          $dir_prefix + ($item.name | path basename)
+          $item.name | path basename
+        }
+        let name = $dir_prefix + $base
+        # Nushell expands a leading tilde even in a file name, but not after ./
+        let spelled = if ($dir_prefix | is-empty) and ($base | str starts-with '~') {
+          './' + $base
+        } else {
+          $name
+        }
+        # A tilde or n-dot prefix typed by the user is meant to be expanded
+        # by Nushell, which quoting would prevent, so expand such a prefix
+        # here when the value has to be quoted
+        let literal_ndots = ($base | str replace -r '[/\\\\]$' '') =~ '^\\.{3,}$'
+        let expandable = ($dir_prefix | str starts-with '~') or ($dir_prefix | split row -r '[/\\\\]' | any {|s| $s =~ '^\\.{3,}$' })
+        let value = if not ($literal_ndots or ($spelled | needs-quote --allow-expansion)) {
+          $spelled
+        } else if $expandable {
+          let expanded_prefix = ($dir_prefix | path expand --no-symlink)
+          let expanded_prefix = if ($expanded_prefix | str ends-with "/") { $expanded_prefix } else { $expanded_prefix + "/" }
+          ($expanded_prefix + $base) | quote-arg
+        } else {
+          $spelled | quote-arg
+        }
+        if $value == $name {
+          { value: $value }
+        } else {
+          { value: $value, display_override: $name }
         }
-        { value: $name }
       }
     } else {
       # Regular literal completion - split by tab
       let parts = ($line | split row "\t")
-      if ($parts | length) >= 2 {
+      let record = if ($parts | length) >= 2 {
         # value\\tdescription format
         { value: ($parts | get 0), description: ($parts | get 1) }
       } else if ($parts | length) == 1 and ($parts | get 0 | is-not-empty) {
@@ -1453,6 +1599,18 @@ ${escapedArgs ? `    ^${programName} ${escapedArgs} ...$final_args | complete |
       } else {
         null
       }
+      # Quote values that Nushell would not read back as a single argument,
+      # while the menu keeps showing them as they are
+      if $record == null {
+        null
+      } else {
+        let value = ($record.value | quote-arg)
+        if $value == $record.value {
+          $record
+        } else {
+          $record | upsert value $value | insert display_override $record.value
+        }
+      }
     }
   } | flatten | compact
 }

package/package.json

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