Migrate all remaining JS files to TS, tweak ESLint and Typescript con…

…figuration (#3141) * Migrate test files to typescript * Delete .babelrc file * Use simpler command to run eslint * Reconfigure tsconfig Use esnext consistently in tsconfig.json Add vitest globals to tsconfig types Include src and test directories in tsconfig Split tsconfig into separate files * Comment out test with no assertion * Reconfigure eslint
Kinto · Jan 25, 2024 · 539072b · 539072b
1 parent 09076ff
commit 539072b
Show file tree

Hide file tree

Showing 57 changed files with 81 additions and 104 deletions.
diff --git a/.babelrc b/.babelrc
diff --git a/.eslintrc b/.eslintrc
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -0,0 +1,36 @@
+module.exports = {
+  "root": true,
+  "parser": "@typescript-eslint/parser",
+  "ignorePatterns": ["dist", ".eslintrc.cjs"],
+  "env": { "browser": true, "es2020": true },
+  "extends": [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:react-hooks/recommended",
+    "prettier"
+  ],
+  "plugins": ["@typescript-eslint/eslint-plugin"],
+  "rules": {
+    // ***
+    // TODO: turn these rules on progressively
+    "prefer-const": "off",
+    "no-var": "off",
+    "react-hooks/exhaustive-deps": "off",
+    "@typescript-eslint/ban-types": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/ban-ts-comment": "off",
+    // ***
+    "no-unused-vars": "off",
+    "@typescript-eslint/no-unused-vars": [
+      "error",
+      { "vars": "all", "args": "none", "varsIgnorePattern": "^_" }
+    ],
+    "no-console": "off"
+  },
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module",
+    "project": ["./tsconfig.json", "./tsconfig.node.json"],
+    "tsconfigRootDir": __dirname,
+  }
+}
diff --git a/__mocks__/kinto-http.js → __mocks__/kinto-http.ts b/__mocks__/kinto-http.js → __mocks__/kinto-http.ts
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -9,7 +9,7 @@
     "build:kinto-single": "ASSET_PATH=/v1/admin KINTO_ADMIN_SINGLE_SERVER=1 vite build",
     "cs-check": "prettier -l \"{src,test}/**/*.{js,jsx,ts,tsx}\"",
     "cs-format": "prettier \"{src,test}/**/*.{js,jsx,ts,tsx}\" --write",
-    "lint": "eslint \"src/**/*.{js,jsx,ts,tsx}\" \"test/**/*.{js,jsx,ts,tsx}\"",
+    "lint": "eslint . --ext ts,tsx",
     "preview": "vite preview",
     "publish-to-gh-pages": "ASSET_PATH=/kinto-admin/ npm run build && gh-pages --add --dist build/",
     "start": "vite",
@@ -61,8 +61,9 @@
     "@typescript-eslint/parser": "^6.19.0",
     "@vitejs/plugin-react": "^4.2.1",
     "eslint": "^8.56.0",
-    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
     "gh-pages": "^6.0.0",
     "prettier": "^3.0.2",
     "toctoc": "^0.4.0",

