Question: Including typings for plugins (i.e. assert) about runner

[Julien-R44]

I guess this is a problem related to your tsconfig. Probably moduleResolution : it should be set to at least Node16

Otherwise, please share your tsconfig.json

[malthe]

This is my tsconfig.json:

{
    "compilerOptions": {
        "moduleResolution": "node16",
        "target": "es2022",
        "module": "node16",
        "lib": [
            "es2019",
            "esnext.asynciterable",
            "esnext.bigint"
        ],
        "strict": true,
        "sourceMap": true,
        "inlineSourceMap": false,
        "declaration": true,
        "allowSyntheticDefaultImports": true,
        "experimentalDecorators": true,
        "emitDecoratorMetadata": true,
        "noImplicitAny": true,
        "noUnusedParameters": true,
        "noUnusedLocals": true,
        "declarationDir": "dist",
        "allowImportingTsExtensions": true,
        "noEmit": true,
        "outDir": "dist"
    },
    "include": [
        "src",
        "tests"
    ]
}

The error message:

~/co/ts-postgres$ npx tsc                                                                       2🚫
tests/hello.test.ts:8:28 - error TS2339: Property 'assert' does not exist on type 'TestContext'.

8 test('add two numbers', ({ assert }: TestContext) => {
                             ~~~~~~


Found 1 error in tests/hello.test.ts:8

[Julien-R44]

Thanks!
where is your test.ts file located? i'm talking about the file that contains this:

import { configure, processCLIArgs, run } from '@japa/runner'
import { assert } from '@japa/assert'
import { expect } from '@japa/expect'

processCLIArgs(process.argv.splice(2))
configure({
  files: ['tests/**/*.spec.ts'],
  plugins: [assert(), expect()],
})

run()

If you keep the default location, it should be in ./bin/test.ts. And if this is the case, you need to include it in your include tsconfig :

{
    "compilerOptions" : {
      // ....
    },
    "include" : [
        "bin", // Here 
        "src",
        "tests"
    ]
}

Otherwise, the module augmentation performed by importing @japa/assert will not be effective

[malthe]

Adding "bin" (where my "test.ts" file resides) actually does not change anything. Nor does using "node16" as the module resolution setting.

[Julien-R44]

Did you tried restarting the typescript server / editor after updating that ? ( I am pretty sure this is the solution )

Otherwise, can you provide a reproduction repo please?

[malthe]

@Julien-R44 see https://github.com/malthe/japa-runner/tree/typing-issue – thanks!

[Julien-R44]

It works just fine for me dude :

So yeah, i believe this was related to include.

[malthe]

I set up a workflow to run via GitHub Actions on that same repo.

Here's a run that demonstrates the error: https://github.com/malthe/japa-runner/actions/runs/7293525876/job/19876751955.

[Julien-R44]

You need to remove the TestContext annotation on this line : https://github.com/malthe/japa-runner/blob/1261dd00584b4594c2ac911297df71ff67be57a1/tests/math.test.ts#L8

You don't need it. This should works :

test('add two numbers', ({ assert }) => {
  assert.equal(sum(2, 2), 4)
})

And, if ever you need it the augmented TestContext type, you should import it through @japa/runner/core not @japa/core

+ import type { TestContext } from '@japa/runner/core';
- import type { TestContext } from '@japa/core';

[malthe]

Thanks – works beautifully 🎄