feat!: typescript configuration and jest v29 upgrade

.github/workflows/commitlint.yml

@@ -7,4 +7,14 @@ on:
 
 jobs:
   commitlint:
-    uses: openedx/.github/.github/workflows/commitlint.yml@master
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: remove tsconfig.json # see issue https://github.com/conventional-changelog/commitlint/issues/3256
+        run: |
+          rm tsconfig.json
+      - name: Check commits
+        uses: wagoid/commitlint-github-action@v5

README.md

@@ -218,6 +218,25 @@ locally. To serve a production build locally:
     attempt to run the build on the same port specified in the
     `env.config.js` file.
 
+## Local module configuration for TypeScript
+
+#. Create file in repository `tsconfig.json`, with a clause `"extends": "@openedx/frontend-build"`
+#. Set "rootDir" to the root of the source code folders
+#. Set "include" to wildcard patterns specifying the subdirectories/files under rootDir where source code can be found
+#. Include any wildcards under rootDir that should be excluded using "exclude"
+
+```Sample json
+{
+  "extends": "@openedx/frontend-build",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["dist", "node_modules"]
+}
+```
+
 ## Development
 
 This project leverages the command line interface for webpack, jest,

config/.eslintrc.js

@@ -2,7 +2,8 @@ const { babel } = require('../lib/presets');
 
 module.exports = {
   extends: '@edx/eslint-config',
-  parser: '@babel/eslint-parser',
+  plugins: ['@typescript-eslint'],
+  parser: '@typescript-eslint/parser',
   parserOptions: {
     requireConfigFile: true,
     babelOptions: {

config/jest.config.js

@@ -1,5 +1,6 @@
 const path = require('path');
 const fs = require('fs');
+const { jsWithTs: tsjPreset } = require('ts-jest/presets');
 
 const presets = require('../lib/presets');
 
@@ -11,7 +12,10 @@ if (fs.existsSync(appEnvConfigPath)) {
 }
 
 module.exports = {
-  testURL: 'http://localhost/',
+  testEnvironment: 'jsdom',
+  testEnvironmentOptions: {
+    url: 'http://localhost/',
+  },
   setupFiles: [
     path.resolve(__dirname, 'jest/setupTest.js'),
   ],
@@ -33,11 +37,12 @@ module.exports = {
     '/node_modules/(?!@(open)?edx)',
   ],
   transform: {
-    '^.+\\.[t|j]sx?$': [
+    '^.+\\.jsx?$': [
       'babel-jest',
       {
         configFile: presets.babel.resolvedFilepath,
       },
     ],
+    ...tsjPreset.transform,
   },
 };

config/webpack.common.config.js

@@ -17,7 +17,7 @@ module.exports = {
       // the application being built.
       'env.config': false,
     },
-    extensions: ['.js', '.jsx'],
+    extensions: ['.js', '.jsx', '.ts', '.tsx'],
   },
   ignoreWarnings: [
     // Ignore warnings raised by source-map-loader.

config/webpack.prod.config.js

@@ -70,12 +70,12 @@ module.exports = merge(commonConfig, {
       // The babel-loader transforms newer ES2015+ syntax to older ES5 for older browsers.
       // Babel is configured with the .babelrc file at the root of the project.
       {
-        test: /\.(js|jsx)$/,
+        test: /\.(js|jsx|ts|tsx)$/,
         exclude: /node_modules\/(?!@(open)?edx)/,
         use: {
           loader: 'babel-loader',
           options: {
-            configFile: presets.babel.resolvedFilepath,
+            configFile: presets['babel-typescript'].resolvedFilepath,
           },
         },
       },

example/src/App.jsx

@@ -1,4 +1,5 @@
 import config from 'env.config';
+import Image from './Image';
 import appleUrl, { ReactComponent as Apple } from './apple.svg';
 import appleImg from './apple.jpg';
 
@@ -19,6 +20,8 @@ export default function App() {
       </ul>
       <h2>JSX parsing tests</h2>
       <Apple style={{ width: '10rem' }} />
+      <h2>TSX parsing tests</h2>
+      <Image src={appleUrl} alt="appleFromTsx" style={{ width: '10rem' }} />
       <h2>Asset import tests</h2>
       <img src={appleUrl} alt="apple" style={{ width: '10rem' }} />
       <img src={appleUrl} alt="apple" style={{ width: '10rem' }} />

example/src/Image.tsx

@@ -0,0 +1,16 @@
+import React, { CSSProperties } from 'react';
+
+type ImageProps = {
+  src: string;
+  alt?: string;
+  style?: CSSProperties;
+};
+
+const Image = ({ alt, ...rest }:ImageProps) => <img alt={alt} {...rest} />;
+
+const defaultProps = {
+  alt: undefined,
+  style: undefined,
+};
+Image.defaultProps = defaultProps;
+export default Image;

example/src/__snapshots__/App.test.jsx.snap

@@ -34,7 +34,19 @@ exports[`Basic test should render 1`] = `
   </h2>
   <IconMock
     style={
-      Object {
+      {
+        "width": "10rem",
+      }
+    }
+  />
+  <h2>
+    TSX parsing tests
+  </h2>
+  <img
+    alt="appleFromTsx"
+    src="icon/mock/path"
+    style={
+      {
         "width": "10rem",
       }
     }
@@ -46,7 +58,7 @@ exports[`Basic test should render 1`] = `
     alt="apple"
     src="icon/mock/path"
     style={
-      Object {
+      {
         "width": "10rem",
       }
     }
@@ -55,7 +67,7 @@ exports[`Basic test should render 1`] = `
     alt="apple"
     src="icon/mock/path"
     style={
-      Object {
+      {
         "width": "10rem",
       }
     }
@@ -65,7 +77,7 @@ exports[`Basic test should render 1`] = `
     alt="apple"
     src="test-file-stub"
     style={
-      Object {
+      {
         "width": "10rem",
       }
     }

example/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "dist"
+  },
+  "include": [
+    ".eslintrc.js",
+    "env.config.js",
+    "src"
+  ],
+  "exclude": [
+    "node_modules",
+    "dist",
+  ]
+}