SF-3344 Add Lynx punctuation checker

.vscode/settings.json

@@ -14,6 +14,7 @@
     "caniuse",
     "cdnjs",
     "Charis",
+    "checkmark",
     "combobox",
     "commenters",
     "compodoc",
@@ -29,6 +30,7 @@
     "indexeddb",
     "ldml",
     "listbox",
+    "Lynxable",
     "mailto",
     "mingo",
     "mixins",

scripts/db_tools/parse-version.ts

@@ -38,7 +38,8 @@ class ParseVersion {
     'Upload Paratext Zip Files for Pre-Translation Drafting',
     'Allow mixing in an additional training source',
     'Updated Learning Rate For Serval',
-    'Dark Mode'
+    'Dark Mode',
+    'Enable Lynx insights'
   ];
 
   constructor() {

src/RealtimeServer/scriptureforge/models/lynx-insight-user-data.ts

@@ -0,0 +1,11 @@
+import { LynxInsightFilter, LynxInsightSortOrder } from './lynx-insight';
+
+export interface LynxInsightUserData {
+  panelData?: LynxInsightPanelUserData;
+}
+
+export interface LynxInsightPanelUserData {
+  isOpen: boolean;
+  filter: LynxInsightFilter;
+  sortOrder: LynxInsightSortOrder;
+}

src/RealtimeServer/scriptureforge/models/lynx-insight.ts

@@ -0,0 +1,16 @@
+// Ordered by severity, lowest to highest
+export const LynxInsightTypes = ['info', 'warning', 'error'] as const;
+export type LynxInsightType = (typeof LynxInsightTypes)[number];
+
+// Ordered from widest to narrowest scope
+export const LynxInsightFilterScopes = ['project', 'book', 'chapter'] as const;
+export type LynxInsightFilterScope = (typeof LynxInsightFilterScopes)[number];
+
+export const LynxInsightSortOrders = ['severity', 'appearance'] as const;
+export type LynxInsightSortOrder = (typeof LynxInsightSortOrders)[number];
+
+export interface LynxInsightFilter {
+  types: LynxInsightType[];
+  scope: LynxInsightFilterScope;
+  includeDismissed?: boolean;
+}

src/RealtimeServer/scriptureforge/models/sf-project-user-config-test-data.ts

@@ -17,7 +17,8 @@ export function createTestProjectUserConfig(overrides?: RecursivePartial<SFProje
     answerRefsRead: [],
     commentRefsRead: [],
     noteRefsRead: [],
-    editorTabsOpen: []
+    editorTabsOpen: [],
+    lynxInsightState: {}
   };
 
   return merge(defaultSFProjectUserConfig, overrides);

src/RealtimeServer/scriptureforge/models/sf-project-user-config.ts

@@ -1,5 +1,6 @@
 import { PROJECT_DATA_INDEX_PATHS, ProjectData } from '../../common/models/project-data';
 import { EditorTabPersistData } from './editor-tab-persist-data';
+import { LynxInsightUserData } from './lynx-insight-user-data';
 
 export const SF_PROJECT_USER_CONFIGS_COLLECTION = 'sf_project_user_configs';
 export const SF_PROJECT_USER_CONFIG_INDEX_PATHS: string[] = PROJECT_DATA_INDEX_PATHS;
@@ -28,4 +29,5 @@ export interface SFProjectUserConfig extends ProjectData {
   answerRefsRead: string[];
   commentRefsRead: string[];
   editorTabsOpen: EditorTabPersistData[];
+  lynxInsightState: LynxInsightUserData;
 }

src/RealtimeServer/scriptureforge/services/sf-project-user-config-migrations.ts

@@ -85,12 +85,24 @@
   }
 }
 
