August 2025 maintenance (#35)

* Add `packageManager` field

* Fix formatting on Windows

* Fix format script

* Update Prettier to latest

* Add TS check pragma

* Migrate to ESM

* Update koa to v3

* Deduplicate dependencies

* Migrate ESLint config to ESM

* Fix ESLint issues

* Upgrade ESLint to v8

* Deduplicate dependencies

* Add lint script

* Add .node-version file

* Add CI workflow on GitHub Actions

Author: RichDom2185

.eslintrc.js renamed to .eslintrc.cjs

@@ -1,9 +1,11 @@
+// @ts-check
+/** @type{import('eslint').Linter.LegacyConfig} */
 module.exports = {
   root: true,
   extends: ['eslint:recommended'],
   rules: {
     eqeqeq: ['error', 'always']
   },
-  parserOptions: { ecmaVersion: 11 },
+  parserOptions: { ecmaVersion: 11, sourceType: 'module' },
   env: { es6: true, node: true }
 };

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: Run CI
+on:
+  push:
+    branches:
+      - ng
+  pull_request:
+    branches:
+      - ng
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: yarn
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Run lint
+        run: yarn lint

.node-version

@@ -0,0 +1 @@
+22.14.0

.prettierrc.json

@@ -3,5 +3,6 @@
   "singleQuote": true,
   "printWidth": 100,
   "arrowParens": "always",
-  "trailingComma": "none"
+  "trailingComma": "none",
+  "endOfLine": "auto"
 }

index.js

@@ -1,10 +1,11 @@
-const Koa = require('koa');
-const bodyParser = require('koa-bodyparser');
-const cors = require('@koa/cors');
-const websocket = require('koa-easy-ws');
-const WebSocketJSONStream = require('@teamwork/websocket-json-stream');
-const ShareDB = require('sharedb');
-const uuid = require('uuid').v4;
+// @ts-check
+import cors from '@koa/cors';
+import WebSocketJSONStream from '@teamwork/websocket-json-stream';
+import Koa from 'koa';
+import bodyParser from 'koa-bodyparser';
+import websocket from 'koa-easy-ws';
+import ShareDB from 'sharedb';
+import { v4 as uuid } from 'uuid';
 
 const COLLECTION_NAME = 'sa';
 

package.json

@@ -2,27 +2,30 @@
   "name": "sharedb-ace-backend",
   "version": "0.0.1",
   "description": "ShareDB-powered backend for collaborative editing in the Source Academy.",
+  "type": "module",
   "main": "index.js",
   "repository": "https://github.com/source-academy/sharedb-ace-backend",
   "license": "Apache-2.0",
   "private": true,
   "scripts": {
     "eslint": "eslint index.js",
-    "format": "eslint --fix index.js && prettier index.js",
+    "format": "eslint --fix index.js && prettier --write index.js",
+    "lint": "eslint --report-unused-disable-directives --max-warnings 0 index.js && prettier --check index.js",
     "start": "node index.js"
   },
+  "packageManager": "[email protected]+sha1.ac34549e6aa8e7ead463a7407e1c7390f61a6610",
   "dependencies": {
     "@koa/cors": "^5.0.0",
     "@teamwork/websocket-json-stream": "^2.0.0",
-    "koa": "^2.16.1",
+    "koa": "^3.0.1",
     "koa-bodyparser": "^4.4.1",
     "koa-easy-ws": "^2.1.0",
     "sharedb": "^5.1.1",
     "uuid": "^11.1.0",
     "ws": "^8.18.0"
   },
   "devDependencies": {
-    "eslint": "^7.6.0",
-    "prettier": "2.1.2"
+    "eslint": "^8.57.1",
+    "prettier": "^3.6.2"
   }
 }