Merge branch 'master' into feature/redirect-admin-console-settings

Author: jesusbalderramawgu

.eslintignore

@@ -5,8 +5,9 @@ Design decisions and their rationales should be documented in the repo (docstrin
 [OEP-19](https://open-edx-proposals.readthedocs.io/en/latest/oep-0019-bp-developer-documentation.html), and can be linked here.
 
 Useful information to include:
+
 - Which user roles will this change impact? Common user roles are "Learner", "Course Author",
-"Developer", and "Operator".
+  "Developer", and "Operator".
 - Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
 
 ## Supporting information
@@ -21,6 +22,7 @@ Please provide detailed step-by-step instructions for manually testing this chan
 ## Other information
 
 Include anything else that will help reviewers and consumers understand the change.
+
 - Does this change depend on other changes elsewhere?
 - Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.
 

.eslintrc.js

@@ -3,21 +3,29 @@
   "categories": {
     "correctness": "warn"
   },
+  "plugins": ["react"],
   "rules": {
-    "eslint/no-unused-vars": "off",
-    "typescript/unbound-method": "off", // 🛑 TEMPORARY
+    "eslint/no-unused-vars": ["warn", {
+      // Allow using {ignoredProp, ...keepTheRest} to omit a prop like 'ignoredProp' from an object.
+      "ignoreRestSiblings": true
+    }],
+    // We disable exhaustive-deps because: it's noisy, and we often include extra deps when we want a memoized thing to
+    // re-calculate after some change, even if we're not using that thing in the calculation.
+    "react-hooks/exhaustive-deps": "off",
+    // Rule of hooks is useful, but not on by default:
+    "react/rules-of-hooks": "warn",
     "typescript/no-floating-promises": ["error", {
       "allowForKnownSafeCalls": [
         // queryClient.invalidateQueries returns a promise that can be awaited
         // if you want to do something after all the subsequent refetches are
         // complete, but we rarely if ever want that; we usually want to
         // continue invalidating more things immediately. So we don't usually
         // want to await this.
-        "invalidateQueries",
+        "invalidateQueries"
       ]
     }]
   },
   "ignorePatterns": [
-    "webpack.dev-tutor.config.js",
+    "webpack.dev-tutor.config.js"
   ]
-}
+}

.github/pull_request_template.md

@@ -51,9 +51,7 @@ validate-no-uncommitted-package-lock-changes:
 validate:
 	make validate-no-uncommitted-package-lock-changes
 	npm run i18n_extract
-# We are trying out oxlint. Now that it's been working well for a while with both oxlint and eslint, we have disabled
-# eslint, and after a few weeks we'll evaluate whether any problems are slipping through if only oxlint is used.
-	npm run oxlint
+	npm run lint
 	npm run types
 	npm run test:ci
 	npm run build

.oxlintrc.json

@@ -0,0 +1,38 @@
+{
+  "lineWidth": 120,
+  "indentWidth": 2,
+  "useTabs": false,
+  "typescript": {
+    "quoteStyle": "alwaysSingle",
+    "jsx.quoteStyle": "preferDouble",
+    "semiColons": "always",
+    "trailingCommas": "onlyMultiLine",
+    "useBraces": "always",
+    "operatorPosition": "maintain",
+    "arrowFunction.useParentheses": "maintain",
+    "module.sortImportDeclarations": "maintain",
+    "importDeclaration.sortNamedImports": "maintain",
+    "importDeclaration.preferSingleLine": false,
+    "exportDeclaration.sortNamedExports": "maintain"
+  },
+  "json": {
+  },
+  "markdown": {
+  },
+  "excludes": [
+    "**/node_modules",
+    "**/*-lock.json",
+    "**/dist",
+    "**/coverage",
+    "jest.config.js",
+    "env.config.*",
+    "example.env.config.*",
+    "module.config.js",
+    "**/messages.{ts,js}"
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/typescript-0.95.15.wasm",
+    "https://plugins.dprint.dev/json-0.21.3.wasm",
+    "https://plugins.dprint.dev/markdown-0.21.1.wasm"
+  ]
+}

Makefile

@@ -0,0 +1,10 @@
+{
+  // For messages files, we allow unlimited line length, to keep the file format consistent.
+  // For now a separate file is required, but this could be simplified when
+  // https://github.com/dprint/dprint/issues/996 is implemented or if we change to a different formatter.
+  "extends": "dprint.json",
+  "lineWidth": 10000,
+  "includes": ["src/**/messages.{ts,js}"]
+  // Because this inherits "excludes" from "dprint.json", it's necessary to use "--excludes-override none"
+  // to run this on the command line.
+}

dprint.json

@@ -1,6 +1,6 @@
 const { createConfig } = require('@openedx/frontend-build');
 
-module.exports = createConfig('jest', {
+const mergedConfig = createConfig('jest', {
   setupFilesAfterEnv: [
     'jest-expect-message',
     '<rootDir>/src/setupTest.js',
@@ -16,6 +16,24 @@ module.exports = createConfig('jest', {
     // This alias is used for plugins in the plugins/ folder only.
     '^CourseAuthoring/(.*)$': '<rootDir>/src/$1',
   },
-  modulePathIgnorePatterns: [
-  ],
+  modulePathIgnorePatterns: [],
 });
+
+// Override ts-jest config: When transforming .ts files to .js for test purposes,
+// don't report TypeScript errors for files in `node_modules/` (or any non-test files).
+// Without this, we were seeing TypeScript errors from
+//   node_modules/@edx/frontend-component-header/dist/studio-header/StudioHeader.tsx
+// cause the tests to fail, because they are included in `transformIgnorePatterns`.
+// -> If you can delete the following lines and the tests still pass, then feel free
+//    to remove this whole override. It's only necessary now while StudioHeader has some
+//    typing issues.
+mergedConfig.transform['^.+\\.[tj]sx?$'] = [
+  'ts-jest',
+  {
+    diagnostics: {
+      exclude: ['!**/*.test.*'],
+    },
+  },
+];
+
+module.exports = mergedConfig;