Merge pull request #3540 from clairep94/pr05/migrate_client_utils_instance

pr05 Typescript #2: automatically resolve imports of ts files & migrate instance of client/utils file

Author: raclim

.eslintrc

@@ -16,6 +16,16 @@
     "import/no-unresolved": 0,
     "import/no-named-as-default": 0,
     "import/no-named-as-default-member": 0,
+    "import/extensions": [ // override airbnb setting to allow imports of js, jsx, ts, and tsx files to auto-resolve instead of error
+      "error",
+      "ignorePackages",
+      {
+        "js": "never",
+        "jsx": "never",
+        "ts": "never",
+        "tsx": "never"
+      }
+    ],
     "comma-dangle": 0,  // not sure why airbnb turned this on. gross!
     "indent": 0,
     "no-console": 0,
@@ -72,6 +82,11 @@
   ],
   "settings": {
     "import/parser": "@babel/eslint-parser",
+    "import/resolver": {
+      "node": {
+        "extensions": [".js", ".jsx", ".ts", ".tsx"]
+      }
+    },
     "import/resolve": {
       "moduleDirectory": ["node_modules"]
     }

client/utils/__mocks__/generateRandomName.js renamed to client/utils/__mocks__/generateRandomName.ts

@@ -1,6 +1,11 @@
 import friendlyWords from 'friendly-words';
 
-export function generateProjectName() {
+/**
+ * Generates a random friendly project name composed of an adjective and an object.
+ * @example
+ * generateProjectName(); // "brave mountain"
+ */
+export function generateProjectName(): string {
   const adj =
     friendlyWords.predicates[
       Math.floor(Math.random() * friendlyWords.predicates.length)
@@ -12,7 +17,12 @@ export function generateProjectName() {
   return `${adj} ${obj}`;
 }
 
-export function generateCollectionName() {
+/**
+ * Generates a random friendly collection name using an adjective.
+ * @example
+ * generateCollectionName(); // "My clever collection"
+ */
+export function generateCollectionName(): string {
   const adj =
     friendlyWords.predicates[
       Math.floor(Math.random() * friendlyWords.predicates.length)

client/utils/generateRandomName.js renamed to client/utils/generateRandomName.ts

@@ -49,12 +49,16 @@
           "<rootDir>/server/jest.setup.js"
         ],
         "testMatch": [
-          "<rootDir>/server/**/*.test.(js|jsx)"
+          "<rootDir>/server/**/*.test.(js|jsx|ts|tsx)"
         ]
       },
       {
         "displayName": "client",
         "testEnvironment": "jsdom",
+        "transform": {
+          "^.+\\.[jt]sx?$": "babel-jest"
+        },
+        "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "node"],
         "setupFilesAfterEnv": [
           "<rootDir>/client/jest.setup.js"
         ],
@@ -63,7 +67,7 @@
           "\\.(css|less|scss)$": "<rootDir>/client/__mocks__/styleMock.js"
         },
         "testMatch": [
-          "<rootDir>/client/**/*.test.(js|jsx)"
+          "<rootDir>/client/**/*.test.(js|jsx|ts|tsx)"
         ]
       }
     ]
@@ -114,6 +118,7 @@
     "@svgr/webpack": "^6.2.1",
     "@testing-library/jest-dom": "^5.15.0",
     "@testing-library/react": "^12.1.2",
+    "@types/friendly-words": "^1.2.2",
     "@types/jest": "^29.5.14",
     "@types/node": "^16.18.126",
     "@types/react": "^16.14.0",