qt-cpp: qt-core: qt-lib: qt-python: qt-qml: qt-ui: Use CoreKey constants for coreAPI keys

Author: OrkunTokdemir

qt-core/src/extension.ts

@@ -6,10 +6,8 @@ import { isEmpty } from 'lodash';
 
 import {
   createLogger,
-  GlobalWorkspace,
+  CoreKey,
   initLogger,
-  QtInsRootConfigName,
-  AdditionalQtPathsName,
   telemetry,
   createColorProvider
 } from 'qt-lib';
@@ -91,14 +89,14 @@ export function deactivate() {
 
 export function initCoreValues() {
   coreAPI?.setValue(
-    GlobalWorkspace,
-    QtInsRootConfigName,
+    CoreKey.GLOBAL_WORKSPACE,
+    CoreKey.QT_INSTALLATION_ROOT,
     getCurrentGlobalQtInstallationRoot()
   );
   const currentAdditionalQtPaths = getCurrentGlobalAdditionalQtPaths();
   coreAPI?.setValue(
-    GlobalWorkspace,
-    AdditionalQtPathsName,
+    CoreKey.GLOBAL_WORKSPACE,
+    CoreKey.ADDITIONAL_QT_PATHS,
     currentAdditionalQtPaths
   );
   if (!isEmpty(currentAdditionalQtPaths)) {

qt-core/src/installation-root.ts

@@ -17,7 +17,8 @@ import {
   QtAdditionalPath,
   IsMacOS,
   telemetry,
-  resolveConfiguration
+  resolveConfiguration,
+  CoreKey
 } from 'qt-lib';
 import { EXTENSION_ID } from '@/constants';
 import { coreAPI } from '@/extension';
@@ -226,8 +227,12 @@ export function onQtInsRootUpdated(
   logger.info(`Qt installation root updated: "${newQtInstallationRoot}"`);
 
   const message = new QtWorkspaceConfigMessage(folder);
-  coreAPI?.setValue(folder, QtInsRootConfigName, newQtInstallationRoot);
-  message.config.add(QtInsRootConfigName);
+  coreAPI?.setValue(
+    folder,
+    CoreKey.QT_INSTALLATION_ROOT,
+    newQtInstallationRoot
+  );
+  message.config.add(CoreKey.QT_INSTALLATION_ROOT);
   logger.info(`Notifying coreAPI with message: ${message.toString()}`);
   coreAPI?.notify(message);
 }
@@ -250,8 +255,8 @@ export function onAdditionalQtPathsUpdated(
   logger.info('Additional Qt Paths updated: ' + JSON.stringify(newPaths));
 
   const message = new QtWorkspaceConfigMessage(folder);
-  coreAPI?.setValue(folder, AdditionalQtPathsName, newPaths);
-  message.config.add(AdditionalQtPathsName);
+  coreAPI?.setValue(folder, CoreKey.ADDITIONAL_QT_PATHS, newPaths);
+  message.config.add(CoreKey.ADDITIONAL_QT_PATHS);
   logger.info(`Notifying coreAPI with message: ${message.toString()}`);
   coreAPI?.notify(message);
 }

qt-core/src/project.ts

@@ -7,7 +7,7 @@ import { isEmpty, isEqual } from 'lodash';
 import {
   AdditionalQtPathsName,
   createLogger,
-  GlobalWorkspace,
+  CoreKey,
   QtInsRootConfigName,
   QtAdditionalPath,
   compareQtAdditionalPath,
@@ -97,13 +97,13 @@ export class CoreProject implements Project {
   public initConfigValues() {
     const folder = this.folder;
     const qtInsRoot = CoreProjectManager.getWorkspaceFolderQtInsRoot(folder);
-    coreAPI?.setValue(folder, QtInsRootConfigName, qtInsRoot);
+    coreAPI?.setValue(folder, CoreKey.QT_INSTALLATION_ROOT, qtInsRoot);
     logger.info(
       `Setting Qt installation root for ${folder.uri.fsPath} to: ${qtInsRoot}`
     );
     const additionalQtPaths =
       CoreProjectManager.getWorkspaceFolderAdditionalQtPaths(folder);
-    coreAPI?.setValue(folder, AdditionalQtPathsName, additionalQtPaths);
+    coreAPI?.setValue(folder, CoreKey.ADDITIONAL_QT_PATHS, additionalQtPaths);
     logger.info(
       `Setting additional Qt paths for ${folder.uri.fsPath} to: ${additionalQtPaths.join(', ')}`
     );
@@ -146,7 +146,7 @@ export class CoreProjectManager extends ProjectManager<CoreProject> {
             void this.globalStateManager.setQtInstallationRoot(
               currentQtInsRoot
             );
-            onQtInsRootUpdated(currentQtInsRoot, GlobalWorkspace);
+            onQtInsRootUpdated(currentQtInsRoot, CoreKey.GLOBAL_WORKSPACE);
           }
           const previousAdditionalQtPaths =
             this.globalStateManager.getAdditionalQtPaths();
@@ -162,7 +162,7 @@ export class CoreProjectManager extends ProjectManager<CoreProject> {
             );
             onAdditionalQtPathsUpdated(
               currentAdditionalQtPaths,
-              GlobalWorkspace
+              CoreKey.GLOBAL_WORKSPACE
             );
           }
         }

qt-core/src/qtpaths.ts

@@ -8,7 +8,7 @@ import {
   AdditionalQtPathsName,
   createLogger,
   generateDefaultQtPathsName,
-  GlobalWorkspace,
+  CoreKey,
   QtAdditionalPath,
   telemetry
 } from 'qt-lib';
@@ -112,5 +112,5 @@ export function addQtPathToSettings(qtPath: QtAdditionalPath) {
     vscode.ConfigurationTarget.Global
   );
   const convertedValue = convertAdditionalQtPaths(valueToSet);
-  onAdditionalQtPathsUpdated(convertedValue, GlobalWorkspace);
+  onAdditionalQtPathsUpdated(convertedValue, CoreKey.GLOBAL_WORKSPACE);
 }

qt-core/src/translation.ts

@@ -6,6 +6,7 @@ import path from 'path';
 import * as child_process from 'child_process';
 
 import {
+  CoreKey,
   createLogger,
   exists,
   findQtPathsInKitDir,
@@ -41,11 +42,11 @@ export async function openInLinguistCommand() {
   }
   const selectedKitPath = coreAPI?.getValue<string>(
     project.folder,
-    'selectedKitPath'
+    CoreKey.SELECTED_KIT_PATH
   );
   const selectedQtPaths = coreAPI?.getValue<string>(
     project.folder,
-    'selectedQtPaths'
+    CoreKey.SELECTED_QT_PATHS
   );
   let linguistPath: string | undefined;
   if (selectedKitPath) {

qt-cpp/src/extension.ts

@@ -9,9 +9,7 @@ import {
   createLogger,
   initLogger,
   QtWorkspaceConfigMessage,
-  QtInsRootConfigName,
-  AdditionalQtPathsName,
-  GlobalWorkspace,
+  CoreKey,
   QtAdditionalPath,
   telemetry
 } from 'qt-lib';
@@ -108,7 +106,7 @@ async function processMessage(message: QtWorkspaceConfigMessage) {
   // check if workspace folder is a string
   let project: CppProject | undefined;
   if (typeof message.workspaceFolder === 'string') {
-    if (message.workspaceFolder !== GlobalWorkspace) {
+    if (message.workspaceFolder !== CoreKey.GLOBAL_WORKSPACE) {
       throw new Error('Invalid global workspace');
     }
   } else {
@@ -119,21 +117,21 @@ async function processMessage(message: QtWorkspaceConfigMessage) {
     }
   }
   for (const key of message.config.keys()) {
-    if (key === QtInsRootConfigName) {
+    if (key === CoreKey.QT_INSTALLATION_ROOT) {
       const value =
         coreAPI?.getValue<string>(
           message.workspaceFolder,
-          QtInsRootConfigName
+          CoreKey.QT_INSTALLATION_ROOT
         ) ?? '';
       await kitManager.onQtInstallationRootChanged(value, project?.folder);
       continue;
     }
 
-    if (key === AdditionalQtPathsName) {
+    if (key === CoreKey.ADDITIONAL_QT_PATHS) {
       const additionalQtPaths =
         coreAPI?.getValue<QtAdditionalPath[]>(
           message.workspaceFolder,
-          AdditionalQtPathsName
+          CoreKey.ADDITIONAL_QT_PATHS
         ) ?? [];
       await kitManager.onQtPathsChanged(additionalQtPaths, project?.folder);
       continue;

qt-cpp/src/kit-manager.ts

@@ -11,9 +11,7 @@ import {
   OSExeSuffix,
   UserLocalDir,
   createLogger,
-  QtInsRootConfigName,
-  AdditionalQtPathsName,
-  GlobalWorkspace,
+  CoreKey,
   compareVersions,
   findQtKits,
   isError,
@@ -821,13 +819,18 @@ export class KitManager {
   }
 
   public static getWorkspaceFolderQtInsRoot(folder: vscode.WorkspaceFolder) {
-    return coreAPI?.getValue<string>(folder, QtInsRootConfigName) ?? '';
+    return (
+      coreAPI?.getValue<string>(folder, CoreKey.QT_INSTALLATION_ROOT) ?? ''
+    );
   }
   public static getWorkspaceFolderAdditionalQtPaths(
     folder: vscode.WorkspaceFolder
   ) {
     return (
-      coreAPI?.getValue<QtAdditionalPath[]>(folder, AdditionalQtPathsName) ?? []
+      coreAPI?.getValue<QtAdditionalPath[]>(
+        folder,
+        CoreKey.ADDITIONAL_QT_PATHS
+      ) ?? []
     );
   }
   private static getVCPKGToolchainFile() {
@@ -839,13 +842,18 @@ export class KitManager {
   }
 }
 function getCurrentGlobalQtInstallationRoot(): string {
-  return coreAPI?.getValue<string>(GlobalWorkspace, QtInsRootConfigName) ?? '';
+  return (
+    coreAPI?.getValue<string>(
+      CoreKey.GLOBAL_WORKSPACE,
+      CoreKey.QT_INSTALLATION_ROOT
+    ) ?? ''
+  );
 }
 function getCurrentGlobalAdditionalQtPaths(): QtAdditionalPath[] {
   return (
     coreAPI?.getValue<QtAdditionalPath[]>(
-      GlobalWorkspace,
-      AdditionalQtPathsName
+      CoreKey.GLOBAL_WORKSPACE,
+      CoreKey.ADDITIONAL_QT_PATHS
     ) ?? []
   );
 }

qt-cpp/src/project.ts

@@ -11,6 +11,7 @@ import { isEmpty, isEqual } from 'lodash';
 import { WorkspaceStateManager } from '@/state';
 import { coreAPI, kitManager } from '@/extension';
 import {
+  CoreKey,
   createLogger,
   IsLinux,
   IsMacOS,
@@ -98,8 +99,8 @@ export class CppProject implements Project {
             );
             this._buildDir = currentBuildDir;
             const message = new QtWorkspaceConfigMessage(this.folder);
-            coreAPI?.setValue(this.folder, 'buildDir', currentBuildDir);
-            message.config.add('buildDir');
+            coreAPI?.setValue(this.folder, CoreKey.BUILD_DIR, currentBuildDir);
+            message.config.add(CoreKey.BUILD_DIR);
             logger.info(
               `Notifying coreAPI with message: ${message.toString()}`
             );
@@ -123,12 +124,12 @@ export class CppProject implements Project {
     }
     const selectedKitPath = kit ? getQtInsRoot(kit) : undefined;
     const message = new QtWorkspaceConfigMessage(this.folder);
-    coreAPI?.setValue(this.folder, 'selectedKitPath', selectedKitPath);
-    message.config.add('selectedKitPath');
+    coreAPI?.setValue(this.folder, CoreKey.SELECTED_KIT_PATH, selectedKitPath);
+    message.config.add(CoreKey.SELECTED_KIT_PATH);
 
     const selectedQtPaths = kit ? getQtPathsExe(kit) : undefined;
-    coreAPI?.setValue(this.folder, 'selectedQtPaths', selectedQtPaths);
-    message.config.add('selectedQtPaths');
+    coreAPI?.setValue(this.folder, CoreKey.SELECTED_QT_PATHS, selectedQtPaths);
+    message.config.add(CoreKey.SELECTED_QT_PATHS);
     logger.info(`Notifying coreAPI with message: ${message.toString()}`);
     coreAPI?.notify(message);
   }
@@ -424,14 +425,14 @@ export class CppProject implements Project {
     logger.info(
       `Setting selected kit path for ${folder.uri.fsPath} to ${selectedKitPath}`
     );
-    coreAPI.setValue(folder, 'selectedKitPath', selectedKitPath);
+    coreAPI.setValue(folder, CoreKey.SELECTED_KIT_PATH, selectedKitPath);
     const selectedQtPaths = kit ? getQtPathsExe(kit) : undefined;
-    coreAPI.setValue(folder, 'selectedQtPaths', selectedQtPaths);
+    coreAPI.setValue(folder, CoreKey.SELECTED_QT_PATHS, selectedQtPaths);
     logger.info(
       `Setting selected Qt paths for ${folder.uri.fsPath} to ${selectedQtPaths}`
     );
 
-    const featuresKey = 'workspaceFeatures';
+    const featuresKey = CoreKey.WORKSPACE_FEATURES;
     let features = coreAPI.getValue<QtWorkspaceFeatures>(folder, featuresKey);
     features ??= { projectTypes: {} };
     features.projectTypes.cmake = true;
@@ -441,16 +442,16 @@ export class CppProject implements Project {
       `Setting workspace features for ${folder.uri.fsPath} to ${JSON.stringify(features)}`
     );
 
-    coreAPI.setValue(folder, 'buildDir', this.buildDir);
+    coreAPI.setValue(folder, CoreKey.BUILD_DIR, this.buildDir);
     logger.info(
       `Setting build directory for ${folder.uri.fsPath} to ${this.buildDir}`
     );
     logger.info('Config values initialized for:', folder.uri.fsPath);
     const message = new QtWorkspaceConfigMessage(folder);
-    message.config.add('selectedKitPath');
-    message.config.add('selectedQtPaths');
+    message.config.add(CoreKey.SELECTED_KIT_PATH);
+    message.config.add(CoreKey.SELECTED_QT_PATHS);
     message.config.add(featuresKey);
-    message.config.add('buildDir');
+    message.config.add(CoreKey.BUILD_DIR);
     coreAPI.notify(message);
   }
   public getStateManager() {

qt-lib/src/constants.ts

@@ -4,4 +4,14 @@
 export const QtInsRootConfigName = 'qtInstallationRoot';
 export const AdditionalQtPathsName = 'additionalQtPaths';
 export const CORE_EXTENSION_ID = 'qt-core';
-export const GlobalWorkspace = 'global';
+
+export const CoreKey = {
+  ADDITIONAL_QT_PATHS: 'additionalQtPaths',
+  QT_INSTALLATION_ROOT: 'qtInstallationRoot',
+  VENV_BIN_PATH: 'venvBinPath',
+  WORKSPACE_FEATURES: 'workspaceFeatures',
+  SELECTED_KIT_PATH: 'selectedKitPath',
+  SELECTED_QT_PATHS: 'selectedQtPaths',
+  BUILD_DIR: 'buildDir',
+  GLOBAL_WORKSPACE: 'global'
+};

qt-python/src/constants.ts

@@ -16,9 +16,6 @@ export const DEBUG_DEFAULT_ENTRY_POINT = 'main.py';
 
 export const VENV_BIN_DIR = IsWindows ? 'Scripts' : 'bin';
 
-export const CORE_KEY_VENV_BIN_PATH = 'venvBinPath';
-export const CORE_KEY_WORKSPACE_FEATURES = 'workspaceFeatures';
-
 export const TOML_PROJECT_FILE_NAME = 'pyproject.toml';
 export const TOML_KEY_PROJECT_NAME = 'project.name';
 export const TOML_KEY_PROJECT_FILES = 'tool.pyside6-project.files';