Various bug fixes and improvements

.eslintrc.json

@@ -25,6 +25,7 @@
     "@typescript-eslint/no-var-requires": "warn",
     "no-param-reassign": "warn", // Disable reassign, since this basically means you override the reference from the caller function with a new local version. (It doesn't do what you expect)
     "@typescript-eslint/no-namespace": "off",
-    "@typescript-eslint/ban-ts-comment": "off"
+    "@typescript-eslint/ban-ts-comment": "off",
+    "@typescript-eslint/no-unused-vars": "off"
   }
 }

.vscode/settings.json

@@ -31,6 +31,11 @@
     "javascript",
     "typescript"
   ],
+  "cSpell.words": [
+    "Ren'Py",
+    "rpyc",
+    "Uncompiled"
+  ]
   "editor.tokenColorCustomizations": {
     "[*Light*]": {
       "textMateRules": [

Contributing.md

@@ -32,6 +32,28 @@ If you want to add new features, please make sure to discuss it in an issue.
 5. Make your changes and submit a pull request with `develop` as your target branch
 6. Happy coding! 🚀
 
+Tips:
+
+If you're working on syntax features, add the following textmate rule to your vscode `settings.json` file:
+
+```json
+"editor.tokenColorCustomizations": {
+   "textMateRules": [
+   {
+      "scope": "debug.invalid.illegal.unmatched.renpy",
+      "settings": {
+         "foreground": "#f00"
+      }
+   },
+}
+```
+
+This will make any unmatched tokens red.
+
+Use ctrl+alt+shift+i to display the vscode build-in token debug information.
+
+https://regexr.com will be your new best friend.
+
 ## Additional Information
 
 ### Extension Versions

examples/game/script.rpy

@@ -44,7 +44,7 @@ label start:
 
     # These display lines of dialogue.
 
-    e "You've created a new Ren'Py game."
+    character.e "You've created a new Ren'Py game."
 
     # call a label 
 

examples/unit_test.rpy

@@ -326,6 +326,7 @@
 
             call .subroutine(2) from test #lol
 
+            call screen start #lol
             call expression "sub" + "routine" pass (count=3) #lol
             call expression "sub" + "routine" pass (count=3) from _class test #lol
 
@@ -547,11 +548,11 @@
         show bg washington
         with None
 
-        show eileen happy at left
+        show eileen happy at left #test
         show lucy mad at right
         with dissolve
 
-        show eileen happy at left with dissolve
+        show eileen happy with dissolve at left 
         show lucy mad at right with dissolve
 
         with None
@@ -625,6 +626,8 @@
                 pass
             "Fly above." if drank_tea:
                 pass
+            "Dig below." if len(my_var) >= 2:
+                pass
 
         default menuset = set()
 
@@ -1566,6 +1569,19 @@
                 @renpy.atl_warper
                 def linear(t):
                     return t
+
+            init python:
+                @dataclass
+                class LatLonPair:
+                    lon: float,
+                    lat: float
+
+                @dataclass
+                class SimpleWeatherInfo:
+                    id: int,
+                    main: str,
+                    description: str,
+                    icon: str
 
         label start:
             show eileen happy at a, b, c

src/color.ts

@@ -133,7 +133,7 @@ export async function injectCustomColorStyles(document: TextDocument) {
     // Disabled until filter is added to the tree class
     const documentTokens = await Tokenizer.tokenizeDocument(document);
     // TODO: Should probably make sure this constant is actually part of a tag, but for now this is fine.
-    const colorTags = documentTokens.filter((x) => x.token?.tokenType === LiteralTokenType.Color);
+    const colorTags = documentTokens.filter((x) => x.token?.type === LiteralTokenType.Color);
     const colorRules = new ValueEqualsSet<TextMateRule>();
 
     // Build the new rules for this file

src/completion.ts

@@ -22,7 +22,7 @@
     " ",
     "@",
     "-",
-    "("
+    "(",
 );
 
 /**
@@ -88,7 +88,7 @@
     const characters = Object.keys(NavigationData.gameObjects["characters"]);
 
     if (prefix === "renpy.music." || prefix === "renpy.audio.") {
         prefix = prefix.replace("renpy.", "").trim();
         const list = NavigationData.renpyAutoComplete.filter((item) => {
             if (typeof item.label === "string") {
                 item.label.startsWith(prefix);

src/configuration.ts

@@ -16,7 +16,7 @@ export class Configuration {
                         this.excludeCompiledFilesConfig();
                     }
                 }
-            })
+            }),
         );
     }
 

src/decorator.ts

@@ -68,7 +68,7 @@ export function injectCustomTextmateTokens(rules: ValueEqualsSet<TextMateRule>)
             },
             (reason) => {
                 logMessage(LogLevel.Error, "Failed to update the tokenColorCustomizations config! : " + reason);
-            }
+            },
         );
     }
 }

src/diagnostics.ts

@@ -129,7 +129,7 @@ export function refreshDiagnostics(doc: TextDocument, diagnosticCollection: Diag
                     const diagnostic = new Diagnostic(
                         range,
                         `Inconsistent spacing detected (${indention} given, expected a multiple of ${firstIndentation}). Indentation must consist only of spaces in Ren'Py scripts. Each indentation level must consist of the same number of spaces. (4 spaces is strongly recommended.)`,
-                        severity
+                        severity,
                     );
                     diagnostics.push(diagnostic);
                 }
@@ -175,7 +175,7 @@ export function subscribeToDocumentChanges(context: ExtensionContext, diagnostic
             if (editor) {
                 refreshDiagnostics(editor.document, diagnostics);
             }
-        })
+        }),
     );
 
     context.subscriptions.push(workspace.onDidChangeTextDocument((e) => refreshDiagnostics(e.document, diagnostics)));

src/extension.ts

@@ -18,13 +18,13 @@ import { referencesProvider } from "./references";
 import { registerDebugDecorator, unregisterDebugDecorator } from "./tokenizer/debug-decorator";
 import { Tokenizer } from "./tokenizer/tokenizer";
 import { signatureProvider } from "./signature";
-import { intializeLoggingSystems, logMessage, logToast, updateStatusBar } from "./logger";
+import { initializeLoggingSystems, logMessage, logToast, updateStatusBar } from "./logger";
 import { Configuration } from "./configuration";
 import { RenpyAdapterDescriptorFactory, RenpyConfigurationProvider } from "./debugger";
-import { RenpyTaskProvider } from "./taskprovider";
+import { RenpyTaskProvider } from "./task-provider";
 
 export async function activate(context: ExtensionContext): Promise<void> {
-    intializeLoggingSystems(context);
+    initializeLoggingSystems(context);
     updateStatusBar("$(sync~spin) Loading Ren'Py extension...");
 
     Configuration.initialize(context);
@@ -64,13 +64,18 @@ export async function activate(context: ExtensionContext): Promise<void> {
 
             if (!NavigationData.isImporting) {
                 updateStatusBar("$(sync~spin) Initializing Ren'Py static data...");
-                const uri = Uri.file(document.fileName);
-                const filename = stripWorkspaceFromFile(uri.path);
-                NavigationData.clearScannedDataForFile(filename);
-                NavigationData.scanDocumentForClasses(filename, document);
-                updateStatusBar(getStatusBarText());
+                try {
+                    const uri = Uri.file(document.fileName);
+                    const filename = stripWorkspaceFromFile(uri.path);
+                    NavigationData.clearScannedDataForFile(filename);
+                    NavigationData.scanDocumentForClasses(filename, document);
+                    updateStatusBar(getStatusBarText());
+                } catch (error) {
+                    updateStatusBar("Failed to load Ren'Py static data...");
+                    logMessage(LogLevel.Error, error as string);
+                }
             }
-        })
+        }),
     );
 
     // custom command - refresh data
@@ -161,7 +166,7 @@ export async function activate(context: ExtensionContext): Promise<void> {
                 request: "launch",
                 program: rpyPath,
             },
-            { noDebug: true }
+            { noDebug: true },
         );
 
         //call renpy
@@ -201,8 +206,13 @@ export async function activate(context: ExtensionContext): Promise<void> {
 
     // Detect file system change to the navigation.json file and trigger a refresh
     updateStatusBar("$(sync~spin) Initializing Ren'Py static data...");
-    await NavigationData.init(context.extensionPath);
-    updateStatusBar(getStatusBarText());
+    try {
+        await NavigationData.init(context.extensionPath);
+        updateStatusBar(getStatusBarText());
+    } catch (error) {
+        updateStatusBar("Failed to load Ren'Py static data...");
+        logMessage(LogLevel.Error, error as string);
+    }
 
     try {
         fs.watch(getNavigationJsonFilepath(), async (event, filename) => {
@@ -270,8 +280,8 @@ export async function activate(context: ExtensionContext): Promise<void> {
                     ];
                 },
             },
-            DebugConfigurationProviderTriggerKind.Dynamic
-        )
+            DebugConfigurationProviderTriggerKind.Dynamic,
+        ),
     );
 
     const taskProvider = new RenpyTaskProvider();
@@ -324,9 +334,9 @@ function RunWorkspaceFolder(): boolean {
     if (isValidExecutable(rpyPath)) {
         const renpyPath = cleanUpPath(Uri.file(rpyPath).path);
         const cwd = renpyPath.substring(0, renpyPath.lastIndexOf("/"));
-        const workfolder = getWorkspaceFolder();
-        const args: string[] = [`${workfolder}`, "run"];
-        if (workfolder.endsWith("/game")) {
+        const workFolder = getWorkspaceFolder();
+        const args: string[] = [`${workFolder}`, "run"];
+        if (workFolder.endsWith("/game")) {
             try {
                 updateStatusBar("$(sync~spin) Running Ren'Py...");
                 const result = cp.spawnSync(rpyPath, args, {
@@ -351,7 +361,7 @@ function RunWorkspaceFolder(): boolean {
         }
         return false;
     } else {
-        logMessage(LogLevel.Warning, "config for rennpy does not exist");
+        logMessage(LogLevel.Warning, "config for renpy does not exist");
         return false;
     }
 }

src/logger.ts

@@ -6,7 +6,7 @@ const statusBar = window.createStatusBarItem(StatusBarAlignment.Right, 100);
 
 let extensionMode: ExtensionMode = null!;
 
-export function intializeLoggingSystems(context: ExtensionContext) {
+export function initializeLoggingSystems(context: ExtensionContext) {
     extensionMode = context.extensionMode;
 
     context.subscriptions.push(outputChannel);

src/navigation-data.ts

@@ -1,3 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
 import { commands, CompletionItem, CompletionItemKind, CompletionItemTag, LogLevel, MarkdownString, Position, SnippetString, TextDocument, window, workspace } from "vscode";
 import { getDefinitionFromFile } from "./hover";
 import { DataType, getBaseTypeFromDefine, getNamedParameter, getPyDocsFromTextDocumentAtLine, Navigation, splitParameters, stripQuotes } from "./navigation";
@@ -198,7 +199,7 @@
         for (const key in NavigationData.data.location) {
             const type = NavigationData.data.location[key];
             if (type[keyword]) {
                 const data = type[keyword];
                 if (data instanceof Navigation) {
                     //!data.length
                     locations.push(data);
@@ -272,7 +273,7 @@
     }
 
     static getNavigationDumpEntry(keyword: string): Navigation | undefined {
         const data = NavigationData.getNavigationDumpEntries(keyword);
         if (data) {
             return data[0];
         }
@@ -573,7 +574,7 @@
                 }
 
                 if (line2.startsWith("@property")) {
                     const matches = document
                         .lineAt(index + 1)
                         .text.trim()
                         .match(rxDef);
@@ -615,7 +616,7 @@
             }
             let finished = false;
             while (!finished && index < document.lineCount) {
                 let line = document.lineAt(index).text.replace(/[\n\r]/g, "");
                 if (line.length > 0 && line.length - line.trimStart().length <= spacing) {
                     finished = true;
                     break;
@@ -649,11 +650,11 @@
 		*/
 
         if (typeof array[0] === "string" && (array[0] === "obsolete" || array[0] === "transitions")) {
             source = array[0];
         } else if (typeof array[4] === "string" && array[4] === "Action") {
             source = array[4].toLowerCase();
         } else if (source === "equivalent") {
             source = array[0];
         }
 
         return new Navigation(
@@ -663,7 +664,7 @@
             0, //location
             array[5], //documentation
             array[2], //args
-            array[4] //type
+            array[4], //type
         );
     }
 
@@ -695,7 +696,7 @@
                     const key = extractFilenameWithoutExtension(filename);
                     if (key) {
                         const path = stripWorkspaceFromFile(cleanUpPath(file.path));
                         const displayable = new Displayable(key, "image", "", path, -1);
                         NavigationData.data.location["displayable"][key] = displayable;
                     }
                 }
@@ -740,7 +741,7 @@
                 if (filename.startsWith("game/audio/")) {
                     const pythonName = NavigationData.getPythonName(filename);
                     if (pythonName) {
                         const key = "audio." + extractFilenameWithoutExtension(filename);
                         if (key && !NavigationData.gameObjects["audio"][key]) {
                             NavigationData.gameObjects["audio"][key] = key;
                         }

src/semantics.ts

@@ -26,7 +26,7 @@ export const semanticTokensProvider = languages.registerDocumentSemanticTokensPr
             });
         },
     },
-    legend
+    legend,
 );
 
 export function getSemanticTokens(document: TextDocument): SemanticTokens {

src/signature.ts

@@ -19,7 +19,7 @@ export const signatureProvider = languages.registerSignatureHelpProvider(
     },
     "(",
     ",",
-    "="
+    "=",
 );
 
 /**