+class SFProjectUserConfigMigration8 extends DocMigration {
+  static readonly VERSION = 8;
+
+  async migrateDoc(doc: Doc): Promise<void> {
+    if (doc.data.lynxInsightState === undefined) {
+      const op: ObjectInsertOp = { p: ['lynxInsightState'], oi: {} };
+      await submitMigrationOp(SFProjectUserConfigMigration8.VERSION, doc, [op]);
+    }
+  }
+}
+
 export const SF_PROJECT_USER_CONFIG_MIGRATIONS: MigrationConstructor[] = monotonicallyIncreasingMigrationList([
   SFProjectUserConfigMigration1,
   SFProjectUserConfigMigration2,
   SFProjectUserConfigMigration3,
   SFProjectUserConfigMigration4,
   SFProjectUserConfigMigration5,
   SFProjectUserConfigMigration6,
-  SFProjectUserConfigMigration7
+  SFProjectUserConfigMigration7,
+  SFProjectUserConfigMigration8
 ]);

src/RealtimeServer/scriptureforge/services/sf-project-user-config-service.ts

@@ -112,6 +112,39 @@ export class SFProjectUserConfigService extends SFProjectDataService<SFProjectUs
           },
           additionalProperties: false
         }
+      },
+      lynxInsightState: {
+        bsonType: 'object',
+        properties: {
+          panelData: {
+            bsonType: 'object',
+            required: ['isOpen', 'filter', 'sortOrder'],
+            properties: {
+              isOpen: {
+                bsonType: 'bool'
+              },
+              filter: {
+                bsonType: 'object',
+                required: ['types', 'scope'],
+                properties: {
+                  types: {
+                    bsonType: 'array',
+                    items: {
+                      bsonType: 'string'
+                    }
+                  },
+                  scope: {
+                    bsonType: 'string'
+                  }
+                }
+              },
+              sortOrder: {
+                bsonType: 'string'
+              }
+            }
+          }
+        },
+        additionalProperties: false
       }
     },
     additionalProperties: false

src/SIL.XForge.Scripture/ClientApp/angular.json

@@ -81,7 +81,7 @@
               ],
               "optimization": true,
               "outputHashing": "all",
-              "namedChunks": false,
+              "namedChunks": true,
               "aot": true,
               "vendorChunk": false,
               "buildOptimizer": true,
@@ -102,7 +102,7 @@
               ],
               "optimization": true,
               "outputHashing": "all",
-              "namedChunks": false,
+              "namedChunks": true,
               "aot": true,
               "vendorChunk": false,
               "buildOptimizer": true,
@@ -116,7 +116,7 @@
                 }
               ],
               "outputHashing": "all",
-              "namedChunks": false,
+              "namedChunks": true,
               "vendorChunk": false,
               "serviceWorker": true
             },

src/SIL.XForge.Scripture/ClientApp/package.json

@@ -50,6 +50,9 @@
     "@microsoft/signalr": "^7.0.0",
     "@ngneat/transloco": "^4.3.0",
     "@ngneat/transloco-locale": "^4.1.0",
+    "@sillsdev/lynx": "^0.3.4",
+    "@sillsdev/lynx-delta": "^0.2.1",
+    "@sillsdev/lynx-punctuation-checker": "^0.1.4",
     "@sillsdev/machine": "^2.4.2",
     "@sillsdev/scripture": "1.4.1",
     "angular-file": "^4.0.2",
@@ -73,7 +76,7 @@
     "papaparse": "^5.3.2",
     "process": "^0.11.10",
     "quill": "^2.0.3",
-    "quill-cursors": "^3.1.2",
+    "quill-cursors": "^4.0.4",
     "realtime-server": "file:../../RealtimeServer",
     "reconnecting-websocket": "^4.4.0",
     "rich-text": "^4.1.0",

src/SIL.XForge.Scripture/ClientApp/src/app/app.module.ts

@@ -41,6 +41,7 @@ import { GlobalNoticesComponent } from './shared/global-notices/global-notices.c
 import { SharedModule } from './shared/shared.module';
 import { TextNoteDialogComponent } from './shared/text/text-note-dialog/text-note-dialog.component';
 import { SyncComponent } from './sync/sync.component';
+import { LynxInsightsModule } from './translate/editor/lynx/insights/lynx-insights.module';
 import { TranslateModule } from './translate/translate.module';
 import { UsersModule } from './users/users.module';
 
