add PerseusError to perseus-core (#1411)

* add PerseusError to perseus-core * remove code * changeset * remove more references to perseus-error * fix type export
Khan · Jul 15, 2024 · b0df85a · b0df85a
1 parent 24a7217
commit b0df85a
Show file tree

Hide file tree

Showing 52 changed files with 66 additions and 349 deletions.
diff --git a/.changeset/rare-baboons-change.md b/.changeset/rare-baboons-change.md
@@ -0,0 +1,8 @@
+---
+"@khanacademy/perseus": major
+"@khanacademy/perseus-editor": major
+"@khanacademy/perseus-core": minor
+"@khanacademy/perseus-linter": patch
+---
+
+Consolidate PerseusError code and move it into perseus-core (deletes the perseus-error package)
diff --git a/packages/perseus-error/src/index.ts → packages/perseus-core/src/error/errors.ts b/packages/perseus-error/src/index.ts → packages/perseus-core/src/error/errors.ts
@@ -1,7 +1,3 @@
-import type {Metadata} from "@khanacademy/wonder-stuff-core";
-
-export {libVersion} from "./version";
-
 /**
  * @typedef {Object} Errors utility for referencing the Perseus error taxonomy.
  */
@@ -44,21 +40,3 @@ export const Errors = Object.freeze({
  * @type {ErrorKind} The kind of error being reported
  */
 export type ErrorKind = (typeof Errors)[keyof typeof Errors];
-
-/**
- * Optional extra information passed to the `PerseusError` constructor.
- */
-type Options = {
-    metadata?: Metadata | null | undefined;
-};
-
-export class PerseusError extends Error {
-    kind: ErrorKind;
-    metadata: Metadata | null | undefined;
-
-    constructor(message: string, kind: ErrorKind, options?: Options) {
-        super(message);
-        this.kind = kind;
-        this.metadata = options?.metadata;
-    }
-}
diff --git a/packages/perseus/src/perseus-error.ts → ...s/perseus-core/src/error/perseus-error.ts b/packages/perseus/src/perseus-error.ts → ...s/perseus-core/src/error/perseus-error.ts
@@ -1,4 +1,4 @@
-import type {ErrorKind} from "./logging/log";
+import type {ErrorKind} from "./errors";
 import type {Metadata} from "@khanacademy/wonder-stuff-core";
 
 type Options = {

diff --git a/packages/perseus-core/src/index.ts b/packages/perseus-core/src/index.ts
@@ -4,8 +4,12 @@ export type {
     KeypadContextRendererInterface,
     RendererInterface,
 } from "./types";
+export type {ErrorKind} from "./error/errors";
 
 // Careful, `version.ts` uses this function so it _must_ be imported above it
 export {addLibraryVersionToPerseusDebug} from "./utils/add-library-version-to-perseus-debug";
 
 export {libVersion} from "./version";
+
+export {Errors} from "./error/errors";
+export {PerseusError} from "./error/perseus-error";
diff --git a/packages/perseus-editor/src/article-editor.tsx b/packages/perseus-editor/src/article-editor.tsx
@@ -4,13 +4,8 @@
  * multiple (Renderer) sections concatenated together.
  */
 
-import {
-    components,
-    icons,
-    ApiOptions,
-    Errors,
-    PerseusError,
-} from "@khanacademy/perseus";
+import {components, icons, ApiOptions} from "@khanacademy/perseus";
+import {Errors, PerseusError} from "@khanacademy/perseus-core";
 import * as React from "react";
 import _ from "underscore";
 

diff --git a/packages/perseus-editor/src/editor.tsx b/packages/perseus-editor/src/editor.tsx
@@ -1,13 +1,12 @@
 /* eslint-disable @khanacademy/ts-no-error-suppressions */
 import {
     preprocessTex,
-    Errors,
     Log,
-    PerseusError,
     PerseusMarkdown,
     Util,
     Widgets,
 } from "@khanacademy/perseus";
+import {Errors, PerseusError} from "@khanacademy/perseus-core";
 import $ from "jquery";
 // eslint-disable-next-line import/no-unresolved, import/no-extraneous-dependencies
 import katex from "katex";

diff --git a/packages/perseus-editor/src/widgets/cs-program-editor.tsx b/packages/perseus-editor/src/widgets/cs-program-editor.tsx
@@ -8,9 +8,9 @@ import {
     Changeable,
     Dependencies,
     EditorJsonify,
-    Errors,
     Log,
 } from "@khanacademy/perseus";
+import {Errors} from "@khanacademy/perseus-core";
 import $ from "jquery";
 import PropTypes from "prop-types";
 import * as React from "react";

diff --git a/packages/perseus-error/.eslintrc.js b/packages/perseus-error/.eslintrc.js
diff --git a/packages/perseus-error/CHANGELOG.md b/packages/perseus-error/CHANGELOG.md
diff --git a/packages/perseus-error/README.md b/packages/perseus-error/README.md
diff --git a/packages/perseus-error/package.json b/packages/perseus-error/package.json
diff --git a/packages/perseus-error/src/version.ts b/packages/perseus-error/src/version.ts
diff --git a/packages/perseus-error/tsconfig-build.json b/packages/perseus-error/tsconfig-build.json
diff --git a/packages/perseus-error/types b/packages/perseus-error/types
diff --git a/packages/perseus-linter/package.json b/packages/perseus-linter/package.json
@@ -25,8 +25,7 @@
         "test": "bash -c 'yarn --silent --cwd \"../..\" test ${@:0} $($([[ ${@: -1} = -* ]] || [[ ${@: -1} = bash ]]) && echo $PWD)'"
     },
     "dependencies": {
-        "@khanacademy/perseus-core": "1.4.2",
-        "@khanacademy/perseus-error": "^0.3.0"
+        "@khanacademy/perseus-core": "1.4.2"
     },
     "devDependencies": {
         "@khanacademy/pure-markdown": "^0.3.5",

diff --git a/packages/perseus-linter/src/rule.ts b/packages/perseus-linter/src/rule.ts
@@ -121,7 +121,7 @@
  * the Perseus article or exercise that is being linted.
  */
 
-import {Errors, PerseusError} from "@khanacademy/perseus-error";
+import {Errors, PerseusError} from "@khanacademy/perseus-core";
 
 import Selector from "./selector";
 

diff --git a/packages/perseus-linter/src/selector.ts b/packages/perseus-linter/src/selector.ts
@@ -86,7 +86,7 @@
  * traversal.
  */
 
-import {Errors, PerseusError} from "@khanacademy/perseus-error";
+import {Errors, PerseusError} from "@khanacademy/perseus-core";
 
 import type {TreeNode, TraversalState} from "./tree-transformer";
 

diff --git a/packages/perseus-linter/src/tree-transformer.ts b/packages/perseus-linter/src/tree-transformer.ts
@@ -56,7 +56,7 @@
  * methods are available to the traversal callback.
  **/
 
-import {Errors, PerseusError} from "@khanacademy/perseus-error";
+import {Errors, PerseusError} from "@khanacademy/perseus-core";
 
 // TreeNode is the type of a node in a parse tree. The only real requirement is
 // that every node has a string-valued `type` property

diff --git a/packages/perseus-linter/tsconfig-build.json b/packages/perseus-linter/tsconfig-build.json
@@ -6,7 +6,6 @@
     },
     "references": [
         {"path": "../perseus-core/tsconfig-build.json"},
-        {"path": "../perseus-error/tsconfig-build.json"},
         {"path": "../pure-markdown/tsconfig-build.json"},
     ]
 }
diff --git a/packages/perseus/src/__tests__/renderer.test.tsx b/packages/perseus/src/__tests__/renderer.test.tsx
@@ -1,4 +1,5 @@
 import {describe, beforeAll, beforeEach, it} from "@jest/globals";
+import {Errors} from "@khanacademy/perseus-core";
 import {screen, waitFor, within} from "@testing-library/react";
 import {userEvent as userEventLib} from "@testing-library/user-event";
 import * as React from "react";
@@ -16,7 +17,6 @@ import {
     mockedShuffledRadioProps,
 } from "../__testdata__/renderer.testdata";
 import * as Dependencies from "../dependencies";
-import {Errors} from "../logging/log";
 import {registerWidget} from "../widgets";
 import {renderQuestion} from "../widgets/__tests__/renderQuestion";
 import InputNumberExport from "../widgets/input-number";

diff --git a/packages/perseus/src/components/graphie-classes.ts b/packages/perseus/src/components/graphie-classes.ts
@@ -1,8 +1,8 @@
 /* eslint-disable @babel/no-invalid-this */
+
+import {Errors, PerseusError} from "@khanacademy/perseus-core";
 import _ from "underscore";
 
-import {Errors} from "../logging/log";
-import {PerseusError} from "../perseus-error";
 import Util from "../util";
 
 const nestedMap = Util.nestedMap;

diff --git a/packages/perseus/src/components/graphie.tsx b/packages/perseus/src/components/graphie.tsx
@@ -1,10 +1,11 @@
+import {Errors} from "@khanacademy/perseus-core";
 import $ from "jquery";
 import * as React from "react";
 import ReactDOM from "react-dom";
 import _ from "underscore";
 
 import InteractiveUtil from "../interactive2/interactive-util";
-import {Errors, Log} from "../logging/log";
+import {Log} from "../logging/log";
 import Util from "../util";
 import GraphUtils from "../util/graph-utils";
 import {Graphie as GraphieDrawingContext} from "../util/graphie";