'SpecReporter' is not assignable to type 'Reporter | CustomReporter'

[squidfunk]

Issue guidelines

Bug report

Check with "x":

• I have this issue with the latest release of jasmine-spec-reporter
• I have this issue with the latest release of jasmine
• I can reproduce this issue with one of the examples

Current behavior

I'm encountering a type error when configuring the spec reporter, probably related to the latest @types/jasminepackage:

index.ts(91,27): error TS2345: Argument of type 'SpecReporter' is not assignable to parameter of type 'Reporter | CustomReporter'.
  Type 'SpecReporter' is not assignable to type 'CustomReporter'.
    Types of property 'suiteStarted' are incompatible.
      Type '(result: import("node_modules/jasmine-spec-reporter/built/spec-reporter").CustomReporterResult) => void' is not assignable to type '(result: jasmine.CustomReporterResult) => void'.
        Types of parameters 'result' and 'result' are incompatible.
          Type 'jasmine.CustomReporterResult' is not assignable to type 'import("node_modules/jasmine-spec-reporter/built/spec-reporter").CustomReporterResult'.
            Types of property 'duration' are incompatible.
              Type 'number | null' is not assignable to type 'string | undefined'.
                Type 'null' is not assignable to type 'string | undefined'.

Expected behavior

No type error, assignment works as expected.

Minimal reproduction of the problem with instructions

Package versions:

• @types/jasmine: 3.6.6
• jasmine: 3.6.4
• jasmine-spec-reporter: 6.0.0

const jasmine = new Jasmine({})
jasmine.env.clearReporters()
jasmine.env.addReporter(new SpecReporter({
  spec: { displayStacktrace: StacktraceOption.RAW }
}))

Possible fix

Change the typing of duration to number | null here:

jasmine-spec-reporter/src/spec-reporter.ts

Lines 20 to 22 in 8d7bd5f

	export interface CustomReporterResult extends jasmine.CustomReporterResult {
	duration?: string;
	}

[SetupCoding]

As a workaround you can do

import CustomReporter = jasmine.CustomReporter;


jasmine.getEnv().addReporter((new SpecReporter() as unknown) as CustomReporter);

[squidfunk]

Thanks! I just added a @ts-ignore above the line with the same result. This issue was meant as an FYI that the typings might need to be updated 😊

[bcaudan]

Indeed, it seems to have been detected by dependabot as well #585

I'll look into it, thanks for the heads up

[coyoteecd]

@bcaudan any update? I forked and looked at it, but it seems there's quite some changes involved

[bcaudan]

I have started to look into it but I have to look deeper into the spec duration from jasmine to see if there is still a need for jasmine-spec-reporter to compute it as well.
New lockdown starting this weekend for me, so I should come back to it soon 🤞

[coyoteecd]

Covid-19 helping open source development 😁

[bcaudan]

A fix is available in jasmine-spec-reporter@7.0.0

[dominionikpeawujor]

As a workaround you can do

import CustomReporter = jasmine.CustomReporter;


jasmine.getEnv().addReporter((new SpecReporter() as unknown) as CustomReporter);

This saved me after days of debugging. Thank you @SetupCoding