diff --git a/test/.eslintrc b/test/.eslintrc
diff --git a/test/components/AuthForm_test.jsx → test/components/AuthForm_test.tsx b/test/components/AuthForm_test.jsx → test/components/AuthForm_test.tsx
diff --git a/test/components/BaseForm_test.jsx → test/components/BaseForm_test.tsx b/test/components/BaseForm_test.jsx → test/components/BaseForm_test.tsx
diff --git a/test/components/CollectionForm_test.jsx → test/components/CollectionForm_test.tsx b/test/components/CollectionForm_test.jsx → test/components/CollectionForm_test.tsx
diff --git a/test/components/CollectionRecords_test.jsx → test/components/CollectionRecords_test.tsx b/test/components/CollectionRecords_test.jsx → test/components/CollectionRecords_test.tsx
diff --git a/test/components/HistoryTable_test.jsx → test/components/HistoryTable_test.tsx b/test/components/HistoryTable_test.jsx → test/components/HistoryTable_test.tsx
diff --git a/test/components/Homepage_test.jsx → test/components/Homepage_test.tsx b/test/components/Homepage_test.jsx → test/components/Homepage_test.tsx
diff --git a/test/components/Layout_test.jsx → test/components/Layout_test.tsx b/test/components/Layout_test.jsx → test/components/Layout_test.tsx
diff --git a/test/components/Notifications_test.jsx → test/components/Notifications_test.tsx b/test/components/Notifications_test.jsx → test/components/Notifications_test.tsx
diff --git a/test/components/RecordAttributes_test.jsx → test/components/RecordAttributes_test.tsx b/test/components/RecordAttributes_test.jsx → test/components/RecordAttributes_test.tsx
diff --git a/test/components/RecordBulk_test.jsx → test/components/RecordBulk_test.tsx b/test/components/RecordBulk_test.jsx → test/components/RecordBulk_test.tsx
diff --git a/test/components/RecordCreate_test.jsx → test/components/RecordCreate_test.tsx b/test/components/RecordCreate_test.jsx → test/components/RecordCreate_test.tsx
diff --git a/test/components/Sidebar_test.jsx → test/components/Sidebar_test.tsx b/test/components/Sidebar_test.jsx → test/components/Sidebar_test.tsx
diff --git a/test/components/TagsField_test.jsx → test/components/TagsField_test.tsx b/test/components/TagsField_test.jsx → test/components/TagsField_test.tsx
diff --git a/...onents/bucket/CollectionDataList_test.jsx → ...onents/bucket/CollectionDataList_test.tsx b/...onents/bucket/CollectionDataList_test.jsx → ...onents/bucket/CollectionDataList_test.tsx
diff --git a/.../components/bucket/GroupDataList_test.jsx → .../components/bucket/GroupDataList_test.tsx b/.../components/bucket/GroupDataList_test.jsx → .../components/bucket/GroupDataList_test.tsx
diff --git a/...components/record/JSONRecordForm_test.jsx → ...components/record/JSONRecordForm_test.tsx b/...components/record/JSONRecordForm_test.jsx → ...components/record/JSONRecordForm_test.tsx
diff --git a/test/components/record/RecordForm_test.jsx → test/components/record/RecordForm_test.tsx b/test/components/record/RecordForm_test.jsx → test/components/record/RecordForm_test.tsx
diff --git a/...ponents/record/RecordPermissions_test.jsx → ...ponents/record/RecordPermissions_test.tsx b/...ponents/record/RecordPermissions_test.jsx → ...ponents/record/RecordPermissions_test.tsx
diff --git a/...components/signoff/CommentDialog_test.jsx → ...components/signoff/CommentDialog_test.tsx b/...components/signoff/CommentDialog_test.jsx → ...components/signoff/CommentDialog_test.tsx
diff --git a/...f/SimpleReview/PerRecordDiffView_test.jsx → ...f/SimpleReview/PerRecordDiffView_test.tsx b/...f/SimpleReview/PerRecordDiffView_test.jsx → ...f/SimpleReview/PerRecordDiffView_test.tsx
diff --git a/...SimpleReview/SimpleReviewButtons_test.jsx → ...SimpleReview/SimpleReviewButtons_test.tsx b/...SimpleReview/SimpleReviewButtons_test.jsx → ...SimpleReview/SimpleReviewButtons_test.tsx
@@ -43,8 +43,9 @@ describe("SimpleReviewHeader component", () => {
     expect(await screen.findByTestId("spinner")).toBeDefined();
   });
 
