Improve diagnostic configuration

package.json

@@ -115,32 +115,32 @@
             "default": true,
             "description": "Show Automatic Images in the displayable auto-completion list. If not checked (false), only images defined in the script will be shown. If checked (true), both script-defined images and images detected in the images folders will be shown."
           },
-          "renpy.warnOnObsoleteMethods": {
+          "renpy.diagnostics.warnOnObsoleteMethods": {
             "type": "boolean",
             "default": true,
             "description": "Enable obsolete method warnings. If checked (true), obsolete methods (e.g., im.Crop) will be marked with a warning in the editor."
           },
-          "renpy.warnOnUndefinedPersistents": {
+          "renpy.diagnostics.warnOnUndefinedPersistents": {
             "type": "boolean",
             "default": true,
             "description": "Enable undefined persistent warnings. If checked (true), persistent variables will be marked with a warning in the editor if they haven't been defaulted/defined."
           },
-          "renpy.warnOnUndefinedStoreVariables": {
+          "renpy.diagnostics.warnOnUndefinedStoreVariables": {
             "type": "boolean",
             "default": true,
             "description": "Enable undefined store variable warnings. If checked (true), store variables will be marked with a warning in the editor if they haven't been defaulted/defined."
           },
-          "renpy.warnOnReservedVariableNames": {
+          "renpy.diagnostics.warnOnReservedVariableNames": {
             "type": "boolean",
             "default": true,
             "description": "Enable reserved variable warnings. If checked (true), variables will be marked with an error in the editor if they are in the list of names reserved by Python."
           },
-          "renpy.warnOnInvalidVariableNames": {
+          "renpy.diagnostics.warnOnInvalidVariableNames": {
             "type": "boolean",
             "default": true,
             "description": "Enable invalid variable errors. Variables must begin with a letter or number. They may contain a '_' but may not begin with '_'. If set to true, variables will be flagged in the editor if they do not meet Ren'Py's specifications."
           },
-          "renpy.warnOnIndentationAndSpacingIssues": {
+          "renpy.diagnostics.warnOnIndentationAndSpacingIssues": {
             "type": "string",
             "default": "Error",
             "enum": [
@@ -155,7 +155,7 @@
             ],
             "description": "Enable indentation and inconsistent spacing checks. If set to Error or Warning, tab characters and inconsistent indentation spacing will be marked in the editor. If set to Disabled, indentation issues will be ignored."
           },
-          "renpy.warnOnInvalidFilenameIssues": {
+          "renpy.diagnostics.warnOnInvalidFilenameIssues": {
             "type": "string",
             "default": "Error",
             "enum": [

src/diagnostics.ts

@@ -1,7 +1,7 @@
 // Diagnostics (warnings and errors)
 "use strict";
 
-import { Diagnostic, DiagnosticCollection, DiagnosticSeverity, ExtensionContext, Range, TextDocument, window, workspace } from "vscode";
+import { commands, Diagnostic, DiagnosticCollection, DiagnosticSeverity, ExtensionContext, languages, Range, TextDocument, window, workspace } from "vscode";
 import { NavigationData } from "./navigation-data";
 import { extractFilename } from "./workspace";
 
@@ -52,18 +52,37 @@ const rxStoreCheck = /\s+store\.(\w+)[^a-zA-Z_]?/g;
 const rxTabCheck = /^(\t+)/g;
 const rsComparisonCheck = /\s+(if|while)\s+(\w+)\s*(=)\s*(\w+)\s*/g;
 
+/**
+ * Set up diagnostics
+ * @param context extension context
+ */
+export function diagnosticsInit(context: ExtensionContext) {
+    const diagnostics = languages.createDiagnosticCollection("renpy");
+    context.subscriptions.push(diagnostics);
+
+    // custom command - refresh diagnostics
+    const refreshDiagnosticsCommand = commands.registerCommand("renpy.refreshDiagnostics", () => {
+        if (window.activeTextEditor) {
+            refreshDiagnostics(window.activeTextEditor.document, diagnostics);
+        }
+    });
+    context.subscriptions.push(refreshDiagnosticsCommand);
+
+    subscribeToDocumentChanges(context, diagnostics);
+}
+
 /**
  * Analyzes the text document for problems.
  * @param doc text document to analyze
  * @param diagnostics diagnostic collection
  */
-export function refreshDiagnostics(doc: TextDocument, diagnosticCollection: DiagnosticCollection): void {
+function refreshDiagnostics(doc: TextDocument, diagnosticCollection: DiagnosticCollection): void {
     if (doc.languageId !== "renpy") {
         return;
     }
 
     const diagnostics: Diagnostic[] = [];
-    const config = workspace.getConfiguration("renpy");
+    const config = workspace.getConfiguration("renpy.diagnostics");
 
     //Filenames must begin with a letter or number,
     //and may not begin with "00", as Ren'Py uses such files for its own purposes.
@@ -167,7 +186,7 @@ export function refreshDiagnostics(doc: TextDocument, diagnosticCollection: Diag
     diagnosticCollection.set(doc.uri, diagnostics);
 }
 
-export function subscribeToDocumentChanges(context: ExtensionContext, diagnostics: DiagnosticCollection): void {
+function subscribeToDocumentChanges(context: ExtensionContext, diagnostics: DiagnosticCollection): void {
     if (window.activeTextEditor) {
         refreshDiagnostics(window.activeTextEditor.document, diagnostics);
     }

src/extension.ts

@@ -43,7 +43,7 @@ import {
 import { RenpyColorProvider } from "./color";
 import { getStatusBarText, NavigationData } from "./navigation-data";
 import { cleanUpPath, getAudioFolder, getImagesFolder, getNavigationJsonFilepath, getWorkspaceFolder, stripWorkspaceFromFile } from "./workspace";
-import { refreshDiagnostics, subscribeToDocumentChanges } from "./diagnostics";
+import { diagnosticsInit } from "./diagnostics";
 import { getSemanticTokens } from "./semantics";
 import { getHover } from "./hover";
 import { getCompletionList } from "./completion";
@@ -212,9 +212,7 @@ export async function activate(context: ExtensionContext): Promise<void> {
     );
 
     // diagnostics (errors and warnings)
-    const diagnostics = languages.createDiagnosticCollection("renpy");
-    context.subscriptions.push(diagnostics);
-    subscribeToDocumentChanges(context, diagnostics);
+    diagnosticsInit(context);
 
     // custom command - refresh data
     const refreshCommand = commands.registerCommand("renpy.refreshNavigationData", async () => {
@@ -241,14 +239,6 @@ export async function activate(context: ExtensionContext): Promise<void> {
     });
     context.subscriptions.push(gotoFileLocationCommand);
 
-    // custom command - refresh diagnostics
-    const refreshDiagnosticsCommand = commands.registerCommand("renpy.refreshDiagnostics", () => {
-        if (window.activeTextEditor) {
-            refreshDiagnostics(window.activeTextEditor.document, diagnostics);
-        }
-    });
-    context.subscriptions.push(refreshDiagnosticsCommand);
-
     // custom command - toggle token debug view
     let isShowingTokenDebugView = false;
     const toggleTokenDebugViewCommand = commands.registerCommand("renpy.toggleTokenDebugView", () => {