Merge branch 'develop'

.vscode/settings.json

@@ -47,6 +47,7 @@
     "imagefromuri",
     "INCREMENTERS",
     "INDGEN",
+    "ioerror",
     "lineanimation",
     "minilog",
     "mlog",

CHANGELOG.md

@@ -30,6 +30,16 @@ Added the ability to convert a notebook to a PDF! This requires an additional ex
 
 ## 4.3.0
 
+Added official documentation to the extension! It is hosted on Github pages and a local copy is included with the extension.
+
+- If you are offline, and working locally, you can update your preferences to serve the docs through the language server
+
+- If you do use local docs, make sure that the port is free and not currently in use
+
+- All problem codes include links that, based on your preference, will take you to examples in the docs and tips to fix
+
+- Let us know if there are more things that need to be documented, or if documentation can be improved in any way
+
 Fixed a bug where python statements of the form ">>>" were incorrectly formatted with an extra space after the arrows.
 
 For the upcoming release of ENVI Deep Learning 3.0, added a new pipeline for migrating code from older to newer versions. While we typically do not make breaking changes, if we ever do, we now have a pattern to help automate getting your code up-to-date with the latest version of IDL, ENVI, and module APIs.
@@ -70,6 +80,16 @@ We now automatically detect the type from `call_function()` if we have a known f
 
 Fixed an edge case with types where the "any" type was not properly being detected with arrays of structures
 
+Fixed an issue where `on_ioerror` was treated as a procedure when it should be a control statement
+
+Fixed a typo in the problem code alias `docs-invalid-require` to correctly be `docs-invalid-required`. If you had this problem disabled, you will need to disable it again.
+
+Fixed a typo in the problem code alias `docs-missing-arg` to correctly be `docs-missing-args`. If you had this problem disabled, you will need to disable it again.
+
+Fixed a typo in the problem code alias `docs-missing-kw` to correctly be `docs-missing-kws`. If you had this problem disabled, you will need to disable it again.
+
+---
+
 Migrated the following features from "Preview Features" above:
 
 Code style revamp! We reworked how routines, routine methods, properties, and structure names get formatted. This includes:

apps/client-e2e/src/main.ts

@@ -1,6 +1,6 @@
 import { FindIDL } from '@idl/idl';
 import { EXTENSION_FULL_NAME, GetExtensionPath } from '@idl/shared';
-import { Sleep } from '@idl/test-helpers';
+import { Sleep } from '@idl/tests/helpers';
 import { GetWorkspaceConfig, IIDLWorkspaceConfig } from '@idl/vscode/config';
 import { IDL_EXTENSION_CONFIG_KEYS } from '@idl/vscode/extension-config';
 import { IInitializeType } from '@idl/vscode/initialize-types';

apps/client-e2e/src/tests/debugging/breakpoint-step-in-step-out.ts

@@ -1,5 +1,5 @@
 import { GetExtensionPath, IDL_COMMANDS } from '@idl/shared';
