Add context property to error result

Author: leeyi45

eslint.config.mjs

@@ -23,6 +23,7 @@ export default tseslint.config(
       import: importPlugin
     },
     rules: {
+      'import/first': 'warn',
       'import/no-duplicates': ['warn', { 'prefer-inline': true }],
       'import/order': 'warn',
 

package.json

@@ -30,15 +30,15 @@
   "bin": "dist/repl/index.js",
   "dependencies": {
     "@babel/parser": "^7.19.4",
-    "@commander-js/extra-typings": "^12.0.1",
+    "@commander-js/extra-typings": "^14.0.0",
     "@joeychenofficial/alt-ergo-modified": "^2.4.0",
     "@ts-morph/bootstrap": "^0.18.0",
     "acorn": "^8.8.2",
     "acorn-class-fields": "^1.0.0",
     "acorn-loose": "^8.0.0",
     "acorn-walk": "^8.0.0",
     "astring": "^1.4.3",
-    "commander": "^12.0.0",
+    "commander": "^14.0.0",
     "js-base64": "^3.7.5",
     "lodash": "^4.17.21",
     "source-map": "0.7.6"

src/cse-machine/__tests__/cse-machine-unique-id.test.ts

@@ -89,24 +89,28 @@ const getProgramEnv = (context: Context) => {
   return env
 }
 
-test('Program environment id stays the same regardless of amount of steps', { timeout: 10_000 }, async () => {
-  const code = stripIndent`
+test(
+  'Program environment id stays the same regardless of amount of steps',
+  { timeout: 10_000 },
+  async () => {
+    const code = stripIndent`
         let x = 0;
         for (let i = 0; i < 10; i = i + 1) {
           x = [x];
         }
       `
 
-  let programEnvId = '47'
-  // The above program has a total of 335 steps
-  // Start from steps = 1 so that the program environment always exists
-  for (let steps = 1; steps < 336; steps++) {
-    const context = await getContextFrom(code, steps)
-    const programEnv = getProgramEnv(context)!
-    if (programEnv.id !== programEnvId) {
-      programEnvId = programEnv.id
-      break
+    let programEnvId = '47'
+    // The above program has a total of 335 steps
+    // Start from steps = 1 so that the program environment always exists
+    for (let steps = 1; steps < 336; steps++) {
+      const context = await getContextFrom(code, steps)
+      const programEnv = getProgramEnv(context)!
+      if (programEnv.id !== programEnvId) {
+        programEnvId = programEnv.id
+        break
+      }
     }
+    expect(programEnvId).toMatchInlineSnapshot(`"47"`)
   }
-  expect(programEnvId).toMatchInlineSnapshot(`"47"`)
-})
+)

src/cse-machine/interpreter.ts

@@ -1251,5 +1251,5 @@ const cmdEvaluators: CommandEvaluators = {
       control.push(command.body)
       control.push(instr.popInstr(command.srcNode)) // Pop previous body value
     }
-  },
+  }
 }

src/index.ts

@@ -20,16 +20,16 @@ import type {
 import { Chapter, type Variant } from './langs'
 import { assemble } from './vm/svml-assembler'
 import { compileToIns } from './vm/svml-compiler'
-export { SourceDocumentation } from './editors/ace/docTooltip'
 
 import { CSEResultPromise, resumeEvaluate } from './cse-machine/interpreter'
 import { ModuleNotFoundError } from './modules/errors'
 import type { ImportOptions } from './modules/moduleTypes'
 import preprocessFileImports from './modules/preprocessor'
 import { validateFilePath } from './modules/preprocessor/filePaths'
 import { getKeywords, getProgramNames, type NameDeclaration } from './name-extractor'
-import { htmlRunner, resolvedErrorPromise, sourceFilesRunner } from './runner'
+import { htmlRunner, sourceFilesRunner } from './runner'
 import { SourceError } from './errors/base'
+export { SourceDocumentation } from './editors/ace/docTooltip'
 
 export interface IOptions {
   steps: number
@@ -219,7 +219,7 @@ export async function runFilesInContext(
     const filePathError = validateFilePath(filePath)
     if (filePathError !== null) {
       context.errors.push(filePathError)
-      return resolvedErrorPromise
+      return { status: 'error', context }
     }
   }
 
@@ -228,7 +228,7 @@ export async function runFilesInContext(
     const code = files[entrypointFilePath]
     if (code === undefined) {
       context.errors.push(new ModuleNotFoundError(entrypointFilePath))
-      return resolvedErrorPromise
+      return { status: 'error', context }
     }
     result = await htmlRunner(code, context, options)
   } else {

src/modules/loader/__tests__/loader.test.ts

@@ -58,7 +58,7 @@ describe('bundle loading', () => {
 describe('tab loading', () => {
   test("Load a module's tabs", async () => {
     mockedDocsImporter.mockResolvedValueOnce({
-      default: { 
+      default: {
         one_module: { tabs: ['tab1', 'tab2'] }
       }
     })

src/name-extractor/index.ts

@@ -2,7 +2,6 @@ import acorn from 'acorn'
 import type es from 'estree'
 
 import { partition } from 'lodash'
-import type { Context } from '../'
 import { UNKNOWN_LOCATION } from '../constants'
 import { findAncestors, findIdentifierNode } from '../finder'
 import { memoizedGetModuleDocsAsync, memoizedGetModuleManifestAsync } from '../modules/loader'
@@ -11,6 +10,7 @@ import { isSourceModule } from '../modules/utils'
 import syntaxBlacklist from '../parser/source/syntax'
 import { getImportedName, getModuleDeclarationSource } from '../utils/ast/helpers'
 import { isDeclaration, isImportDeclaration, isNamespaceSpecifier } from '../utils/ast/typeGuards'
+import type { Context, Node } from '../types'
 
 export enum DeclarationKind {
   KIND_IMPORT = 'import',
@@ -20,7 +20,6 @@ export enum DeclarationKind {
   KIND_CONST = 'const',
   KIND_KEYWORD = 'keyword'
 }
-import { Node } from '../types'
 
 export interface NameDeclaration {
   name: string
@@ -422,7 +421,7 @@ async function getNames(node: Node, locTest: (node: Node) => boolean): Promise<N
             }
           })
         )
-      } catch (err) {
+      } catch {
         // Failed to load docs for whatever reason
         return specs.map(spec => ({
           name: spec.local.name,

src/repl/__tests__/main.test.ts

@@ -1,5 +1,5 @@
 import { describe, test, expect, vi } from 'vitest'
-import type { Command } from 'commander'
+import type { Command } from '@commander-js/extra-typings'
 import { getMainCommand } from '../main'
 
 vi.spyOn(process, 'exit').mockImplementation(code => {

src/runner/fullJSRunner.ts

@@ -15,7 +15,6 @@ import type { Context, NativeStorage } from '../types'
 import * as create from '../utils/ast/astCreator'
 import { getFunctionDeclarationNamesInProgram } from '../utils/uniqueIds'
 import { toSourceError } from './errors'
-import { resolvedErrorPromise } from './utils'
 import type { Runner } from './types'
 
 function fullJSEval(code: string, nativeStorage: NativeStorage): any {
@@ -49,7 +48,7 @@ const fullJSRunner: Runner = async (program, context) => {
   // only process builtins and preludes if it is a fresh eval context
   const prelude = preparePrelude(context)
   if (prelude === undefined) {
-    return resolvedErrorPromise
+    return { status: 'error', context }
   }
   const preludeAndBuiltins: es.Statement[] = containsPrevEval(context)
     ? []
@@ -82,7 +81,7 @@ const fullJSRunner: Runner = async (program, context) => {
     context.errors.push(
       error instanceof RuntimeSourceError ? error : await toSourceError(error, sourceMapJson)
     )
-    return resolvedErrorPromise
+    return { status: 'error', context }
   }
 }
 

src/runner/index.ts

@@ -11,7 +11,7 @@ import { parse } from '../parser/parser'
 import assert from '../utils/assert'
 import { defaultAnalysisOptions } from '../modules/preprocessor/analyzer'
 import { defaultLinkerOptions } from '../modules/preprocessor/linker'
-import { determineExecutionMethod, determineVariant, resolvedErrorPromise } from './utils'
+import { determineExecutionMethod, determineVariant } from './utils'
 import runners from './sourceRunner'
 
 let previousCode: {
@@ -58,7 +58,10 @@ async function sourceRunner(
 
   validateAndAnnotate(program, context)
   if (context.errors.length > 0) {
-    return resolvedErrorPromise
+    return {
+      status: 'error',
+      context
+    }
   }
 
   if (theOptions.useSubst) {
@@ -77,7 +80,7 @@ async function sourceRunner(
     context.unTypecheckedCode.push(context.prelude)
 
     const prelude = parse(context.prelude, context)
-    if (prelude === null) return resolvedErrorPromise
+    if (prelude === null) return { status: 'error', context }
 
     await sourceRunner(prelude, context, isVerboseErrorsEnabled, { ...options, isPrelude: true })
   }
@@ -122,7 +125,7 @@ export async function sourceFilesRunner(
 
   if (!preprocessResult.ok) {
     return {
-      result: { status: 'error' },
+      result: { status: 'error', context },
       verboseErrors: preprocessResult.verboseErrors
     }
   }
@@ -181,4 +184,3 @@ export function runCodeInSource(
 }
 
 export { htmlRunner } from './htmlRunner'
-export { resolvedErrorPromise }