fix: port filesystem tab completion to tab completion API

Fixes #3446

in addition to cleaning up some old and bad code, this fixes a few issues
Fixes #2403
Fixes #3447

Author: starpit

plugins/plugin-bash-like/fs/src/lib/tab-completion.ts

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2017-20 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.
+ */
+
+import { readdir } from 'fs'
+import { basename, join, dirname as pathDirname } from 'path'
+
+import { Tab, Arguments, CommandLine, Registrar, expandHomeDir } from '@kui-shell/core'
+
+import {
+  shellescape,
+  isDirectory,
+  registerTabCompletionEnumerator,
+  TabCompletionSpec,
+  CompletionResponse
+} from '@kui-shell/plugin-core-support/tab-completion'
+
+/**
+ * Tab completion handler for local files
+ *
+ */
+async function completeLocalFiles(
+  tab: Tab,
+  commandLine: CommandLine,
+  { toBeCompleted }: TabCompletionSpec
+): Promise<CompletionResponse[]> {
+  return (await tab.REPL.rexec<CompletionResponse[]>(`fscomplete ${toBeCompleted}`)).content
+}
+
+function doComplete(args: Arguments) {
+  const last = args.command.substring(args.command.indexOf('fscomplete ') + 'fscomplete '.length)
+
+  // dirname will "foo" in the above example; it
+  // could also be that last is itself the name
+  // of a directory
+  const lastIsDir = last.charAt(last.length - 1) === '/'
+  const dirname = lastIsDir ? last : pathDirname(last)
+
+  // debug('suggest local file', dirname, last)
+
+  if (dirname) {
+    // then dirname exists! now scan the directory so we can find matches
+    return new Promise((resolve, reject) => {
+      const dirToScan = expandHomeDir(dirname)
+      readdir(dirToScan, async (err, files) => {
+        if (err) {
+          console.error('fs.readdir error', err)
+          reject(err)
+        } else {
+          const partial = shellescape(basename(last) + (lastIsDir ? '/' : ''))
+          const partialHasADot = partial.startsWith('.')
+
+          const matches: string[] = files.filter(_f => {
+            const f = shellescape(_f)
+
+            // exclude dot files from tab completion, also emacs ~ temp files just for fun
+            return (
+              (lastIsDir || f.indexOf(partial) === 0) &&
+              !f.endsWith('~') &&
+              f !== '.' &&
+              f !== '..' &&
+              (partialHasADot || !f.startsWith('.'))
+            )
+          })
+
+          // add a trailing slash to any matched directory names
+          resolve({
+            mode: 'raw',
+            content: await Promise.all(
+              matches.map(async match => {
+                const completion = lastIsDir ? match : match.substring(partial.length)
+
+                if (await isDirectory(join(dirToScan, match))) {
+                  return `${completion}/`
+                } else {
+                  return { completion, addSpace: true }
+                }
+              })
+            )
+          })
+        }
+      })
+    })
+  }
+}
+
+/**
+ * Entry point to register tab completion handlers
+ *
+ */
+export function preload() {
+  registerTabCompletionEnumerator(completeLocalFiles)
+}
+
+export function plugin(registrar: Registrar) {
+  registrar.listen('/fscomplete', doComplete, { hidden: true, requiresLocal: true })
+}

plugins/plugin-bash-like/fs/src/plugin.ts

@@ -18,16 +18,18 @@ import ls from './lib/ls'
 import glob from './lib/glob'
 import open from './lib/open'
 import fstat from './lib/fstat'
+import { plugin as tabCompletion } from './lib/tab-completion'
 
 import { Registrar } from '@kui-shell/core'
 
 /**
  * This is the module
  *
  */
