Merge branch 'develop'

Author: znorman-harris

CHANGELOG.md

@@ -28,7 +28,29 @@ 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
 
-## 4.3.0
+## 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!
+
+Resolved an issue where problems were not correctly reported (or honoring settings changes) for files that didn't belong to a workspace.
+
+Added more controls to help fine-tune problem reporting and be able to disable it altogether:
+
+- Add code actions for being able to easily disable problem codes from within the editor for a workspace or user settings
+
+- Code actions work for notebooks or PRO files
+
+- Added an IDL comment-based API to control how problems are reported for files and lines of IDL code
+
+- Added a new preference that wil disable problem reporting altogether
+
+Update documentation for all problem codes to point to our configuration guide for how to disable problems
+
+Fixed an issue where, after the new documentation was added to the extension, that we no longer correctly opened example notebooks.
+
+With the addition of new commands for code actions and fixing reported problems, we have retroactively removed some from the command palette that were meant for internal use.
+
+## 4.3.0 February 2024
 
 Added official documentation to the extension! It is hosted on Github pages and a local copy is included with the extension.
 

README.md

@@ -184,6 +184,12 @@ See [CHANGELOG](CHANGELOG.md).
 
   - PDF icon is from "Material Icon Theme"
 
+- PDF Generation
+
+  - We use a 3rd party extension called "Markdown PDF" to create PDFs
+
+  - Credit goes to [yzane](https://github.com/yzane/vscode-markdown-pdf/tree/master) as the creator of this extension
+
 ## Usage Metrics
 
 The IDL extension for VSCode collects anonymous usage data on the extension. The goal of this information is to improve the overall experience, focus development on tools that users work with the most, and make sure our software can run on the average user's hardware.

apps/client-e2e/src/main.ts

@@ -1,14 +1,14 @@
 import { FindIDL } from '@idl/idl';
 import { EXTENSION_FULL_NAME, GetExtensionPath } from '@idl/shared';
 import { Sleep } from '@idl/tests/helpers';
-import { GetWorkspaceConfig, IIDLWorkspaceConfig } from '@idl/vscode/config';
-import { IDL_EXTENSION_CONFIG_KEYS } from '@idl/vscode/extension-config';
+import { GetWorkspaceConfig } from '@idl/vscode/config';
 import { IInitializeType } from '@idl/vscode/initialize-types';
 import { OpenFileInVSCode, VSCODE_COMMANDS } from '@idl/vscode/shared';
 import expect from 'expect';
 import { performance } from 'perf_hooks';
 import * as vscode from 'vscode';
 
+import { ResetSettingsForTests } from './tests/helpers/reset-settings-for-tests';
 import { TestRunner } from './tests/runner';
 
 /**
@@ -66,6 +66,12 @@ export async function run(): Promise<void> {
       GetExtensionPath('idl/test/client-e2e/load_first_problems.pro')
     );
 
+    // get the current workspace config
+    const config = GetWorkspaceConfig();
+
+    // reset config
+    await ResetSettingsForTests(config);
+
     // flag if we have started or not
     let started = false;
 
@@ -104,16 +110,6 @@ export async function run(): Promise<void> {
     // close editor
     await vscode.commands.executeCommand(VSCODE_COMMANDS.CLOSE_EDITOR);
 
-    // get the current workspace config
-    const config = GetWorkspaceConfig();
-
-    // set latest IDL folder
-    (config as IIDLWorkspaceConfig).update(
-      IDL_EXTENSION_CONFIG_KEYS.IDLDirectory,
-      idlDir,
-      true
-    );
-
     // check if we allow debug logs
     if (DEBUG_LOGS) {
       ACTIVATION_RESULT.client.logger.setDebug(DEBUG_LOGS);

apps/client-e2e/src/tests/client-e2e-config.interface.ts

@@ -0,0 +1,14 @@
+/**
+ * Test configuration with constants to easily change timeouts and delays when running tests
+ *
+ * These occasionally need to change so tests pass 100% of the time
+ */
+export const CLIENT_E2E_CONFIG = {
+  /** Test delays */
+  DELAYS: {
+    /** Problem delay for PRO files and anything else */
+    DEFAULT: 1000,
+    /** Problem delay for IDL Notebooks */
+    PROBLEMS_NOTEBOOK: 1000,
+  },
+};

apps/client-e2e/src/tests/helpers/reset-settings-for-tests.ts

@@ -0,0 +1,110 @@
+import { FindIDL } from '@idl/idl';
+import { GetExtensionPath, IDL_LANGUAGE_NAME } from '@idl/shared';
+import { IIDLWorkspaceConfig } from '@idl/vscode/config';
+import {
+  DEFAULT_IDL_EXTENSION_CONFIG,
+  IDL_EXTENSION_CONFIG_KEYS,
+} from '@idl/vscode/extension-config';
+import copy from 'fast-copy';
+import { deepEqual } from 'fast-equals';
+import { readFileSync } from 'fs';
+
+/**
+ * Scope we reset at
+ */
+const SCOPE = true;
+
+/** read in the package.json */
+const PACKAGE = JSON.parse(
+  readFileSync(GetExtensionPath('package.json'), 'utf-8')
+);
+
+/**
+ * Copy the config
+ */
+let SAFE_COPY = copy(DEFAULT_IDL_EXTENSION_CONFIG);
+
+/**
+ * Wrapper to correctly set config because of nonsense settings API
+ */
+async function ResetConfigToDefault(config: IIDLWorkspaceConfig, key: string) {
+  // starting point to descend
+  let nested = SAFE_COPY;
+
+  /** remove BS from keys from package */
+  const cleanKey = key.replace(`${IDL_LANGUAGE_NAME}.`, '');
+
+  /** get key path */
+  const split = cleanKey.split(/\./g);
+
+  // descend to get value
+  for (let i = 0; i < split.length; i++) {
+    nested = nested[split[i]];
+  }
+
+  // reset key if it has changed
+  if (!deepEqual(config.get(cleanKey), nested)) {
+    await config.update(cleanKey, nested, SCOPE);
+  }
+}
+
+/**
+ * Reset extension config for running tests to make sure it is always fresh and consistent
+ */
+export async function ResetSettingsForTests(config: IIDLWorkspaceConfig) {
+  // reset our safe copy
+  SAFE_COPY = copy(DEFAULT_IDL_EXTENSION_CONFIG);
+
+  // track props to update
+  let props: string[] = [];
+
+  /** Get defaults */
+  const fConfig = PACKAGE['contributes']['configuration'];
+
+  // get all properties
+  for (let i = 0; i < fConfig.length; i++) {
+    props = props.concat(Object.keys(fConfig[i]['properties']));
+  }
+
+  // reset all properties
+  for (let i = 0; i < props.length; i++) {
+    await ResetConfigToDefault(config, props[i]);
+  }
+
+  // // open settings
+  // await vscode.commands.executeCommand('workbench.action.openSettingsJson');
+
+  // // get current editor
+  // const activeEditor = vscode.window.activeTextEditor;
+
+  // // get current document
+  // const settings = activeEditor.document;
+
+  // // replace with default content
+  // // await ReplaceDocumentContent(settings, '{}');
+  // // await ReplaceDocumentContent(
+  // //   settings,
+  // //   `{"${IDL_LANGUAGE_NAME}.${
+  // //     IDL_EXTENSION_CONFIG_KEYS.IDLDirectory
+  // //   }": ${JSON.stringify(idlDir)}}`
+  // // );
+
+  // // update settings
+  // await settings.save();
+
+  // // Close the active settings.json editor
+  // await vscode.commands.executeCommand('workbench.action.closeActiveEditor');
+
+  /**
+   * Manually specify IDL folder
+   */
+  const idlDir = FindIDL();
+
+  // validate we know where it is
+  if (!idlDir) {
+    throw new Error('Unable to find IDL, cannot run tests');
+  }
+
+  // set latest IDL folder
+  await config.update(IDL_EXTENSION_CONFIG_KEYS.IDLDirectory, idlDir, true);
+}

apps/client-e2e/src/tests/interactions/_interactions-runner.ts

@@ -2,13 +2,29 @@ import { Logger } from '@idl/logger';
 
 import { Runner } from '../runner.class';
 import { AddDocs } from './add-docs';
+import {
+  ExecuteCodeActionsWithEditForNotebook,
+  ExecuteCodeActionsWithEditForPROFile,
+} from './execute-code-actions-with-edits';
+import { IDLDisableAllFromSettings } from './idl-disable-all-from-setting';
+import { IDLDisableAllFromSettingsForNotebook } from './idl-disable-all-from-setting-for-notebook';
+import {
+  IDLDisableAllFromComments,
+  IDLDisableLinesFromComments,
+} from './idl-disable-from-comments';
+import { IDLDisableIndividualsFromSettings } from './idl-disable-individuals-from-setting';
+import { IDLDisableIndividualsFromSettingsForNotebook } from './idl-disable-individuals-from-setting-for-notebook';
 import { IDLJSONInteractRight } from './idl-json-interact-right';
 import { IndexIDLFolderRightAndOpenEditClose } from './index-idl-folder-right-and-open-edit-close';
 import { MigrateCodeDL30, MigrateCodeDL30_2 } from './migrate-code-dl-3.0';
 import { NotebookProblemsTrackRight } from './notebook-problems-track-right';
 import { NotebookCompletionBasic } from './notebooks-completion-basic';
 import { NotebooksInteractRight } from './notebooks-interact-right';
 import { NotebooksNoDuplicateRoutines } from './notebooks-no-duplicate-routines';
+import {
+  ProCodeCodeActionsExisting,
+  ProCodeCodeActionsNoExisting,
+} from './pro-code-code-actions';
 import { ProCodeInteractRight } from './pro-code-interacts-right';
 import { TasksInteractRight } from './tasks-interact-right';
 
@@ -62,6 +78,65 @@ INTERACTIONS_RUNNER.addTest({
   fn: ProCodeInteractRight,
 });
 
+INTERACTIONS_RUNNER.addTest({
+  name: 'Disable problem reporting using comments (all)',
+  fn: IDLDisableAllFromComments,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Disable problem reporting using comments (by line)',
+  fn: IDLDisableLinesFromComments,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Disable problem reporting from root setting',
+  fn: IDLDisableAllFromSettings,
+  critical: true,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Disable problem reporting from root setting (notebooks)',
+  fn: IDLDisableAllFromSettingsForNotebook,
+  critical: true,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Disable problem reporting from individual setting',
+  fn: IDLDisableIndividualsFromSettings,
+  critical: true,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Disable problem reporting from individual setting (notebooks)',
+  fn: IDLDisableIndividualsFromSettingsForNotebook,
+  critical: true,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Code actions for none existing',
+  fn: ProCodeCodeActionsNoExisting,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Code actions for existing',
+  fn: ProCodeCodeActionsExisting,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Code actions for notebook cell',
+  fn: ProCodeCodeActionsExisting,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Execute code actions for PRO code',
+  fn: ExecuteCodeActionsWithEditForPROFile,
+});
+
+INTERACTIONS_RUNNER.addTest({
+  name: 'Execute code actions for notebook',
+  fn: ExecuteCodeActionsWithEditForNotebook,
+});
+
 INTERACTIONS_RUNNER.addTest({
   name: 'Notebooks interact right',
   fn: NotebooksInteractRight,