add type checking (#1088)

- fixes #1085
- include core, extensions, platform-bible-utils, platform-bible-react
- fix existing type checking errors
- add typecheck to pre-commit
- use `noImplicitReturns` instead of `consistent-return`
- type check in CI
- fix jsdom type check errors
- also make VS Code use the repo TS version
- remember to remove the patch and the type overrides when the BNF types are fixed

.eslintrc.js

@@ -15,6 +15,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

.github/workflows/test.yml

@@ -57,6 +57,9 @@ jobs:
       - name: Install packages
         run: npm ci
 
+      - name: type checking
+        run: npm run typecheck
+
       - name: Build
         run: npm run build
 

.husky/pre-commit

@@ -1,11 +1,14 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-echo "Running Lint check..."
-
+echo "Lint checking..."
 # generate papi.d.ts as part of lint:staged
 npm run lint:staged
 echo "Lint check finished"
 
+echo "Type checking..."
+npm run typecheck
+echo "Type check finished"
+
 echo "If the following fails run npm run editor:unlink"
 npx yalc check

.vscode/settings.json

@@ -25,6 +25,7 @@
   "javascript.validate.enable": false,
   "javascript.format.enable": false,
   "typescript.format.enable": false,
+  "typescript.tsdk": "node_modules/typescript/lib",
 
   "search.exclude": {
     ".git": true,

extensions/.eslintrc.cjs

@@ -16,6 +16,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

extensions/src/c-sharp-provider-test/index.d.ts

@@ -1,4 +1,5 @@
 declare module 'c-sharp-provider-test' {
+  // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
   import { IDataProvider, DataProviderDataType } from '@papi/core';
 
   type TimeDataTypes = {

extensions/src/hello-someone/.eslintrc.js

@@ -16,6 +16,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

extensions/src/hello-someone/package.json

@@ -23,7 +23,8 @@
     "lint:scripts": "eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint:styles": "stylelint **/*.{css,scss}",
     "lint-fix": "npm run lint-fix:scripts && npm run lint:styles -- --fix",
-    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts"
+    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "browserslist": [],
   "peerDependencies": {

extensions/src/hello-someone/src/types/hello-someone.d.ts

@@ -1,4 +1,5 @@
 declare module 'hello-someone' {
+  // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
   import { IDataProvider, DataProviderDataType } from '@papi/core';
 
   export type Person = {

extensions/src/hello-world/.eslintrc.js

@@ -16,6 +16,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

extensions/src/hello-world/package.json

@@ -23,7 +23,8 @@
     "lint:scripts": "eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint:styles": "stylelint **/*.{css,scss}",
     "lint-fix": "npm run lint-fix:scripts && npm run lint:styles -- --fix",
-    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts"
+    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "browserslist": [],
   "peerDependencies": {

extensions/src/hello-world/src/types/hello-world.d.ts

@@ -1,4 +1,5 @@
 declare module 'hello-world' {
+  // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
   import type { DataProviderDataType, MandatoryProjectDataTypes } from '@papi/core';
   import type { IBaseProjectDataProvider } from 'papi-shared-types';
 

extensions/src/hello-world/src/web-views/hello-world.web-view.tsx

@@ -1,4 +1,4 @@
-import { VerseRef } from '@sillsdev/scripture';
+import { VerseRef } from '@sillsdev/scripture';
 import papi, { logger } from '@papi/frontend';
 import {
   useData,

extensions/src/legacy-comment-manager/src/types/legacy-comment-manager.d.ts

@@ -3,6 +3,7 @@ declare module 'legacy-comment-manager' {
     DataProviderDataType,
     DataProviderSubscriberOptions,
     DataProviderUpdateInstructions,
+    // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
   } from '@papi/core';
   import type { IProjectDataProvider } from 'papi-shared-types';
   import { UnsubscriberAsync } from 'platform-bible-utils';

extensions/src/platform-scripture-editor/.eslintrc.js

@@ -16,6 +16,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

extensions/src/platform-scripture-editor/package.json

@@ -23,7 +23,8 @@
     "lint:scripts": "eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint:styles": "stylelint **/*.{css,scss}",
     "lint-fix": "npm run lint-fix:scripts && npm run lint:styles -- --fix",
-    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts"
+    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "browserslist": [],
   "peerDependencies": {

extensions/src/platform-scripture-editor/src/types/@biblionexus-foundation__platform-editor.d.ts

@@ -0,0 +1,65 @@
+/**
+ * Work-around until the `@biblionexus-foundation/platform-editor` package fully includes its types.
+ * Note there is also a patch that should be removed when this is fixed.
+ */
+
+declare module 'shared-react/annotation/selection.model' {
+  type UsjLocation = {
+    jsonPath: string;
+    offset: number;
+  };
+
+  export type SelectionRange = {
+    start: UsjLocation;
+    end?: UsjLocation;
+  };
+
+  export type AnnotationRange = {
+    start: UsjLocation;
+    end: UsjLocation;
+  };
+}
+
+declare module 'shared-react/nodes/scripture/usj/ImmutableNoteCallerNode' {
+  export const immutableNoteCallerNodeName = 'ImmutableNoteCallerNode';
+}
+
+declare module 'shared-react/plugins/logger-basic.model' {
+  export type LoggerBasic = {
+    error(message: string): void;
+    warn(message: string): void;
+    info(message: string): void;
+  };
+}
+
+declare module 'shared-react/plugins/text-direction.model' {
+  /** Left-to-right or Right-to-left or Automatically determined from the content. */
+  export type TextDirection = 'ltr' | 'rtl' | 'auto';
+}
+
+declare module 'shared-react/nodes/scripture/usj/usj-node-options.model' {
+  import { SyntheticEvent } from 'react';
+
+  /** Option properties to use with each node. */
+  type NodeOptions = { [nodeClassName: string]: { [prop: string]: unknown } | undefined };
+  type OnClick = (event: SyntheticEvent) => void;
+  const immutableNoteCallerNodeName = 'ImmutableNoteCallerNode';
+
+  export const MarkNodeName = 'MarkNode';
+
+  export type AddMissingComments = (usjCommentIds: string[]) => void;
+
+  /** Options for each editor node. */
+  export interface UsjNodeOptions extends NodeOptions {
+    [immutableNoteCallerNodeName]?: {
+      /** Possible note callers to use when caller is '+'. */
+      noteCallers?: string[];
+      /** Click handler method. */
+      onClick?: OnClick;
+    };
+    [MarkNodeName]?: {
+      /** Method to add missing comments. */
+      addMissingComments?: AddMissingComments;
+    };
+  }
+}

extensions/src/platform-scripture/.eslintrc.js

@@ -16,6 +16,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

extensions/src/platform-scripture/package.json

@@ -23,7 +23,8 @@
     "lint:scripts": "eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint:styles": "stylelint **/*.{css,scss}",
     "lint-fix": "npm run lint-fix:scripts && npm run lint:styles -- --fix",
-    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts"
+    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "browserslist": [],
   "peerDependencies": {

extensions/src/platform-scripture/src/types/platform-scripture.d.ts

@@ -6,6 +6,7 @@ declare module 'platform-scripture' {
     DataProviderUpdateInstructions,
     ExtensionDataScope,
     IDataProvider,
+    // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
   } from '@papi/core';
   import type { IProjectDataProvider } from 'papi-shared-types';
   import { Dispose, LocalizeKey, UnsubscriberAsync } from 'platform-bible-utils';

extensions/src/project-notes-data-provider/index.d.ts

@@ -3,6 +3,7 @@ import type {
   DataProviderDataType,
   DataProviderSubscriberOptions,
   IDataProvider,
+  // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
 } from '@papi/core';
 import { PlatformEvent, Unsubscriber } from 'platform-bible-utils';
 

extensions/src/quick-verse/.eslintrc.js

@@ -16,6 +16,8 @@ module.exports = {
 
     // #region ERB rules
 
+    // Use `noImplicitReturns` instead. See https://typescript-eslint.io/rules/consistent-return/.
+    'consistent-return': 'off',
     'import/extensions': 'off',
     // A temporary hack related to IDE not resolving correct package.json
     'import/no-extraneous-dependencies': 'off',

extensions/src/quick-verse/package.json

@@ -24,7 +24,8 @@
     "lint:scripts": "eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint:styles": "stylelint **/*.{css,scss}",
     "lint-fix": "npm run lint-fix:scripts && npm run lint:styles -- --fix",
-    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts"
+    "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "browserslist": [],
   "peerDependencies": {

extensions/src/quick-verse/src/types/quick-verse.d.ts

@@ -1,4 +1,5 @@
 declare module 'quick-verse' {
+  // @ts-ignore: TS2307 - Cannot find module '@papi/core' or its corresponding type declarations
   import { DataProviderDataType, IDataProvider } from '@papi/core';
 
   export type QuickVerseSetData = string | { text: string; isHeresy: boolean };

extensions/tsconfig.json

@@ -23,7 +23,7 @@
     "jsx": "react-jsx",
     "typeRoots": [
       // Include default type declarations
-      "./node_modules/@types",
+      "../node_modules/@types",
       // Include papi-dts type declarations (for papi.d.ts)
       "../lib",
       // Include these bundled extensions' type declarations

lib/papi-dts/package.json

@@ -32,7 +32,8 @@
     "clean": "rimraf papi.tsbuildinfo",
     "lint": "cross-env NODE_ENV=development eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint-fix": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint",
-    "lint:staged": "lint-staged -q"
+    "lint:staged": "lint-staged -q",
+    "typecheck": "tsc -p ./tsconfig.lint.json"
   },
   "lint-staged": {
     "*.{cjs,js,jsx,ts,tsx}": ["prettier --write", "cross-env NODE_ENV=development eslint --cache"],

lib/papi-dts/tsconfig.lint.json

@@ -1,4 +1,10 @@
 {
-  "extends": "./tsconfig",
-  "files": [".eslintrc.cjs", "edit-papi-d-ts.ts", "papi.d.ts"]
+  "extends": "../../tsconfig",
+  "compilerOptions": {
+    "module": "ESNext",
+    "baseUrl": "./",
+    "noEmit": true
+  },
+  "include": [".eslintrc.cjs", "edit-papi-d-ts.ts", "papi.d.ts"],
+  "exclude": []
 }

lib/platform-bible-react/package.json

@@ -39,7 +39,8 @@
     "lint:styles": "stylelint **/*.{css,scss}",
     "lint-fix": "npm run lint-fix:scripts && npm run lint:styles -- --fix",
     "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
-    "test": "jest --silent"
+    "test": "jest --silent",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "peerDependencies": {
     "react": ">=18.3.1",

lib/platform-bible-react/tsconfig.json

@@ -2,7 +2,6 @@
   "extends": "../../tsconfig",
   "compilerOptions": {
     "baseUrl": "./src",
-    "rootDir": "./src",
     "target": "ESNext",
     "module": "ESNext",
     // Running npm i removes packages that are in common between the current directory's
@@ -16,7 +15,7 @@
     "incremental": false,
     "isolatedModules": true,
     "noEmit": true,
-    "noImplicitReturns": false,
+    "noImplicitReturns": true,
     "skipLibCheck": false,
     "useDefineForClassFields": true,
     "outDir": "",

lib/platform-bible-utils/package.json

@@ -38,7 +38,8 @@
     "lint:scripts": "cross-env NODE_ENV=development eslint --ext .cjs,.js,.jsx,.ts,.tsx --cache .",
     "lint-fix": "npm run lint-fix:scripts",
     "lint-fix:scripts": "prettier --write \"**/*.{ts,tsx,js,jsx,cjs}\" && npm run lint:scripts",
-    "test": "jest --silent"
+    "test": "jest --silent",
+    "typecheck": "tsc -p ./tsconfig.json"
   },
   "peerDependencies": {},
   "dependencies": {

lib/platform-bible-utils/tsconfig.json

@@ -2,7 +2,6 @@
   "extends": "../../tsconfig",
   "compilerOptions": {
     "baseUrl": "./src",
-    "rootDir": "./src",
     "target": "ESNext",
     "module": "ESNext",
     // Running npm i removes packages that are in common between the current directory's
@@ -16,7 +15,7 @@
     "incremental": false,
     "isolatedModules": true,
     "noEmit": true,
-    "noImplicitReturns": false,
+    "noImplicitReturns": true,
     "skipLibCheck": false,
     "useDefineForClassFields": true,
     "outDir": "",