-export default (registrar: Registrar) => {
+export default async (registrar: Registrar) => {
   ls(registrar)
-  glob(registrar)
   open(registrar)
   fstat(registrar)
+  glob(registrar)
+  tabCompletion(registrar)
 }

plugins/plugin-bash-like/fs/src/preload.ts

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+
+import { isHeadless } from '@kui-shell/core'
+
+export default async () => {
+  if (!isHeadless()) {
+    import('./lib/tab-completion').then(_ => _.preload())
+  }
+}

plugins/plugin-core-support/src/test/core-support2/tab-completion.ts

@@ -30,9 +30,11 @@ describe('Tab completion core', function(this: Common.ISuite) {
   before(Common.before(this))
   after(Common.after(this))
 
-  const options = ['core_empty.js', 'core_single_entry_directory/', 'core_test_directory_1/']
+  const options = ['core_empty.js', 'core_single_entry_directory/', 'core_test_directory_1/'].map(_ =>
+    join(ROOT, 'data/core', _)
+  )
 
-  const fileOptions = ['empty1.js', 'empty2.js']
+  const fileOptions = ['empty1.js', 'empty2.js'].map(_ => join(ROOT, 'data/core/core_test_directory_1', _))
 
   const tmp1 = tmpDirSync()
   touch(join(tmp1.name, 'foo bar'))
@@ -53,12 +55,12 @@ describe('Tab completion core', function(this: Common.ISuite) {
     return tabby(this.app, `ls ${join(tmp1.name, 'foo\\ ')}`, `ls ${join(tmp1.name, 'foo bar')}`)
   })
 
-  Common.localIt('should tab complete file with spaces non-unique', () => {
+  Common.localIt('should tab complete file with spaces non-unique yoyoyoyo', () => {
     return tabbyWithOptions(
       this.app,
       `ls ${join(tmp2.name, 'foo')}`,
-      ['foo bar1', 'foo bar2'],
-      `ls ${join(tmp2.name, 'foo bar1')}`,
+      [join(tmp2.name, 'foo bar1'), join(tmp2.name, 'foo bar2')],
+      `ls ${join(tmp2.name, 'foo\\ bar1')}`,
       { click: 0 }
     )
   })
@@ -67,8 +69,8 @@ describe('Tab completion core', function(this: Common.ISuite) {
     return tabbyWithOptions(
       this.app,
       `ls -l ${join(tmp2.name, 'foo')}`,
-      ['foo bar1', 'foo bar2'],
-      `ls -l ${join(tmp2.name, 'foo bar1')}`,
+      [join(tmp2.name, 'foo bar1'), join(tmp2.name, 'foo bar2')],
+      `ls -l ${join(tmp2.name, 'foo\\ bar1')}`,
       { click: 0 }
     )
   })
@@ -77,8 +79,8 @@ describe('Tab completion core', function(this: Common.ISuite) {
     return tabbyWithOptions(
       this.app,
       `ls ${join(tmp2.name, 'foo\\ ')}`,
-      ['foo bar1', 'foo bar2'],
-      `ls ${join(tmp2.name, 'foo bar2')}`,
+      [join(tmp2.name, 'foo\\ bar1'), join(tmp2.name, 'foo\\ bar2')],
+      `ls ${join(tmp2.name, 'foo\\ bar2')}`,
       { click: 1 }
     )
   })
@@ -107,7 +109,7 @@ describe('Tab completion core', function(this: Common.ISuite) {
   )
 
   // tab completion with options, then click on the second (idx=1) entry of the expected cmpletion list
-  Common.localIt('should tab complete local file path with options', () =>
+  Common.localIt('should tab complete local file path with options then click on second', () =>
     tabbyWithOptions(this.app, `lls ${ROOT}/data/core/core_`, options, `lls ${ROOT}/data/core/core_single_entry_dir/`, {
       click: 1
     })
@@ -121,7 +123,7 @@ describe('Tab completion core', function(this: Common.ISuite) {
   )
 
   // tab completion with file options, then click on the first (idx=0) entry of the expected cmpletion list
-  Common.localIt('should tab complete local file path with options', () =>
+  Common.localIt('should tab complete local file path with options then click on first', () =>
     tabbyWithOptions(
       this.app,
       `lls ${ROOT}/data/core/core_test_directory_1/em`,