Merge remote-tracking branch 'origin/develop'

Author: znorman-harris

CHANGELOG.md

@@ -18,6 +18,34 @@ Document some advanced types so users may try them out and provide feedback. The
 
 Auto-complete for blocks re-work: Partial implementation of auto-complete for blocks that works better than the default snippets that exists. This functions for if-then-else only right now to verify the user experience is what it needs to be.
 
+## 5.1.0 - August 2025
+
+This verion introduces a new selection of IDL Tutorials! These come as a collection of notebooks to help new users get up and running. In the IDL sidebar, you'll see a new section called "IDL Tutorials" with language-specific content.
+
+> With this change, we have also migrated the ENVI and IDL Example notebooks under the tutorials section.
+
+Add a new auto-complete for block statements (i.e. if-then-begin) that functions much better compared to what we had. If there are any weird cases, or cases for block auto-complete that are missing, let us know and we can add them in.
+
+Add a new sidebar entry to launch a session of ENVI and IDL. Requires an ENVI license and that you are using the IDL that is packaged with ENVI.
+
+With the extension including GitHub Copilot integration, we have changed the extension so that it always activates in VSCode. Otherwise tools in Agent mode through GitHub Copilot would fail to run as our extension was not started.
+
+Tweak hanging indent for procedures and procedure methods to use the first comma as the syntax we align to.
+
+Fix an issue with catching standalone expressions where the problem would be incorrectly reported for chained property access.
+
+Fix docs issues with `colorbar()` function not having all properties for keywords.
+
+Fix docs issue where "ipm" was an unknown structure and would throw fake errors when using the static methods on the class.
+
+Fixed an issue where IDL would show an error message about being unable to check the version if you had an IDL_STARTUP file specified that generated output.
+
+Potentially fix an issue with auto-complete that would occur sometimes with code blocks.
+
+Updated type parsing to support older code that used the name of the functions to create arrays as array types. We now map types such as "bytarr" to the proper IDL types of "Array<Byte>" for full type/auto complete support.
+
+Tweak notebook formatting that removes the trailing space at the end of cells. When you have many cells, this adds empty space that's not always needed or helpful.
+
 ## 5.0.1 - July 2024
 
 Fix a bug with IDL Notebooks when you would open a new notebook though the MCP tools.

apps/client-e2e/src/tests/interactions/code-actions/execute-code-actions-with-edits.ts

@@ -1,5 +1,6 @@
 import { GetExtensionPath } from '@idl/idl/files';
 import { IDL_COMMANDS, Sleep } from '@idl/shared/extension';
+import { SplitCode } from '@idl/tokenizer';
 import { AutoFixProblem } from '@idl/types/problem-codes';
 import { OpenFileInVSCode, OpenNotebookInVSCode } from '@idl/vscode/shared';
 import expect from 'expect';
