Migrate to Typescript

.github/workflows/node.js.yml

@@ -10,6 +10,22 @@ on:
     branches: [ "master" ]
 
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        node-version: [ 22.x ]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'npm'
+      - run: npm ci
+      - run: npm run build
+
   test:
     runs-on: ubuntu-latest
     strategy:
@@ -24,6 +40,7 @@ jobs:
         node-version: ${{ matrix.node-version }}
         cache: 'npm'
     - run: npm ci
+    - run: npm run build
     - run: npm test
 
   smoke-test-stolaf:
@@ -40,6 +57,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - run: npm ci
+      - run: npm run build
       - run: npm run test-stolaf-college
 
   smoke-test-carleton:
@@ -56,6 +74,7 @@ jobs:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
       - run: npm ci
+      - run: npm run build
       - run: npm run test-carleton-college
 
   lint:

.gitignore

@@ -14,3 +14,7 @@
 # Logs
 *.log
 npm-debug.log*
+
+# Typescript
+/.tsbuildinfo
+/dist/

Dockerfile

@@ -1,19 +1,35 @@
-FROM node:22-alpine
+FROM node:22-alpine AS modules_dev
+WORKDIR /app
 
-RUN apk add -U curl
+COPY --link ./package.json ./package-lock.json ./
+RUN npm ci
 
-WORKDIR /app
-COPY ./package.json ./package-lock.json ./
 
+FROM modules_dev AS modules
 RUN npm ci --omit=dev
 
-HEALTHCHECK --interval=20s --timeout=1s \
-  CMD curl -f http://localhost:80/ping
 
-COPY ./source ./source
+FROM modules_dev AS build
+COPY --link tsconfig.json .
+COPY --link ./source ./source
+COPY --link ./types ./types
+RUN npm run build
+
+
+FROM node:22-alpine AS runtime
+WORKDIR /app
+
+RUN apk add -U curl
+
+COPY --link ./package.json ./package-lock.json ./
+COPY --link --from=modules /app/node_modules ./node_modules
+COPY --link --from=build /app/dist ./dist
 
 ENV NODE_ENV=production
 ENV NODE_PORT=80
 ENV INSTITUTION=unknown
 
-CMD node -r dotenv/config ./source/ccc-server/index.js
+HEALTHCHECK --interval=20s --timeout=1s \
+  CMD curl -f http://localhost:80/ping
+
+CMD node ./dist/source/ccc-server/index.js

eslint.config.js

@@ -2,22 +2,29 @@ import js from '@eslint/js'
 import globals from 'globals'
 
 import prettier from 'eslint-config-prettier'
+import ts from 'typescript-eslint'
 
+/** @type {import('@typescript-eslint/utils').TSESLint.FlatConfig.ConfigFile} */
 export default [
 	js.configs.recommended,
+	...ts.configs.strictTypeChecked,
+	...ts.configs.stylisticTypeChecked,
 	prettier,
 	{
 		languageOptions: {
 			ecmaVersion: 'latest',
 			sourceType: 'module',
 			globals: {...globals.node},
+			parserOptions: {
+				project: true,
+				tsconfigRoot: import.meta.dirname,
+			},
 		},
 		rules: {
 			'array-callback-return': 'error',
 			camelcase: ['warn', {properties: 'never', ignoreDestructuring: true}],
 			'consistent-this': ['error', 'self'],
 			curly: ['warn', 'multi-line'],
-			'default-case': 'error',
 			'guard-for-in': 'error',
 			eqeqeq: ['error', 'always', {null: 'ignore'}],
 			'linebreak-style': ['error', 'unix'],
@@ -29,10 +36,7 @@ export default [
 			'no-div-regex': 'error',
 			'no-eq-null': 'warn',
 			'no-extra-label': 'error',
-			'no-implicit-coercion': [
-				'error',
-				{boolean: true, number: true, string: true},
-			],
+			'no-implicit-coercion': ['error', {boolean: true, number: true, string: true}],
 			'no-implicit-globals': 'error',
 			'no-multi-assign': 'error',
 			'no-new-symbol': 'error',
@@ -42,14 +46,25 @@ export default [
 			'no-undef-init': 'off',
 			'no-underscore-dangle': 'off',
 			'no-unmodified-loop-condition': 'error',
-			'no-unused-vars': ['warn', {args: 'after-used', argsIgnorePattern: '^_'}],
+			'@typescript-eslint/no-unused-vars': ['warn', {args: 'after-used', argsIgnorePattern: '^_'}],
 			'no-useless-constructor': 'error',
 			'no-var': 'error',
+			'prefer-const': 'off',
 			'prefer-promise-reject-errors': 'error',
 			'prefer-spread': 'error',
 			quotes: ['warn', 'single', 'avoid-escape'],
 			'require-await': 'warn',
 			semi: 'off',
+
+			// conflicts with the noPropertyAccessFromIndexSignature tsconfig rule
+			'@typescript-eslint/dot-notation': ['error', {allowIndexSignaturePropertyAccess: true}],
 		},
 	},
+	{
+		files: ['**/*.js'],
+		...ts.configs.disableTypeChecked,
+	},
+	{
+		ignores: ['dist/*'],
+	},
 ]