fix(packages/core): backslashes not always properly parsed

Fixes #5287

Author: starpit

packages/core/src/repl/split.ts

@@ -46,6 +46,16 @@ export interface Split {
   endIndices: number[]
 }
 
+const endsWithQuoteSpace = (str: string, idx: number, lookFor: string): boolean => {
+  for (let ii = idx + 1; ii < str.length; ii++) {
+    if (str.charAt(ii) === lookFor) {
+      return ii === str.length - 1 || /\s/.test(str.charAt(ii + 1))
+    }
+  }
+
+  return false
+}
+
 export const _split = (
   str: string,
   removeOuterQuotes = true,
@@ -58,31 +68,21 @@ export const _split = (
 
   let cur = ''
 
-  const endsWithQuoteSpace = (idx: number, lookFor: string): boolean => {
-    for (let ii = idx + 1; ii < str.length; ii++) {
-      if (str.charAt(ii) === lookFor) {
-        return ii === str.length - 1 || /\s/.test(str.charAt(ii + 1))
-      }
-    }
-
-    return false
-  }
-
   const removedLastOpenQuote: boolean[] = []
   let escapeActive = false
   for (let idx = 0; idx < str.length; idx++) {
-    const char = str.charAt(idx)
+    let char = str.charAt(idx)
 
     if (char === '\\') {
       if (!escapeActive) {
         escapeActive = true
+        char = str.charAt(++idx)
       } else {
         escapeActive = false
         cur += '\\'
+        continue
       }
-
-      continue
-    } else if (!escapeActive) {
+    } else if (escapeActive) {
       escapeActive = false
     }
 
@@ -117,7 +117,7 @@ export const _split = (
         // found open quote
         const removeQuote =
           removeOuterQuotes &&
-          endsWithQuoteSpace(idx, char) &&
+          endsWithQuoteSpace(str, idx, char) &&
           (idx === 0 ||
             (stack.length === 0 && (removeInlineOuterQuotes || patterns.whitespace.test(str.charAt(idx - 1)))))
 

plugins/plugin-core-support/src/lib/cmds/echo.ts

@@ -14,14 +14,11 @@
  * limitations under the License.
  */
 
-//
-// Note: for now, this is disabled in favor of the bash-like shell
-// echo; we should probably restore for support for browser/no-proxy
-// mode.
-//
+import { Registrar } from '@kui-shell/core'
 
-export default () => {
-  /*  commandTree.listen('/echo', ({ argvNoOptions }) => {
+/** For debugging the command line parser */
+export default (registrar: Registrar) => {
+  registrar.listen('/kuiecho', ({ argvNoOptions }) => {
     return argvNoOptions.slice(1).join(' ') || true
-  }) */
+  })
 }

plugins/plugin-core-support/src/plugin.ts

@@ -17,6 +17,7 @@
 import { isHeadless, Registrar } from '@kui-shell/core'
 
 // import help from './lib/cmds/help'
+import echo from './lib/cmds/echo'
 import quit from './lib/cmds/quit'
 import clear from './lib/cmds/clear'
 import base64 from './lib/cmds/base64'
@@ -34,6 +35,7 @@ import tabManagement from './lib/cmds/tab-management'
 export default async (commandTree: Registrar) => {
   await Promise.all([
     // help(commandTree, options),
+    echo(commandTree),
     quit(commandTree),
     clear(commandTree),
     base64(commandTree),

plugins/plugin-core-support/src/test/core/command-line-parsing.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2020 IBM Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * Test command line parsing
+ *
+ */
+import { Common, CLI, ReplExpect } from '@kui-shell/test'
+
+const input1 = 'hi ho\\\\.mo\\.zo \\ff'
+const output1 = 'hi ho\\.mo.zo ff'
+
+describe(`Command line parsing ${process.env.MOCHA_RUN_TARGET || ''}`, function(this: Common.ISuite) {
+  before(Common.before(this))
+  after(Common.after(this))
+
+  it('should properly handle backslash escapes with pty commands', () =>
+    CLI.command(`echo ${input1}`, this.app)
+      .then(ReplExpect.okWithPtyOutput(output1))
+      .catch(Common.oops(this, true)))
+
+  it('should properly handle backslash escapes with kui commands', () =>
+    CLI.command(`kuiecho ${input1}`, this.app)
+      .then(ReplExpect.okWithString(output1))
+      .catch(Common.oops(this, true)))
+})