Typescript Conversion

.github/workflows/ci.yml

@@ -24,14 +24,16 @@ jobs:
       - name: Run lint
         run: npm run lint
       - name: Run tests
-        run: npm test -- --ci --coverage --runInBand
+        run:
+          npm run test -- --coverage --reporter=junit
+          --outputFile='./junit-report.xml'
       - name: Upload test reports
         uses: actions/upload-artifact@v4
         with:
           name: test-reports-${{ matrix.node-version }}
-          path: test/reports
+          path: ./junit-report.xml
       - name: Upload test coverage
         uses: actions/upload-artifact@v4
         with:
           name: test-coverage-${{ matrix.node-version }}
-          path: test/coverage
+          path: coverage

.gitignore

@@ -1,6 +1,9 @@
 # npm
 /node_modules
 
-# Jest
-/test/coverage
-/test/reports
+# Vitest
+/coverage
+junit-report.xml
+
+# Build output
+/dist

.vscode/tasks.json

@@ -0,0 +1,14 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Build TypeScript",
+      "type": "shell",
+      "command": "tsc",
+      "args": [],
+      "isBackground": false,
+      "problemMatcher": ["$tsc"],
+      "group": "build"
+    }
+  ]
+}

DOCS.md

@@ -25,7 +25,7 @@ anyone can build their own adapter.
 To define a querier, simply extend `QueryQL` with your own class:
 
 ```js
-const QueryQL = require('@truepic/queryql')
+import QueryQL from '@truepic/queryql'
 
 class UserQuerier extends QueryQL {
   defineSchema(schema) {
@@ -115,9 +115,9 @@ These defaults, however, can easily be changed for all querier instances. For
 example, to use a different adapter:
 
 ```js
-const { Config } = require('@truepic/queryql')
+import { Config } from '@truepic/queryql'
 
-const MyAdapter = require('./my_adapter')
+import MyAdapter from './my_adapter'
 
 Config.defaults = {
   adapter: MyAdapter,
@@ -133,7 +133,7 @@ A config can also be passed as the third argument when creating an instance of a
 querier:
 
 ```js
-const MyAdapter = require('./my_adapter')
+import MyAdapter from './my_adapter'
 
 const querier = new UserQuerier(query, builder, {
   adapter: MyAdapter,
@@ -544,7 +544,9 @@ include any additional fields or functions.
 `ValidationError` is exported to make it easy to check for an instance of one:
 
 ```js
-const { ValidationError } = require('@truepic/queryql').errors
+import { errors } from '@truepic/queryql'
+
+const { ValidationError } = errors
 
 const querier = new UserQuerier(query, builder)
 let users

README.md

@@ -65,7 +65,7 @@ allowed through what we call a _querier_. Here's how one might look for the
 `/images` endpoint:
 
 ```js
-const QueryQL = require('@truepic/queryql')
+import QueryQL from '@truepic/queryql'
 
 class ImageQuerier extends QueryQL {
   defineSchema(schema) {

eslint.config.mjs

@@ -0,0 +1,28 @@
+import js from '@eslint/js'
+import vitest from '@vitest/eslint-plugin'
+import ts from 'typescript-eslint'
+
+export default ts.config(
+  // JS recommended rules (keeps JS files covered)
+  js.configs.recommended,
+  ts.configs.recommended,
+
+  // Vitest for test files
+  {
+    files: [
+      'src/**/*.test.ts',
+      'src/**/*.test.tsx',
+      'src/**/__tests__/**/*.ts',
+    ],
+    plugins: {
+      vitest,
+    },
+    rules: {
+      ...vitest.configs.recommended.rules,
+    },
+  },
+
+  {
+    ignores: ['dist/**', 'node_modules/**', 'coverage/**'],
+  },
+)

jest.config.js

@@ -1,4 +1,8 @@
-module.exports = {
+export default {
+  // Use ts-jest to transform TypeScript tests
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+
   coverageDirectory: './test/coverage',
   reporters: [
     'default',
@@ -9,5 +13,15 @@ module.exports = {
       },
     ],
   ],
-  testPathIgnorePatterns: ['/node_modules/', '/test/'],
+
+  // Ignore the top-level `test` folder used for test fixtures, node_modules,
+  // and compiled `dist` directory so we only run source tests.
+  testPathIgnorePatterns: ['/node_modules/', '/test/', '/dist/'],
+
+  // Transform TypeScript files with ts-jest
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
 }