-import { Sleep } from '@idl/test-helpers';
+import { Sleep } from '@idl/tests/helpers';
 import {
   GetActivePROCodeWindow,
   OpenFileInVSCode,

apps/client-e2e/src/tests/debugging/compile.ts

@@ -1,6 +1,6 @@
 import { CleanIDLOutput } from '@idl/idl';
 import { IDL_COMMANDS } from '@idl/shared';
-import { Sleep } from '@idl/test-helpers';
+import { Sleep } from '@idl/tests/helpers';
 import { GetActivePROCodeWindow } from '@idl/vscode/shared';
 import expect from 'expect';
 import * as vscode from 'vscode';

apps/client-e2e/src/tests/debugging/continue.ts

@@ -1,5 +1,5 @@
 import { GetExtensionPath, IDL_COMMANDS } from '@idl/shared';
-import { Sleep } from '@idl/test-helpers';
+import { Sleep } from '@idl/tests/helpers';
 import {
   GetActivePROCodeWindow,
   OpenFileInVSCode,

apps/client-e2e/src/tests/debugging/edit.ts

@@ -1,5 +1,5 @@
 import { IDL_COMMANDS } from '@idl/shared';
-import { Sleep } from '@idl/test-helpers';
+import { Sleep } from '@idl/tests/helpers';
 import { GetActivePROCodeWindow } from '@idl/vscode/shared';
 import expect from 'expect';
 import * as vscode from 'vscode';

apps/client-e2e/src/tests/notebooks/notebook-to-pro-code-all-cells-2.ts

@@ -1,10 +1,10 @@
-import { INotebookToProCodeOptions } from '@idl/notebooks/types';
 import {
   GetExtensionPath,
   IDL_COMMANDS,
   IDL_LANGUAGE_NAME,
   Sleep,
 } from '@idl/shared';
+import { INotebookToProCodeOptions } from '@idl/types/notebooks';
 import { OpenNotebookInVSCode, VSCODE_COMMANDS } from '@idl/vscode/shared';
 import expect from 'expect';
 import { readFileSync } from 'fs';

apps/client-e2e/src/tests/notebooks/notebook-to-pro-code-all-cells.ts

@@ -1,10 +1,10 @@
-import { INotebookToProCodeOptions } from '@idl/notebooks/types';
 import {
   GetExtensionPath,
   IDL_COMMANDS,
   IDL_LANGUAGE_NAME,
   Sleep,
 } from '@idl/shared';
+import { INotebookToProCodeOptions } from '@idl/types/notebooks';
 import { OpenNotebookInVSCode, VSCODE_COMMANDS } from '@idl/vscode/shared';
 import expect from 'expect';
 import { readFileSync } from 'fs';

apps/client-e2e/src/tests/notebooks/notebook-to-pro-code-only-code.ts

@@ -1,10 +1,10 @@
-import { INotebookToProCodeOptions } from '@idl/notebooks/types';
 import {
   GetExtensionPath,
   IDL_COMMANDS,
   IDL_LANGUAGE_NAME,
   Sleep,
 } from '@idl/shared';
+import { INotebookToProCodeOptions } from '@idl/types/notebooks';
 import { OpenNotebookInVSCode, VSCODE_COMMANDS } from '@idl/vscode/shared';
 import expect from 'expect';
 import { readFileSync } from 'fs';

apps/client-e2e/src/tests/notebooks/run-test-envi-map-notebook.ts

@@ -1,5 +1,5 @@
-import { IDL_NOTEBOOK_MIME_TYPE } from '@idl/notebooks/types';
 import { GetExtensionPath } from '@idl/shared';
+import { IDL_NOTEBOOK_MIME_TYPE } from '@idl/types/notebooks';
 
 import { RunnerFunction } from '../runner.interface';
 import { ICompareCellOutputs } from './helpers/compare-cells.interface';

apps/client-e2e/src/tests/notebooks/run-test-envi-notebook.ts

@@ -1,5 +1,5 @@
-import { IDL_NOTEBOOK_MIME_TYPE } from '@idl/notebooks/types';
 import { GetExtensionPath } from '@idl/shared';
+import { IDL_NOTEBOOK_MIME_TYPE } from '@idl/types/notebooks';
 
 import { RunnerFunction } from '../runner.interface';
 import { ICompareCellOutputs } from './helpers/compare-cells.interface';

apps/client-e2e/src/tests/notebooks/run-test-notebook.ts

@@ -1,5 +1,5 @@
-import { IDL_NOTEBOOK_MIME_TYPE } from '@idl/notebooks/types';
 import { GetExtensionPath } from '@idl/shared';
+import { IDL_NOTEBOOK_MIME_TYPE } from '@idl/types/notebooks';
 
 import { RunnerFunction } from '../runner.interface';
 import { ICompareCellOutputs } from './helpers/compare-cells.interface';

apps/idl-docs-parser/src/helpers/borrow-keywords-from.ts

@@ -3,7 +3,7 @@ import {
   GlobalStructureToken,
   GlobalTokens,
   IGlobalIndexedToken,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { GET_KEYWORDS_FROM } from '../overrides/properties-and-keywords/get-keywords-from';
 import { UpdateThese } from './set-keywords-as-properties.interface';

apps/idl-docs-parser/src/helpers/global-to-display-names.ts

@@ -1,5 +1,5 @@
-import { GLOBAL_TOKEN_TYPES, GlobalTokens } from '@idl/data-types/core';
 import { GlobalDisplayNameLookup, IGlobalFromIDL } from '@idl/parsing/routines';
+import { GLOBAL_TOKEN_TYPES, GlobalTokens } from '@idl/types/core';
 
 /**
  * Converts our pre-parsed IDL routine and docs information into global tokens that can plug directly

apps/idl-docs-parser/src/helpers/parsed-to-global.ts

@@ -1,6 +1,6 @@
-import { GlobalTokens, IRoutineMetadata } from '@idl/data-types/core';
 import { IGlobalFromIDL } from '@idl/parsing/routines';
 import { DocsToMarkdown, MARKDOWN_TYPE_LOOKUP } from '@idl/parsing/syntax-tree';
+import { GlobalTokens, IRoutineMetadata } from '@idl/types/core';
 import { existsSync, readFileSync } from 'fs';
 import * as progressBar from 'progress';
 

apps/idl-docs-parser/src/helpers/resolve-methods.ts

@@ -1,6 +1,6 @@
-import { GLOBAL_TOKEN_TYPES } from '@idl/data-types/core';
 import { GlobalDisplayNameLookup, IGlobalFromIDL } from '@idl/parsing/routines';
 import { MatchGlobal } from '@idl/shared';
+import { GLOBAL_TOKEN_TYPES } from '@idl/types/core';
 
 import { IDL_DIR } from '../idl-dir.interface';
 import { IDocsByRoutine } from '../main.interface';

apps/idl-docs-parser/src/helpers/routine-to-global.ts

@@ -1,3 +1,6 @@
+import { GlobalDisplayNameLookup, IGlobalFromIDL } from '@idl/parsing/routines';
+import { DocsToMarkdown, MARKDOWN_TYPE_LOOKUP } from '@idl/parsing/syntax-tree';
+import { HostedDocsURLFromLocal } from '@idl/shared';
 import {
   DEFAULT_DATA_TYPE,
   GLOBAL_TOKEN_SOURCE_LOOKUP,
@@ -15,10 +18,7 @@ import {
   ParameterDirection,
   ParseIDLType,
   SerializeIDLType,
-} from '@idl/data-types/core';
-import { GlobalDisplayNameLookup, IGlobalFromIDL } from '@idl/parsing/routines';
-import { DocsToMarkdown, MARKDOWN_TYPE_LOOKUP } from '@idl/parsing/syntax-tree';
-import { HostedDocsURLFromLocal } from '@idl/shared';
+} from '@idl/types/core';
 import * as merge from 'deepmerge';
 import { join } from 'path';
 

apps/idl-docs-parser/src/helpers/set-keywords-as-properties.interface.ts

@@ -1,3 +1,3 @@
-import { GlobalRoutineTokenType } from '@idl/data-types/core';
+import { GlobalRoutineTokenType } from '@idl/types/core';
 
 export type UpdateThese = [string, GlobalRoutineTokenType][];

apps/idl-docs-parser/src/helpers/set-keywords-from-properties.ts

@@ -4,7 +4,7 @@ import {
   GlobalTokens,
   GlobalTokenType,
   IGlobalIndexedToken,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { PROPERTIES_ARE_KEYWORDS } from '../overrides/properties-and-keywords/properties-are-keywords';
 import { UpdateThese } from './set-keywords-as-properties.interface';

apps/idl-docs-parser/src/helpers/set-task-types.ts

@@ -1,12 +1,12 @@
+import { LoadTask } from '@idl/schemas/tasks';
+import { TASK_FILE_EXTENSION, TASK_FILE_GLOB_PATTERN } from '@idl/shared';
 import {
   GLOBAL_TOKEN_TYPES,
   GlobalStructureToken,
   GlobalTokens,
   IGlobalIndexedToken,
-} from '@idl/data-types/core';
-import { TaskToGlobalToken } from '@idl/data-types/tasks';
-import { LoadTask } from '@idl/schemas/tasks';
-import { TASK_FILE_EXTENSION, TASK_FILE_GLOB_PATTERN } from '@idl/shared';
+} from '@idl/types/core';
+import { TaskToGlobalToken } from '@idl/types/tasks';
 import * as glob from 'fast-glob';
 import { basename, join } from 'path';
 

apps/idl-docs-parser/src/overrides/cleaners/cleaners.interface.ts

@@ -1,7 +1,4 @@
-import {
-  GlobalRoutineTokenType,
-  IGlobalIndexedToken,
-} from '@idl/data-types/core';
+import { GlobalRoutineTokenType, IGlobalIndexedToken } from '@idl/types/core';
 
 /**
  * Type for callbacks that clean specific types of tokens, depending on what we found

apps/idl-docs-parser/src/overrides/cleaners/procedures.interface.ts

@@ -1,4 +1,4 @@
-import { GlobalProcedureToken } from '@idl/data-types/core';
+import { GlobalProcedureToken } from '@idl/types/core';
 
 import { Cleaners } from './cleaners.interface';
 

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

@@ -1,4 +1,4 @@
-import { IDLDataType, IParameterOrPropertyDetails } from '@idl/data-types/core';
+import { IDLDataType, IParameterOrPropertyDetails } from '@idl/types/core';
 
 /**
  * Simplified information being overridden for procedures

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

@@ -5,7 +5,7 @@ import {
   IDL_STRING_TYPE,
   IDL_STRUCTURE_TYPE,
   ParseIDLType,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { IFunctionMethodOverride } from '../detail.interface';
 import { ENVI_ERROR_KEYWORD } from '../shared/envi-error.interface';

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

@@ -8,7 +8,7 @@ import {
   IDL_STRING_TYPE,
   IDL_TYPE_CODE_TYPE,
   ParseIDLType,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { IFunctionOverride } from '../detail.interface';
 import { TYPE_FUNCTION_ARGS } from '../shared/dimension-args.interface';

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

@@ -3,7 +3,7 @@ import {
   IDL_BOOLEAN_TYPE,
   IDL_NUMBER_TYPE,
   ParseIDLType,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { IProcedureMethodOverride } from '../detail.interface';
 

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

@@ -4,7 +4,7 @@ import {
   IDL_NUMBER_TYPE,
   IDL_STRING_TYPE,
   ParseIDLType,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { IProcedureOverride } from '../detail.interface';
 

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

@@ -6,7 +6,7 @@ import {
   IDL_NUMBER_TYPE,
   IDL_STRING_TYPE,
   ParseIDLType,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 import { IStructureOverride } from '../detail.interface';
 import { RECORD_TYPE } from '../shared/entities.interface';

apps/idl-docs-parser/src/overrides/globals-for-types.ts

@@ -4,7 +4,7 @@ import {
   GlobalTokens,
   IDL_TYPE_LOOKUP,
   IGlobalIndexedToken,
-} from '@idl/data-types/core';
+} from '@idl/types/core';
 
 /**
  * Structure definitions for types

apps/idl-docs-parser/src/overrides/properties-and-keywords/has-extra-keywords.ts

@@ -1,7 +1,4 @@
-import {
-  GLOBAL_TOKEN_TYPES,
-  GlobalRoutineTokenType,
-} from '@idl/data-types/core';
+import { GLOBAL_TOKEN_TYPES, GlobalRoutineTokenType } from '@idl/types/core';
 
 /**
  * If we can handle any keyword, add a new one for '_ref_extra to the

apps/idl-docs-parser/src/overrides/properties-and-keywords/properties-are-keywords.ts

@@ -1,4 +1,4 @@
-import { GLOBAL_TOKEN_TYPES } from '@idl/data-types/core';
+import { GLOBAL_TOKEN_TYPES } from '@idl/types/core';
 
 import { UpdateThese } from '../../helpers/set-keywords-as-properties.interface';
 

apps/idl-docs-parser/src/overrides/shared/dimension-args.interface.ts

@@ -1,4 +1,4 @@
-import { IDL_ANY_TYPE, IDL_NUMBER_TYPE } from '@idl/data-types/core';
+import { IDL_ANY_TYPE, IDL_NUMBER_TYPE } from '@idl/types/core';
 
 import { ISharedArgsOrKeywords } from './shared.interface';
 

apps/idl-docs-parser/src/overrides/shared/entities.interface.ts

@@ -1,4 +1,4 @@
-import { ParseIDLType } from '@idl/data-types/core';
+import { ParseIDLType } from '@idl/types/core';
 
 const ENTITIES: string[] = [
   'MultiPoint',

apps/idl-docs-parser/src/overrides/shared/envi-error.interface.ts

@@ -1,7 +1,4 @@
-import {
-  IDL_STRING_TYPE,
-  IParameterOrPropertyDetails,
-} from '@idl/data-types/core';
+import { IDL_STRING_TYPE, IParameterOrPropertyDetails } from '@idl/types/core';
 
 /**
  * Keywords for the thread pool

apps/idl-docs-parser/src/overrides/shared/http-request.interface.ts

@@ -1,4 +1,4 @@
-import { ParseIDLType } from '@idl/data-types/core';
+import { ParseIDLType } from '@idl/types/core';
 
 import { OverrideParamOrProp } from './shared.interface';
 

apps/idl-docs-parser/src/overrides/shared/interleave.interface.ts

@@ -1,7 +1,4 @@
-import {
-  IParameterOrPropertyDetails,
-  ParseIDLType,
-} from '@idl/data-types/core';
+import { IParameterOrPropertyDetails, ParseIDLType } from '@idl/types/core';
 
 /**
  * The type for interleave

apps/idl-docs-parser/src/overrides/shared/shared-types.interface.ts

@@ -1,4 +1,4 @@
-import { ParseIDLType } from '@idl/data-types/core';
+import { ParseIDLType } from '@idl/types/core';
 
 import { OverrideParamOrProp } from './shared.interface';
 

apps/idl-docs-parser/src/overrides/shared/shared.interface.ts

@@ -1,4 +1,4 @@
-import { IParameterOrPropertyDetails } from '@idl/data-types/core';
+import { IParameterOrPropertyDetails } from '@idl/types/core';
 
 export interface ISharedArgsOrKeywords {
   [key: string]: Partial<IParameterOrPropertyDetails>;

apps/idl-docs-parser/src/overrides/shared/spatialref.interface.ts

@@ -1,4 +1,4 @@
-import { ParseIDLType } from '@idl/data-types/core';
+import { ParseIDLType } from '@idl/types/core';
 
 /**
  * Data type for spatial references

apps/idl-docs-parser/src/overrides/shared/thread-pool.interface.ts

@@ -1,4 +1,4 @@
-import { IDL_BOOLEAN_TYPE, IDL_NUMBER_TYPE } from '@idl/data-types/core';
+import { IDL_BOOLEAN_TYPE, IDL_NUMBER_TYPE } from '@idl/types/core';
 
 import { ISharedArgsOrKeywords } from './shared.interface';
 

apps/idl-docs-parser/src/overrides/shared/uri.interface.ts

@@ -1,7 +1,4 @@
-import {
-  IDL_STRING_TYPE,
-  IParameterOrPropertyDetails,
-} from '@idl/data-types/core';
+import { IDL_STRING_TYPE, IParameterOrPropertyDetails } from '@idl/types/core';
 
 /**
  * URI parameters

apps/idl-docs-parser/src/overrides/types/types.interface.ts

@@ -1,4 +1,4 @@
-import { ParameterDirection } from '@idl/data-types/core';
+import { ParameterDirection } from '@idl/types/core';
 
 /**
  * Simplified information being overridden for procedures

apps/idl-docs-parser/src/type-guess/type-guess.interface.ts

@@ -1,4 +1,4 @@
-import { IDL_TYPE_LOOKUP } from '@idl/data-types/core';
+import { IDL_TYPE_LOOKUP } from '@idl/types/core';
 
 /**
  * By IDL data type, track regular expressions we can use to auto-populate the

apps/idl-docs-parser/src/type-guess/type-guess.ts

@@ -1,4 +1,4 @@
-import { DEFAULT_DATA_TYPE } from '@idl/data-types/core';
+import { DEFAULT_DATA_TYPE } from '@idl/types/core';
 
 import { TYPE_GUESS } from './type-guess.interface';