chore: group logging settings

dvirtz · Jun 18, 2022 · a2ad7e1 · a2ad7e1
1 parent cd6e5a6
commit a2ad7e1
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 16 deletions.
diff --git a/package.json b/package.json
@@ -47,11 +47,13 @@
           },
           "parquet-viewer.logPanel": {
             "description": "Write diagnostic logs to an output panel",
-            "type": "boolean"
+            "type": "boolean",
+            "markdownDeprecationMessage": "**Deprecated**: Please use `#parquet-viewer.logging.panel#` instead."
           },
           "parquet-viewer.logFolder": {
             "description": "Write diagnostic logs under the given directory",
-            "type": "string"
+            "type": "string",
+            "markdownDeprecationMessage": "**Deprecated**: Please use `#parquet-viewer.logging.folder#` instead."
           },
           "parquet-viewer.logLevel": {
             "description": "Log level",
@@ -65,11 +67,34 @@
               "debug",
               "trace"
             ],
-            "default": "info"
+            "default": "info",
+            "markdownDeprecationMessage": "**Deprecated**: Please use `#parquet-viewer.logging.level#` instead."
           },
           "parquet-viewer.useParquetTools": {
             "description": "use legacy parquet-tools application for reading parquet files",
             "type": "boolean"
+          },
+          "parquet-viewer.logging.panel": {
+            "description": "Write diagnostic logs to an output panel",
+            "type": "boolean"
+          },
+          "parquet-viewer.logging.folder": {
+            "description": "Write diagnostic logs under the given directory",
+            "type": "string"
+          },
+          "parquet-viewer.logging.level": {
+            "description": "Log level",
+            "type": "string",
+            "enum": [
+              "off",
+              "fatal",
+              "error",
+              "warn",
+              "info",
+              "debug",
+              "trace"
+            ],
+            "default": "info"
           }
         }
       }

diff --git a/src/extension.ts b/src/extension.ts
@@ -11,8 +11,15 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
   initLogger(context);
   getLogger().info('parquet-viewer activated');
 
-  // restart logger on configuration change
-  context.subscriptions.push(vscode.workspace.onDidChangeConfiguration(() => initLogger(context)));
+  context.subscriptions.push(vscode.workspace.onDidChangeConfiguration((e: vscode.ConfigurationChangeEvent) => {
+    if (e.affectsConfiguration('logging')
+      || e.affectsConfiguration('logLevel')
+      || e.affectsConfiguration('logPanel')
+      || e.affectsConfiguration('logFolder')) {
+        // restart logger on log configuration change
+      initLogger(context);
+    }
+  }));
 
   context.subscriptions.push(ParquetEditorProvider.register(context));
 }
diff --git a/src/settings.ts b/src/settings.ts
@@ -13,28 +13,28 @@ export async function setParquetTools(parquetTools: string | undefined): Promise
   await settings().update('parquetToolsPath', parquetTools);
 }
 
-export function logPanel() : boolean {
-  return settings().get('logPanel', false);
+export function logPanel(): boolean {
+  return settings().get('logging.panel', settings().get('logPanel', false));
 }
 
 export async function setLogPanel(logPanel: boolean | undefined): Promise<void> {
-  await settings().update('logPanel', logPanel);
+  await settings().update('logging.panel', logPanel);
 }
 
-export function logFolder() : string {
-  return settings().get('logFolder', '');
+export function logFolder(): string {
+  return settings().get('logging.folder', settings().get('logFolder', ''));
 }
 
 export async function setLogFolder(logFolder: string | undefined): Promise<void> {
-  await settings().update('logFolder', logFolder);
+  await settings().update('logging.folder', logFolder);
 }
 
-export function logLevel() : LogLevel {
-  return settings().get('logLevel', 'info');
+export function logLevel(): LogLevel {
+  return settings().get('logging.level', settings().get('logLevel', 'info'));
 }
 
-export async function setLogLevel(logLevel : LogLevel | undefined): Promise<void> {
-  await settings().update('logLevel', logLevel);
+export async function setLogLevel(logLevel: LogLevel | undefined): Promise<void> {
+  await settings().update('logging.level', logLevel);
 }
 
 export function useParquetTools(): boolean {

diff --git a/test/workspace/.vscode/settings.json b/test/workspace/.vscode/settings.json
@@ -1,4 +1,5 @@
 {
   "parquet-viewer.parquetToolsPath": "parquet-tools-1.12.0-SNAPSHOT.jar",
-  "parquet-viewer.logLevel": "debug"
+  "parquet-viewer.logLevel": "fatal",
+  "parquet-viewer.logging.level": "debug"
 }