Static Typing with TypeScript (WIP)

.eslintrc.cjs

@@ -0,0 +1,42 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+const { getBaseConfig } = require('@edx/frontend-build');
+
+const config = getBaseConfig('eslint');
+
+// Enable the eslint-plugin-jsdoc plugin
+config.extends = ['@edx/eslint-config', 'plugin:jsdoc/recommended-typescript-flavor'];
+config.plugins = [...(config.plugins ?? []), 'jsdoc'];
+config.settings = {
+  ...config.settings,
+  jsdoc: { mode: 'typescript', preferredTypes: { object: 'Object' } },
+};
+
+config.rules = {
+  'import/no-extraneous-dependencies': ['error', {
+    devDependencies: [
+      '**/*.config.js',
+      '**/*.test.jsx',
+      '**/*.test.js',
+      'example/*',
+    ],
+  }],
+  'import/extensions': ['error', 'always', {
+    ignorePackages: true,
+  }],
+  'import/no-unresolved': ['error', {
+    ignore: ['@edx/frontend-platform*'],
+  }],
+  'jsx-a11y/anchor-is-valid': ['error', {
+    components: ['Link'],
+    specialLink: ['to'],
+    aspects: ['noHref', 'invalidHref', 'preferButton'],
+  }],
+  // There are too many missing descriptions to turn this on at the moment :/
+  'jsdoc/require-property-description': ['off'],
+  'jsdoc/require-param-description': ['off'],
+  'jsdoc/require-returns-description': ['off'],
+  'jsdoc/check-types': ['warn'],
+  'jsdoc/tag-lines': ['off'],
+};
+
+module.exports = config;

.gitignore

@@ -3,6 +3,7 @@
 .vscode
 coverage
 dist
+types
 node_modules
 /docs/api
 .env.private

Makefile

@@ -4,14 +4,8 @@ doc_command = ./node_modules/.bin/documentation build src -g -c ./docs/documenta
 cat_docs_command = cat ./docs/_API-header.md ./docs/_API-body.md > ./docs/API.md
 
 build:
-	rm -rf ./dist
-	./node_modules/.bin/fedx-scripts babel src --out-dir dist --source-maps --ignore **/*.test.jsx,**/*.test.js,**/setupTest.js --copy-files
-	@# --copy-files will bring in everything else that wasn't processed by babel. Remove what we don't want.
-	@find dist -name '*.test.js*' -delete
-	rm ./dist/setupTest.js
-	cp ./package.json ./dist/package.json
-	cp ./LICENSE ./dist/LICENSE
-	cp ./README.md ./dist/README.md
+	rm -rf types/*
+	npx tsc
 
 docs-build:
 	${doc_command}