feat(workspace): support workspace.removeEmptyWorkspaceFolder

Closes #5120

Author: chemzqm

data/schema.json

@@ -2474,6 +2474,12 @@
       "scope": "application",
       "description": "Use current working directory as workspace folder when no root patterns resolved."
     },
+    "workspace.removeEmptyWorkspaceFolder": {
+      "type": "boolean",
+      "default": false,
+      "scope": "application",
+      "description": "Automatically remove the workspace folder when no buffer associated with it."
+    },
     "languageserver": {
       "type": "object",
       "default": {},

doc/coc-config.txt

@@ -104,6 +104,13 @@ WORKSPACE
 
 	Scope: `application`, default: `true`
 
+"workspace.removeEmptyWorkspaceFolder"			*coc-config-workspace-removeEmptyWorkspaceFolder*
+
+	Automatically remove the workspace folder when no buffer associated
+	with it.
+
+	Scope: `application`, default: `false`
+
 ------------------------------------------------------------------------------
 FILESYSTEMWATCH 					*coc-config-fileSystemWatch*
 

doc/coc.txt

@@ -2530,6 +2530,11 @@ Acceptable {action} names for |CocAction()| and |CocActionAsync()|.
 	Add {folder} to workspace folders, {folder} should be exists directory
 	on file system.
 
+"removeWorkspaceFolder" {folder}			*CocAction('removeWorkspaceFolder')*
+
+	Remove workspace fold {folder}, {folder} should be exists directory on
+	file system.
+
 "ensureDocument" [{bufnr}] 				*CocAction('ensureDocument')*
 
 	Ensure current or specified document is attached to coc.nvim
@@ -3014,6 +3019,17 @@ Acceptable {action} names for |CocAction()| and |CocActionAsync()|.
 	position.
 	{forward} select backward when it's falsy value.
 
+"sendRequest" {id} {method} [{params}]		 	*CocAction('sendRequest')*
+
+	Send LSP request with {method} and {params} to the language server of
+	{id} (check the id by `:CocList services`).
+	Checkout the LSP specification at
+	https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/
+
+"sendNotification" {id} {method} [{params}]		*CocAction('sendNotification')*
+
+	Send LSP notification to language server with {id}.
+
 --------------------------------------------------------------------------------
 COMMANDS						*coc-commands*
 

src/__tests__/core/keymaps.test.ts

@@ -149,6 +149,7 @@ describe('registerLocalKeymap', () => {
     let called = false
     let disposable = keymaps.registerLocalKeymap(bufnr, 'n', 'n', () => {
       called = true
+      return ''
     }, true)
     let res = await nvim.exec('nmap n', true)
     await nvim.input('n')

src/__tests__/core/workspaceFolder.test.ts

@@ -312,4 +312,18 @@ describe('WorkspaceFolderController', () => {
       expect(res).toBe(false)
     })
   })
+
+  describe('onDocumentDetach()', () => {
+    it('should check uris', async () => {
+      updateConfiguration('workspace.removeEmptyWorkspaceFolder', true, false)
+      let folder = os.tmpdir()
+      workspaceFolder.addWorkspaceFolder(folder, false)
+      workspaceFolder.onDocumentDetach([URI.parse('untitled:/1'), URI.parse('file:///foo/bar')])
+      expect(workspaceFolder.workspaceFolders.length).toBe(0)
+      workspaceFolder.addWorkspaceFolder(folder, false)
+      workspaceFolder.onDocumentDetach([URI.parse('untitled:/1'), URI.file(path.join(os.tmpdir(), 'foo'))])
+      expect(workspaceFolder.workspaceFolders.length).toBe(1)
+    })
+
+  })
 })

src/core/documents.ts

@@ -449,6 +449,8 @@ export default class Documents implements Disposable {
     this._onDidCloseDocument.fire(doc.textDocument)
     this.buffers.delete(bufnr)
     doc.detach()
+    const uris = this.textDocuments.map(o => URI.parse(o.uri))
+    this.workspaceFolder.onDocumentDetach(uris)
   }
 
   private async onBufWritePost(bufnr: number, changedtick: number): Promise<void> {

src/core/keymaps.ts

@@ -9,7 +9,7 @@ const logger = createLogger('core-keymaps')
 
 export type MapMode = 'n' | 'i' | 'v' | 'x' | 's' | 'o' | '!'
 export type LocalMode = 'n' | 'i' | 'v' | 's' | 'x'
-export type KeymapCallback = () => Promise<string> | string
+export type KeymapCallback = () => Promise<string> | string | void | Promise<void>
 
 export function getKeymapModifier(mode: MapMode): string {
   if (mode == 'n' || mode == 'o' || mode == 'x' || mode == 'v') return '<C-U>'
@@ -39,7 +39,8 @@ export default class Keymaps {
     let [fn, repeat] = keymap
     let res = await Promise.resolve(fn())
     if (repeat) await this.nvim.command(`silent! call repeat#set("\\<Plug>(coc-${key})", -1)`)
-    return res ?? defaultReturn
+    if (res == null) return defaultReturn
+    return res as string
   }
 
   /**

src/core/workspaceFolder.ts

@@ -218,6 +218,24 @@ export default class WorkspaceFolderController {
     })
   }
 
+  public onDocumentDetach(uris: URI[]): void {
+    let shouldCheck = this.configurations.initialConfiguration.get('workspace.removeEmptyWorkspaceFolder', false)
+    if (!shouldCheck) return
+    let filepaths: string[] = []
+    for (const uri of uris) {
+      if (uri.scheme === 'file') {
+        filepaths.push(uri.fsPath)
+      }
+    }
+    for (const item of this.workspaceFolders) {
+      const folder = URI.parse(item.uri).fsPath
+      if (!filepaths.some(f => isParentFolder(folder, f))) {
+        this.removeWorkspaceFolder(folder)
+        return
+      }
+    }
+  }
+
   public getRootPatterns(document: Document, patternType: PatternType): ReadonlyArray<string> {
     if (patternType == PatternType.Buffer) return document.getVar('root_patterns', []) || []
     if (patternType == PatternType.LanguageServer) return this.getServerRootPatterns(document.languageId)