Merge branch 'develop'

Author: znorman-harris

CHANGELOG.md

@@ -28,7 +28,7 @@ Added the ability to convert a notebook to a PDF! This requires an additional ex
 
 - You do need to save your notebook to disk so we have a path to write the Markdown and PDF files
 
-## Unreleased
+## 4.4.0 - April 2024
 
 Fixed an issue where the names of ENVI and IDL tasks were incorrectly lower-case instead of what the user had specified in the task files.
 
@@ -66,6 +66,8 @@ Re-work the logic for running files to be much more flexible. Here's how it beha
 
 4. If we detect a syntax error when we compile your file, we stop before running
 
+Fixed an issue where, when a parameter had the name "file", "http", "https", "s3", or "ftp", it would incorrectly be skipped with docs parsing.
+
 ## 4.3.1 February 2024
 
 Resolved an issue where the language server would take a while to startup when you didn't have any workspace folders open. It should be almost instantaneous now!

apps/test-tokenizer/src/test-maker/cache/cache.json

@@ -177,6 +177,22 @@ export const AUTO_LOCAL_GLOBAL_SCOPE_COMPILE_AND_TYPES_TESTS: IAutoLocalGlobalSc
             ``,
           ],
         },
+        {
+          name: 'allow parameters named "file"',
+          code: [
+            `;+`,
+            `; :Arguments:`,
+            `;   file: in, required, String`,
+            `;     Placeholder docs for argument, keyword, or property`,
+            `;`,
+            `;-`,
+            `pro argbug, file`,
+            `  compile_opt idl2`,
+            ``,
+            `  print, file`,
+            `end`,
+          ],
+        },
       ],
     },
     {

apps/test-tokenizer/src/test-maker/tests/auto-local-global-scope-compile-and-types-tests.interface.ts

@@ -6,8 +6,7 @@ export const HEADER_TAG = /^\s*(?<!:):(?!:)([^:]+)(?<!:):(?!:)/i;
 /**
  * Regex to detect arguments or keywords
  */
-export const ARG_KW_PROPERTY_TAG =
-  /^\s*([^:\s]*)\s*(?<!:|https?|ftp|s3|file):(?!:)/i;
+export const ARG_KW_PROPERTY_TAG = /^\s*([^:\s]*)\s*:(?!:|\/\/)/i;
 // export const ARG_KW_PROPERTY_TAG = /^\s*([^:\s]*)\s*(?<!:):(?!:)/i;
 
 /**

libs/parsing/syntax-tree/src/lib/docs/docs.regex.interface.ts

@@ -1,4 +1,4 @@
 /**
  * Version of the extension
  */
-export const VERSION = '4.3.1';
+export const VERSION = '4.4.0';

libs/shared/src/lib/version.interface.ts

@@ -485,4 +485,113 @@ describe(`[auto generated] Complex real world test`, () => {
     // verify results
     expect(tokenized.compile).toEqual(expectedCompile);
   });
+
+  it(`[auto generated] allow parameters named "file"`, async () => {
+    // create index
+    const index = new IDLIndex(
+      new LogManager({
+        alert: () => {
+          // do nothing
+        },
+      }),
+      0
+    );
+
+    // test code to extract tokens from
+    const code = [
+      `;+`,
+      `; :Arguments:`,
+      `;   file: in, required, String`,
+      `;     Placeholder docs for argument, keyword, or property`,
+      `;`,
+      `;-`,
+      `pro argbug, file`,
+      `  compile_opt idl2`,
+      ``,
+      `  print, file`,
+      `end`,
+    ];
+
+    // extract tokens
+    const tokenized = await index.getParsedProCode(
+      'not-real',
+      code,
+      new CancellationToken(),
+      { postProcess: true }
+    );
+
+    // define expected local variables
+    const expectedVars: ILocalTokens = {
+      func: {},
+      pro: {
+        argbug: {
+          file: {
+            type: 'v',
+            name: 'file',
+            pos: [6, 12, 4],
+            meta: {
+              display: 'file',
+              isDefined: true,
+              usage: [
+                [6, 12, 4],
+                [9, 9, 4],
+              ],
+              docs: 'Placeholder docs for argument, keyword, or property',
+              source: 'user',
+              type: [{ name: 'String', display: 'String', args: [], meta: {} }],
+            },
+          },
+        },
+      },
+      main: {},
+    };
+
+    // verify results
+    expect(tokenized.local).toEqual(expectedVars);
+
+    // define expected global variables
+    const expectedGlobal: GlobalTokens = [
+      {
+        type: 'p',
+        name: 'argbug',
+        pos: [6, 4, 6],
+        meta: {
+          source: 'user',
+          args: {
+            file: {
+              docs: 'Placeholder docs for argument, keyword, or property',
+              direction: 'in',
+              source: 'internal',
+              type: [{ name: 'String', display: 'String', args: [], meta: {} }],
+              private: false,
+              req: true,
+              display: 'file',
+              code: true,
+              pos: [6, 12, 4],
+            },
+          },
+          docs: '\n```idl\nargbug, file\n```\n\n\n\n\n#### Arguments\n\n- **file**: in, required, String\n\n  Placeholder docs for argument, keyword, or property\n\n',
+          docsLookup: { default: '' },
+          display: 'argbug',
+          kws: {},
+          private: false,
+          struct: [],
+        },
+        file: 'not-real',
+      },
+    ];
+
+    // verify results
+    expect(tokenized.global).toEqual(expectedGlobal);
+
+    // define expected compile options
+    const expectedCompile: ICompileOptions = {
+      func: {},
+      pro: { argbug: ['idl2'] },
+      main: [],
+    };
+
+    // verify results
+    expect(tokenized.compile).toEqual(expectedCompile);
+  });
 });