-  it("should open CommentDialog when request review is clicked and call requestReview from modal", async () => {
-    const {} = renderButtons({ status: "work-in-progress" });
+  it.skip("should open CommentDialog when request review is clicked and call requestReview from modal", async () => {
+    // TODO: What should this test do?
+    // const { } = renderButtons({ status: "work-in-progress" });
   });
 
   it("should display rollback button when status is wip and call rollbackChanges from modal", async () => {

diff --git a/.../SimpleReview/SimpleReviewHeader_test.jsx → .../SimpleReview/SimpleReviewHeader_test.tsx b/.../SimpleReview/SimpleReviewHeader_test.jsx → .../SimpleReview/SimpleReviewHeader_test.tsx
diff --git a/...ignoff/SimpleReview/SimpleReview_test.jsx → ...ignoff/SimpleReview/SimpleReview_test.tsx b/...ignoff/SimpleReview/SimpleReview_test.jsx → ...ignoff/SimpleReview/SimpleReview_test.tsx
diff --git a/test/components/signoff/components_test.jsx → test/components/signoff/components_test.tsx b/test/components/signoff/components_test.jsx → test/components/signoff/components_test.tsx
diff --git a/test/hooks/storage_test.js → test/hooks/storage_test.ts b/test/hooks/storage_test.js → test/hooks/storage_test.ts
diff --git a/test/locationUtils_test.js → test/locationUtils_test.ts b/test/locationUtils_test.js → test/locationUtils_test.ts
diff --git a/test/permission_test.js → test/permission_test.ts b/test/permission_test.js → test/permission_test.ts
diff --git a/test/reducers/bucket_test.js → test/reducers/bucket_test.ts b/test/reducers/bucket_test.js → test/reducers/bucket_test.ts
diff --git a/test/reducers/collection_test.js → test/reducers/collection_test.ts b/test/reducers/collection_test.js → test/reducers/collection_test.ts
diff --git a/test/reducers/group_test.js → test/reducers/group_test.ts b/test/reducers/group_test.js → test/reducers/group_test.ts
diff --git a/test/reducers/notifications_test.js → test/reducers/notifications_test.ts b/test/reducers/notifications_test.js → test/reducers/notifications_test.ts
diff --git a/test/reducers/record_test.js → test/reducers/record_test.ts b/test/reducers/record_test.js → test/reducers/record_test.ts
diff --git a/test/reducers/servers_test.js → test/reducers/servers_test.ts b/test/reducers/servers_test.js → test/reducers/servers_test.ts
diff --git a/test/reducers/sessions_test.js → test/reducers/sessions_test.ts b/test/reducers/sessions_test.js → test/reducers/sessions_test.ts
diff --git a/test/routes_test.js → test/routes_test.ts b/test/routes_test.js → test/routes_test.ts
diff --git a/test/sagas/bucket_test.js → test/sagas/bucket_test.ts b/test/sagas/bucket_test.js → test/sagas/bucket_test.ts
diff --git a/test/sagas/collection_test.js → test/sagas/collection_test.ts b/test/sagas/collection_test.js → test/sagas/collection_test.ts
diff --git a/test/sagas/group_test.js → test/sagas/group_test.ts b/test/sagas/group_test.js → test/sagas/group_test.ts
diff --git a/test/sagas/index_test.js → test/sagas/index_test.ts b/test/sagas/index_test.js → test/sagas/index_test.ts
diff --git a/test/sagas/record_test.js → test/sagas/record_test.ts b/test/sagas/record_test.js → test/sagas/record_test.ts
diff --git a/test/sagas/route_test.js → test/sagas/route_test.ts b/test/sagas/route_test.js → test/sagas/route_test.ts
diff --git a/test/sagas/session_test.js → test/sagas/session_test.ts b/test/sagas/session_test.js → test/sagas/session_test.ts
diff --git a/test/sagas/signoff_test.js → test/sagas/signoff_test.ts b/test/sagas/signoff_test.js → test/sagas/signoff_test.ts
diff --git a/test/setupTests.js → test/setupTests.ts b/test/setupTests.js → test/setupTests.ts
diff --git a/test/store/localStore_test.js → test/store/localStore_test.ts b/test/store/localStore_test.js → test/store/localStore_test.ts
diff --git a/test/url_test.js → test/url_test.ts b/test/url_test.js → test/url_test.ts
diff --git a/test/utils_test.js → test/utils_test.ts b/test/utils_test.js → test/utils_test.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -1,13 +1,14 @@
 {
   "compilerOptions": {
-    "target": "ES2020",
+    "target": "ESNext",
     "useDefineForClassFields": true,
-    "lib": ["ES2020", "DOM", "DOM.Iterable", "esnext"],
-    "module": "esnext",
+    "lib": ["ESNext", "DOM", "DOM.Iterable"],
+    "module": "ESNext",
     "skipLibCheck": true,
     "moduleResolution": "bundler",
     "allowImportingTsExtensions": true,
     "resolveJsonModule": true,
+    "types": ["vitest/globals"],
     "isolatedModules": true,
     "noEmit": true,
     "jsx": "react-jsx",
@@ -16,19 +17,8 @@
     "forceConsistentCasingInFileNames": true,
     "experimentalDecorators": true,
     "declaration": true,
-    "allowJs": false,
-
+    "allowJs": false, 
   },
-  "ts-node": {
-    "compilerOptions": {
-      "sourceMap": true,
-      "composite": true,
-      "skipLibCheck": true,
-      "module": "ESNext",
-      "moduleResolution": "bundler",
-      "allowSyntheticDefaultImports": true
-    },
-    "include": ["vite.config.ts"]
-  },
-  "include": ["./src/"]
+  "include": ["src", "test", "__mocks__"],
+  "references": [{ "path": "./tsconfig.node.json" }]
 }
diff --git a/tsconfig.node.json b/tsconfig.node.json
@@ -0,0 +1,11 @@
+  {
+    "compilerOptions": {
+      "sourceMap": true,
+      "composite": true,
+      "skipLibCheck": true,
+      "module": "ESNext",
+      "moduleResolution": "bundler",
+      "allowSyntheticDefaultImports": true
+    },
+    "include": ["vite.config.ts"]
+  }
diff --git a/vite.config.ts b/vite.config.ts
@@ -28,6 +28,6 @@ export default defineConfig({
     globals: true,
     environment: "jsdom",
     include: ["**/*_{test,spec}.?(c|m)[jt]s?(x)"],
-    setupFiles: ["test/setupTests.js"]
+    setupFiles: ["test/setupTests.ts"]
   }
 })