@@ -83,12 +84,14 @@ export const ExecuteCodeActionsWithEditForNotebook: RunnerFunction = async (
   const doc = nb.getCells()[edit[0].cell].document;
 
   // make sure output is correct
-  expect(doc.getText()).toEqual(
-    readFileSync(
-      GetExtensionPath(
-        'idl/test/client-e2e/problems/code_actions_fix_cell_after.pro'
-      ),
-      'utf-8'
+  expect(SplitCode(doc.getText())).toEqual(
+    SplitCode(
+      readFileSync(
+        GetExtensionPath(
+          'idl/test/client-e2e/problems/code_actions_fix_cell_after.pro'
+        ),
+        'utf-8'
+      )
     )
   );
 };

apps/client-e2e/src/tests/notebooks/_notebook-runner.ts

@@ -210,7 +210,7 @@ NOTEBOOK_RUNNER.addTest({
 });
 
 NOTEBOOK_RUNNER.addTest({
-  name: 'Replace cell paths for stops',
+  name: 'Replace cell paths for stops and make sure stop always works',
   fn: NotebooksReplaceCellPathsOnStop,
 });
 

apps/client-e2e/src/tests/notebooks/notebooks-replace-cell-paths-on-stop.ts

@@ -5,9 +5,23 @@ import { OpenNotebookInVSCode } from '@idl/vscode/shared';
 import expect from 'expect';
 import * as vscode from 'vscode';
 
+import { CLIENT_E2E_CONFIG } from '../client-e2e-config.interface';
 import { RunnerFunction } from '../runner.interface';
+import { CompareCellOutputs } from './helpers/compare-cells';
+import { ICompareCellOutputs } from './helpers/compare-cells.interface';
 import { CompareNotebookJSONOutputs } from './helpers/compare-notebook-json-outputs';
 
+/**
+ * Types of outputs from cells that we expect to have
+ */
+export const CELL_OUTPUT: ICompareCellOutputs[] = [
+  {
+    idx: 0,
+    success: false,
+    mimeTypes: ['text/plain'],
+  },
+];
+
 /**
  * Verifies we replace paths when we stop
  */
@@ -24,14 +38,45 @@ export const NotebooksReplaceCellPathsOnStop: RunnerFunction = async (init) => {
   const nb = await OpenNotebookInVSCode(nbUri, true);
 
   // short pause to parse
-  await Sleep(500);
+  await Sleep(CLIENT_E2E_CONFIG.DELAYS.DEFAULT);
 
   // run all cells
   await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
 
   // save to disk
   await nb.save();
 
+  // wait
+  await Sleep(CLIENT_E2E_CONFIG.DELAYS.PROBLEMS_NOTEBOOK);
+
+  // compare cells
+  await CompareCellOutputs(nb, CELL_OUTPUT);
+
+  /**
+   * ==================================================================
+   * Run all cells again and compare the outputs to make sure
+   * we catch stopping right
+   * ==================================================================
+   */
+
+  // run all cells
+  await vscode.commands.executeCommand(VSCODE_COMMANDS.NOTEBOOK_RUN_ALL);
+
+  // save to disk
+  await nb.save();
+
+  // wait
+  await Sleep(CLIENT_E2E_CONFIG.DELAYS.PROBLEMS_NOTEBOOK);
+
+  // compare cells
+  await CompareCellOutputs(nb, CELL_OUTPUT);
+
+  /**
+   * ==================================================================
+   * Make sure JSON paths match
+   * ==================================================================
+   */
+
   // compare outputs
   await CompareNotebookJSONOutputs(expectedUri, nbUri);
 

apps/client-e2e/src/tests/notebooks/open-envi-notebook-example.ts

@@ -17,7 +17,8 @@ import { RunnerFunction } from '../runner.interface';
 export const OpenENVINotebookExample: RunnerFunction = async (init) => {
   // make a new notebook
   await vscode.commands.executeCommand(
-    IDL_COMMANDS.NOTEBOOKS.OPEN_ENVI_EXAMPLE
+    IDL_COMMANDS.TUTORIALS.OPEN_IDL_TUTORIAL,
+    'hello-world-envi.idlnb'
   );
 
   // short pause

apps/client-e2e/src/tests/notebooks/open-idl-notebook-example.ts

@@ -16,7 +16,10 @@ import { RunnerFunction } from '../runner.interface';
  */
 export const OpenIDLNotebookExample: RunnerFunction = async (init) => {
   // make a new notebook
-  await vscode.commands.executeCommand(IDL_COMMANDS.NOTEBOOKS.OPEN_IDL_EXAMPLE);
+  await vscode.commands.executeCommand(
+    IDL_COMMANDS.TUTORIALS.OPEN_IDL_TUTORIAL,
+    'hello-world-idl.idlnb'
+  );
 
   // short pause
   await Sleep(100);

apps/client-e2e/src/tests/notebooks/reset-notebook-examples.ts

@@ -20,9 +20,7 @@ export const ResetNotebookExamples: RunnerFunction = async (init) => {
   expect(existsSync(EXAMPLE_NOTEBOOKS)).toBeFalsy();
 
   // close
-  await vscode.commands.executeCommand(
-    IDL_COMMANDS.NOTEBOOKS.RESET_NOTEBOOK_EXAMPLES
-  );
+  await vscode.commands.executeCommand(IDL_COMMANDS.TUTORIALS.RESET_TUTORIALS);
 
   // pause momentarily
   await Sleep(100);

apps/client-web/tsconfig.app.json

@@ -144,6 +144,7 @@
       ],
       "@idl/vscode/help-view": ["libs/vscode/help-view/src/index.ts"],
       "@idl/vscode/idl-machine": ["libs/vscode/idl-machine/src/index.ts"],
+      "@idl/vscode/idl-tutorials": ["libs/vscode/idl-tutorials/src/index.ts"],
       "@idl/vscode/initialize-types": [
         "libs/vscode/initialize-types/src/index.ts"
       ],

apps/client/src/main.ts

@@ -9,6 +9,7 @@ import { InitializeDebugger } from '@idl/vscode/debug';
 import { IDL_DECORATIONS_MANAGER } from '@idl/vscode/decorations';
 import { InitializeDocs } from '@idl/vscode/docs';
 import { InitializeENVIOpener } from '@idl/vscode/envi-opener';
+import { InitializeIDLTutorials } from '@idl/vscode/idl-tutorials';
 import { IInitializeType } from '@idl/vscode/initialize-types';
 import { InitializeNotebooks } from '@idl/vscode/notebooks/client';
 import { InitializeIDLTerminal } from '@idl/vscode/terminal';
@@ -53,6 +54,8 @@ export async function activate(
   // initialize our tree view
   InitializeTree(ctx, false);
 
+  InitializeIDLTutorials(ctx);
+
   // return result
   return {
     client,

apps/idl-docs-parser/src/overrides/detail/structures.interface.ts

@@ -25,6 +25,10 @@ export const ADD_STRUCTURES: {
     display: 'idl_shape_entity',
     source: 'idl',
   },
+  ipm: {
+    display: 'ipm',
+    source: 'idl',
+  },
 };
 
 /**
@@ -422,6 +426,9 @@ export const STRUCTURE_OVERRIDE: IStructureOverride = {
   idlitcomponent: {
     display: 'IDLitComponent',
   },
+  ipm: {
+    display: 'ipm',
+  },
   envivector: {
     display: 'ENVIVector',
     properties: {