@@ -78,11 +79,12 @@ import { UsersModule } from './users/users.module';
     TranslocoModule,
     TranslocoMarkupModule,
     AppRoutingModule,
-    SharedModule,
+    SharedModule.forRoot(),
     AvatarComponent,
     MatRipple,
     GlobalNoticesComponent,
-    QuillModule.forRoot()
+    QuillModule.forRoot(),
+    LynxInsightsModule.forRoot()
   ],
   providers: [
     { provide: APP_ID, useValue: 'ng-cli-universal' },

src/SIL.XForge.Scripture/ClientApp/src/app/checking/attach-audio/attach-audio.component.spec.ts

@@ -21,7 +21,7 @@ describe('AttachAudioComponent', () => {
   let env: TestEnvironment;
 
   configureTestingModule(() => ({
-    imports: [UICommonModule, ngfModule, SharedModule, TestTranslocoModule, TestOnlineStatusModule.forRoot()],
+    imports: [UICommonModule, ngfModule, SharedModule.forRoot(), TestTranslocoModule, TestOnlineStatusModule.forRoot()],
     declarations: [AttachAudioComponent],
     providers: [{ provide: DialogService, useMock: mockDialogService }]
   }));

src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking-text/checking-text.component.spec.ts

@@ -35,7 +35,7 @@ describe('CheckingTextComponent', () => {
     declarations: [CheckingTextComponent],
     imports: [
       NoopAnimationsModule,
-      SharedModule,
+      SharedModule.forRoot(),
       UICommonModule,
       TestRealtimeModule.forRoot(SF_TYPE_REGISTRY),
       TestOnlineStatusModule.forRoot(),

src/SIL.XForge.Scripture/ClientApp/src/app/checking/checking/checking.component.spec.ts

@@ -155,7 +155,7 @@ describe('CheckingComponent', () => {
       ngfModule,
       NoopAnimationsModule,
       RouterModule.forRoot(ROUTES),
-      SharedModule,
+      SharedModule.forRoot(),
       UICommonModule,
       OwnerComponent,
       TestTranslocoModule,

src/SIL.XForge.Scripture/ClientApp/src/app/checking/question-dialog/question-dialog.component.spec.ts

@@ -45,6 +45,7 @@ import { SF_TYPE_REGISTRY } from '../../core/models/sf-type-registry';
 import { TextDoc, TextDocId } from '../../core/models/text-doc';
 import { SFProjectService } from '../../core/sf-project.service';
 import { ScriptureChooserDialogComponent } from '../../scripture-chooser-dialog/scripture-chooser-dialog.component';
+import { SharedModule } from '../../shared/shared.module';
 import { getTextDoc } from '../../shared/test-utils';
 import { EDITOR_READY_TIMEOUT } from '../../shared/text/text.component';
 import { CheckingModule } from '../checking.module';
@@ -65,6 +66,7 @@ describe('QuestionDialogComponent', () => {
       ReactiveFormsModule,
       FormsModule,
       DialogTestModule,
+      SharedModule.forRoot(),
       TestOnlineStatusModule.forRoot(),
       TestRealtimeModule.forRoot(SF_TYPE_REGISTRY)
     ],

src/SIL.XForge.Scripture/ClientApp/src/app/my-projects/my-projects.component.spec.ts

@@ -40,7 +40,7 @@ describe('MyProjectsComponent', () => {
     declarations: [MyProjectsComponent],
     imports: [
       UICommonModule,
-      SharedModule,
+      SharedModule.forRoot(),
       RouterModule.forRoot([
         { path: 'projects/:projectId', component: EmptyComponent },
         { path: 'connect-project', component: EmptyComponent }

src/SIL.XForge.Scripture/ClientApp/src/app/my-projects/my-projects.stories.ts

@@ -192,7 +192,7 @@ const meta: Meta = {
     moduleMetadata({
       imports: [
         UICommonModule,
-        SharedModule,
+        SharedModule.forRoot(),
         RouterModule.forChild([
           { path: 'projects/:projectId', component: EmptyComponent },
           { path: 'connect-project', component: EmptyComponent }