cleanup after moving utilities (#107)

- delete the files copied to the utilities package - update usage to new location - update README graph - fix typecheck on CI - move common tsconfig settings up to root
BiblioNexus-Foundation · Jun 20, 2024 · bd34483 · bd34483
1 parent e969230
commit bd34483
Show file tree

Hide file tree

Showing 49 changed files with 204 additions and 2,413 deletions.
diff --git a/README.md b/README.md
@@ -40,6 +40,16 @@ NOTE: there is a [known limitation using PNPM with Volta](https://docs.volta.sh/
 
 ## Nx Monorepo Build System
 
+| Source                                 | Package                                                                 |
+| -------------------------------------- | ----------------------------------------------------------------------- |
+| [perf-vanilla](/packages/perf-react)   |                                                                         |
+| [perf-react](/packages/perf-react)     |                                                                         |
+| [platform](/packages/platform)         | [![Github Tag][npm-platform-version-image]][npm-platform-version-url]   |
+| [scribe](/packages/scribe)             | [![Github Tag][npm-scribe-version-image]][npm-scribe-version-url]       |
+| [shared-react](/packages/shared-react) |                                                                         |
+| [shared](/packages/shared)             |                                                                         |
+| [utilities](/packages/utilities)       | [![Github Tag][npm-utilities-version-image]][npm-utilities-version-url] |
+
 ```mermaid
 ---
 title: Nx Graph
@@ -50,8 +60,12 @@ graph TB
   P(platform) --> SR
   SB(scribe) --> SR
   SR(shared-react) --> S
+  R --> SR
   P --> S
   SB --> S
+  S --> U(utilities)
+  P --> U
+  SB --> U
 ```
 
 <a alt="Nx logo" href="https://nx.dev" target="_blank" rel="noreferrer"><img src="https://raw.githubusercontent.com/nrwl/nx/master/images/nx-logo.png" width="45"></a>
@@ -168,4 +182,10 @@ Thanks to [CodeSandbox](https://codesandbox.io/) for the instant dev environment
 
 <!-- define variables used above -->
 
+[npm-platform-version-image]: https://img.shields.io/npm/v/@biblionexus-foundation/platform-editor
+[npm-platform-version-url]: https://www.npmjs.com/package/@biblionexus-foundation/platform-editor
+[npm-scribe-version-image]: https://img.shields.io/npm/v/@biblionexus-foundation/scribe-editor
+[npm-scribe-version-url]: https://www.npmjs.com/package/@biblionexus-foundation/scribe-editor
+[npm-utilities-version-image]: https://img.shields.io/npm/v/@biblionexus-foundation/scripture-utilities
+[npm-utilities-version-url]: https://www.npmjs.com/package/@biblionexus-foundation/scripture-utilities
 [github-license]: https://github.com/BiblioNexus-Foundation/scripture-editors/blob/main/LICENSE
diff --git a/lint-staged.config.js b/lint-staged.config.js
@@ -2,7 +2,6 @@ module.exports = {
   "**/*.{ts,tsx}": (files) => `nx affected --target=typecheck --files=${files.join(",")}`,
   "**/*.{js,ts,jsx,tsx,json,html,yml,yaml,md,cjs,mjs}": [
     (files) => `prettier --write ${files.join(" ")}`,
-    (files) => `nx format:write --files=${files.join(",")}`,
-    (files) => `nx affected:lint --files=${files.join(",")}`,
+    (files) => `nx affected:lint --files=${files}`,
   ],
 };
diff --git a/packages/perf-react/tsconfig.json b/packages/perf-react/tsconfig.json
@@ -1,28 +1,7 @@
 {
+  "extends": "../../tsconfig",
   "compilerOptions": {
-    "target": "ESNext",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "skipLibCheck": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "jsx": "react-jsx",
-
-    /* Bundler mode */
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "declaration": true,
-
-    /* Linting */
-    "strict": true,
-    "allowJs": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
+    "jsx": "react-jsx"
   },
   "include": ["src"],
   "references": [

diff --git a/packages/perf-vanilla/tsconfig.json b/packages/perf-vanilla/tsconfig.json
@@ -1,23 +1,4 @@
 {
-  "compilerOptions": {
-    "target": "ES2020",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": ["ES2020", "DOM", "DOM.Iterable"],
-    "skipLibCheck": true,
-
-    /* Bundler mode */
-    "moduleResolution": "bundler",
-    "allowImportingTsExtensions": true,
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-
-    /* Linting */
-    "strict": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
-  },
+  "extends": "../../tsconfig",
   "include": ["src"]
 }
diff --git a/packages/platform/package.json b/packages/platform/package.json
@@ -29,6 +29,7 @@
     "react-dom": ">=18.3.1"
   },
   "dependencies": {
+    "@biblionexus-foundation/scripture-utilities": "workspace:*",
     "@lexical/react": "^0.16.0",
     "@lexical/selection": "^0.16.0",
     "@lexical/text": "^0.16.0",

diff --git a/packages/platform/src/App.tsx b/packages/platform/src/App.tsx
@@ -1,7 +1,6 @@
+import { Usj, usxStringToUsj } from "@biblionexus-foundation/scripture-utilities";
 import { BookChapterControl, ScriptureReference } from "platform-bible-react";
 import { useCallback, useEffect, useMemo, useRef, useState } from "react";
-import { usxStringToUsj } from "shared/converters/usj/usx-to-usj";
-import { Usj } from "shared/converters/usj/usj.model";
 import { WEB_PSA_USX as usx } from "shared/data/WEB-PSA.usx";
 // import { PSA_USX as usx } from "shared/data/psa.usfm.usx";
 import { WEB_PSA_COMMENTS as comments } from "shared/data/WEB_PSA.comments";

diff --git a/packages/platform/src/editor/Editor.tsx b/packages/platform/src/editor/Editor.tsx
@@ -1,3 +1,4 @@
+import { Usj } from "@biblionexus-foundation/scripture-utilities";
 import { EditorRefPlugin } from "@lexical/react/LexicalEditorRefPlugin";
 import LexicalErrorBoundary from "@lexical/react/LexicalErrorBoundary";
 import { InitialConfigType, LexicalComposer } from "@lexical/react/LexicalComposer";
@@ -17,7 +18,6 @@ import React, {
   useState,
 } from "react";
 import { ScriptureReference } from "platform-bible-react";
-import { Usj } from "shared/converters/usj/usj.model";
 import { TypedMarkNode } from "shared/nodes/features/TypedMarkNode";
 import scriptureUsjNodes from "shared/nodes/scripture/usj";
 import AnnotationPlugin, {

diff --git a/packages/platform/src/editor/adaptors/editor-usj-adaptor.test.ts b/packages/platform/src/editor/adaptors/editor-usj-adaptor.test.ts
@@ -1,4 +1,15 @@
+import { MarkerObject } from "@biblionexus-foundation/scripture-utilities";
 import { deepEqual } from "fast-equals";
+import { TypedMarkNode } from "shared/nodes/features/TypedMarkNode";
+import scriptureUsjNodes from "shared/nodes/scripture/usj";
+import { CHAPTER_MARKER, SerializedChapterNode } from "shared/nodes/scripture/usj/ChapterNode";
+import { SerializedParaNode } from "shared/nodes/scripture/usj/ParaNode";
+import { getVisibleOpenMarkerText } from "shared/nodes/scripture/usj/node.utils";
+import { SerializedVerseNode, VERSE_MARKER } from "shared/nodes/scripture/usj/VerseNode";
+import { createBasicTestEnvironment } from "shared/nodes/test.utils";
+import { ImmutableNoteCallerNode } from "shared-react/nodes/scripture/usj/ImmutableNoteCallerNode";
+// Reaching inside only for tests.
+// eslint-disable-next-line @nx/enforce-module-boundaries
 import {
   CHAPTER_1_INDEX,
   VERSE_2_EDITABLE_INDEX,
@@ -15,16 +26,7 @@ import {
   usjGen1v1ImpliedPara,
   usjMarks,
   usjWithUnknownItems,
-} from "shared/converters/usj/converter-test.data";
-import { MarkerObject } from "shared/converters/usj/usj.model";
-import { TypedMarkNode } from "shared/nodes/features/TypedMarkNode";
-import scriptureUsjNodes from "shared/nodes/scripture/usj";
-import { CHAPTER_MARKER, SerializedChapterNode } from "shared/nodes/scripture/usj/ChapterNode";
-import { SerializedParaNode } from "shared/nodes/scripture/usj/ParaNode";
-import { getVisibleOpenMarkerText } from "shared/nodes/scripture/usj/node.utils";
-import { SerializedVerseNode, VERSE_MARKER } from "shared/nodes/scripture/usj/VerseNode";
-import { createBasicTestEnvironment } from "shared/nodes/test.utils";
-import { ImmutableNoteCallerNode } from "shared-react/nodes/scripture/usj/ImmutableNoteCallerNode";
+} from "../../../../utilities/src/converters/usj/converter-test.data";
 import editorUsjAdaptor from "./editor-usj.adaptor";
 import usjEditorAdaptor from "./usj-editor.adaptor";
 

diff --git a/packages/platform/src/editor/adaptors/editor-usj.adaptor.ts b/packages/platform/src/editor/adaptors/editor-usj.adaptor.ts
@@ -1,17 +1,17 @@
+import {
+  MarkerContent,
+  MarkerObject,
+  USJ_TYPE,
+  USJ_VERSION,
+  Usj,
+} from "@biblionexus-foundation/scripture-utilities";
 import {
   EditorState,
   LineBreakNode,
   SerializedLexicalNode,
   SerializedTextNode,
   TextNode,
 } from "lexical";
-import {
-  MarkerContent,
-  MarkerObject,
-  USJ_TYPE,
-  USJ_VERSION,
-  Usj,
-} from "shared/converters/usj/usj.model";
 import {
   COMMENT_MARK_TYPE,
   SerializedTypedMarkNode,

diff --git a/packages/platform/src/editor/adaptors/usj-editor-adaptor.test.ts b/packages/platform/src/editor/adaptors/usj-editor-adaptor.test.ts
@@ -1,4 +1,11 @@
+import { MarkerObject } from "@biblionexus-foundation/scripture-utilities";
 import { SerializedEditorState } from "lexical";
+import { SerializedParaNode } from "shared/nodes/scripture/usj/ParaNode";
+import { SerializedNoteNode } from "shared/nodes/scripture/usj/NoteNode";
+import { SerializedImmutableNoteCallerNode } from "shared-react/nodes/scripture/usj/ImmutableNoteCallerNode";
+import { MarkNodeName } from "shared-react/nodes/scripture/usj/usj-node-options.model";
+// Reaching inside only for tests.
+// eslint-disable-next-line @nx/enforce-module-boundaries
 import {
   NOTE_CALLER_INDEX,
   NOTE_INDEX,
@@ -15,12 +22,7 @@ import {
   usjGen1v1ImpliedPara,
   usjMarks,
   usjWithUnknownItems,
-} from "shared/converters/usj/converter-test.data";
-import { MarkerObject } from "shared/converters/usj/usj.model";
-import { SerializedParaNode } from "shared/nodes/scripture/usj/ParaNode";
-import { SerializedNoteNode } from "shared/nodes/scripture/usj/NoteNode";
-import { SerializedImmutableNoteCallerNode } from "shared-react/nodes/scripture/usj/ImmutableNoteCallerNode";
-import { MarkNodeName } from "shared-react/nodes/scripture/usj/usj-node-options.model";
+} from "../../../../utilities/src/converters/usj/converter-test.data";
 import { UNFORMATTED_VIEW_MODE } from "../toolbar/view-mode.model";
 import { serializeEditorState, reset, initialize } from "./usj-editor.adaptor";
 import { getViewOptions } from "./view-options.utils";

diff --git a/packages/platform/src/editor/adaptors/usj-editor.adaptor.ts b/packages/platform/src/editor/adaptors/usj-editor.adaptor.ts
@@ -1,3 +1,11 @@
+import {
+  BookCode,
+  MarkerContent,
+  MarkerObject,
+  USJ_TYPE,
+  USJ_VERSION,
+  Usj,
+} from "@biblionexus-foundation/scripture-utilities";
 import {
   LineBreakNode,
   SerializedEditorState,
@@ -6,14 +14,6 @@ import {
   SerializedTextNode,
   TextNode,
 } from "lexical";
-import {
-  BookCode,
-  MarkerContent,
-  MarkerObject,
-  USJ_TYPE,
-  USJ_VERSION,
-  Usj,
-} from "shared/converters/usj/usj.model";
 import {
   COMMENT_MARK_TYPE,
   SerializedTypedMarkNode,

diff --git a/packages/platform/src/index.ts b/packages/platform/src/index.ts
@@ -1,8 +1,5 @@
 export { default as Editorial } from "./Editorial";
 export { default as Marginal, type MarginalRef } from "./marginal/Marginal";
-export { type Usj } from "shared/converters/usj/usj.model";
-export { usxStringToUsj } from "shared/converters/usj/usx-to-usj";
-export { usjToUsxString } from "shared/converters/usj/usj-to-usx";
 export { immutableNoteCallerNodeName } from "shared-react/nodes/scripture/usj/ImmutableNoteCallerNode";
 export { type UsjNodeOptions } from "shared-react/nodes/scripture/usj/usj-node-options.model";
 export {

diff --git a/packages/platform/src/marginal/Marginal.tsx b/packages/platform/src/marginal/Marginal.tsx
@@ -1,3 +1,4 @@
+import { Usj } from "@biblionexus-foundation/scripture-utilities";
 import React, {
   JSX,
   PropsWithChildren,
@@ -8,7 +9,6 @@ import React, {
   useRef,
   useState,
 } from "react";
-import { Usj } from "shared/converters/usj/usj.model";
 import { LoggerBasic } from "shared-react/plugins/logger-basic.model";
 import { Comments } from "./comments/commenting";
 import CommentPlugin from "./comments/CommentPlugin";

diff --git a/packages/platform/tsconfig.json b/packages/platform/tsconfig.json
@@ -1,28 +1,7 @@
 {
+  "extends": "../../tsconfig",
   "compilerOptions": {
-    "target": "ESNext",
-    "useDefineForClassFields": true,
-    "module": "ESNext",
-    "lib": ["DOM", "DOM.Iterable", "ESNext"],
-    "skipLibCheck": true,
-    "esModuleInterop": false,
-    "allowSyntheticDefaultImports": true,
-    "forceConsistentCasingInFileNames": true,
-    "jsx": "react-jsx",
-
-    /* Bundler mode */
-    "moduleResolution": "Node",
-    "resolveJsonModule": true,
-    "isolatedModules": true,
-    "noEmit": true,
-    "declaration": true,
-
-    /* Linting */
-    "strict": true,
-    "allowJs": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
+    "jsx": "react-jsx"
   },
   "include": ["src"],
   "references": [

diff --git a/packages/scribe/package.json b/packages/scribe/package.json
@@ -28,6 +28,7 @@
     "react-dom": ">=18.3.1"
   },
   "dependencies": {
+    "@biblionexus-foundation/scripture-utilities": "workspace:*",
     "@lexical/mark": "^0.16.0",
     "@lexical/react": "^0.16.0",
     "@lexical/selection": "^0.16.0",

diff --git a/packages/scribe/src/App.tsx b/packages/scribe/src/App.tsx
@@ -1,7 +1,7 @@
+import { Usj } from "@biblionexus-foundation/scripture-utilities";
 import { useState, useMemo, SyntheticEvent, useRef, useEffect } from "react";
 import { useUsfm2Usj } from "./hooks/useUsfm2Usj";
 import Editor, { EditorRef } from "./components/Editor";
-import { Usj } from "shared/converters/usj/usj.model";
 import { getViewOptions } from "./adaptors/view-options.utils";
 import { formattedViewMode as defaultViewMode } from "./plugins/view-mode.model";
 import { UsjNodeOptions } from "shared-react/nodes/scripture/usj/usj-node-options.model";

diff --git a/packages/scribe/src/adaptors/editor-usj.adaptor.ts b/packages/scribe/src/adaptors/editor-usj.adaptor.ts
@@ -1,17 +1,17 @@
+import {
+  MarkerContent,
+  MarkerObject,
+  USJ_TYPE,
+  USJ_VERSION,
+  Usj,
+} from "@biblionexus-foundation/scripture-utilities";
 import {
   EditorState,
   LineBreakNode,
   SerializedLexicalNode,
   SerializedTextNode,
   TextNode,
 } from "lexical";
-import {
-  MarkerContent,
-  MarkerObject,
-  USJ_TYPE,
-  USJ_VERSION,
-  Usj,
-} from "shared/converters/usj/usj.model";
 import {
   NBSP,
   getEditableCallerText,

diff --git a/packages/scribe/src/adaptors/note-usj-editor.adaptor.ts b/packages/scribe/src/adaptors/note-usj-editor.adaptor.ts
@@ -1,3 +1,11 @@
+import {
+  BookCode,
+  MarkerContent,
+  MarkerObject,
+  USJ_TYPE,
+  USJ_VERSION,
+  Usj,
+} from "@biblionexus-foundation/scripture-utilities";
 import { MarkNode, SerializedMarkNode } from "@lexical/mark";
 import {
   LineBreakNode,
@@ -7,14 +15,6 @@ import {
   SerializedTextNode,
   TextNode,
 } from "lexical";
-import {
-  BookCode,
-  MarkerContent,
-  MarkerObject,
-  USJ_TYPE,
-  USJ_VERSION,
-  Usj,
-} from "shared/converters/usj/usj.model";
 import {
   BOOK_MARKER,
   BOOK_VERSION,

diff --git a/packages/scribe/src/adaptors/usj-editor.adaptor.ts b/packages/scribe/src/adaptors/usj-editor.adaptor.ts
@@ -1,3 +1,11 @@
+import {
+  BookCode,
+  MarkerContent,
+  MarkerObject,
+  USJ_TYPE,
+  USJ_VERSION,
+  Usj,
+} from "@biblionexus-foundation/scripture-utilities";
 import { MarkNode, SerializedMarkNode } from "@lexical/mark";
 import {
   LineBreakNode,
@@ -7,14 +15,6 @@ import {
   SerializedTextNode,
   TextNode,
 } from "lexical";
-import {
-  BookCode,
-  MarkerContent,
-  MarkerObject,
-  USJ_TYPE,
-  USJ_VERSION,
-  Usj,
-} from "shared/converters/usj/usj.model";
 import {
   BOOK_MARKER,
   BOOK_VERSION,