Merge pull request #2 from yaegassy/progress-window

feat: support progress window for indexing
yaegassy · Mar 9, 2021 · f9793e5 · f9793e5
2 parents 3dbb4cf + 299c189
commit f9793e5
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -15,6 +15,7 @@
 - `intelephense.enable`: Enable coc-intelephense extension, default `true`
 - `intelephense.path`: Absolute path to intelephense module. If there is no setting, the built-in module will be used. e.g. `/path/to/node_modules/intelephense`. default: ""
 - `intelephense.disableCompletion`: Disable completion only, default: `false`
+- `intelephense.progress.enable`: Enable progress window for indexing, If false, display with echo messages, default: `true`
 
 Other settings can be changed in the same way as "configuration" of [vscode-intelephense](https://github.com/bmewburn/vscode-intelephense).
 

diff --git a/package.json b/package.json
@@ -73,6 +73,11 @@
           "default": false,
           "description": "Disable completion only."
         },
+        "intelephense.progress.enable": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable progress window for indexing, If false, display with echo messages."
+        },
         "intelephense.compatibility.correctForBaseClassStaticUnionTypes": {
           "type": "boolean",
           "default": true,

diff --git a/src/index.ts b/src/index.ts
@@ -95,17 +95,7 @@ function createClient(context: ExtensionContext, clearCache: boolean) {
   const languageClient = new LanguageClient('intelephense', 'intelephense', serverOptions, clientOptions);
 
   languageClient.onReady().then(() => {
-    let startedTime: Date;
-
-    languageClient.onNotification(INDEXING_STARTED_NOTIFICATION.method, () => {
-      startedTime = new Date();
-      window.showMessage('intelephense indexing ...');
-    });
-
-    languageClient.onNotification(INDEXING_ENDED_NOTIFICATION.method, () => {
-      const usedTime: number = Math.abs(new Date().getTime() - startedTime.getTime());
-      window.showMessage('Indexed php files, times: ' + usedTime + 'ms');
-    });
+    registerNotificationListeners();
   });
 
   return languageClient;
@@ -125,3 +115,52 @@ function indexWorkspace() {
 function cancelIndexing() {
   languageClient.sendRequest(CANCEL_INDEXING_REQUEST.method);
 }
+
+// MEMO: support progress window for indexing
+function registerNotificationListeners() {
+  const intelephenseConfig = workspace.getConfiguration('intelephense');
+  const progressEnable = intelephenseConfig.get<boolean>('progress.enable');
+
+  let resolveIndexingPromise: () => void;
+
+  if (progressEnable) {
+    languageClient.onNotification(INDEXING_STARTED_NOTIFICATION.method, () => {
+      displayInitIndexProgress(
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        new Promise<void>((resolve, reject) => {
+          resolveIndexingPromise = () => {
+            resolve();
+          };
+        })
+      );
+    });
+
+    languageClient.onNotification(INDEXING_ENDED_NOTIFICATION.method, () => {
+      if (resolveIndexingPromise) {
+        resolveIndexingPromise();
+      }
+    });
+  } else {
+    languageClient.onNotification(INDEXING_STARTED_NOTIFICATION.method, () => {
+      window.showMessage('intelephense indexing ...');
+    });
+
+    languageClient.onNotification(INDEXING_ENDED_NOTIFICATION.method, () => {
+      if (resolveIndexingPromise) {
+        resolveIndexingPromise();
+      }
+      window.showMessage('intelephense running!');
+    });
+  }
+}
+
+// MEMO: support progress window for indexing
+async function displayInitIndexProgress<T = void>(promise: Promise<T>) {
+  return window.withProgress(
+    {
+      title: 'intelephense indexing ...',
+      cancellable: true,
+    },
+    () => promise
+  );
+}