auto-spy jest code issue - cannot find name jest about scuri

[gparlakov]

Are you using jest for testing?

If not see the documentation for autospy generation

Specifically the commands for different setups and chose what you need.

angular	jest	jasmine	command
5		V	schematics scuri:autospy --legacy
5	V		schematics scuri:autospy --for jest --legacy
6		V	ng g scuri:autospy
6	V		ng g scuri:autospy --for jest
7		V	ng g scuri:autospy
7	V		ng g scuri:autospy --for jest
8		V	ng g scuri:autospy
8	V		ng g scuri:autospy --for jest

Basically for angular 5 and below use --legacy and for jasmine do not add --for jest

[marimendez88]

yes @gparlakov , I am using jest for testing and the file is generated correctly, but inside of it, seems like the type SpyOf is not working and using a private name:

[gparlakov]

It looks like the typing for jest is missing.
How do you include the @types/jest?

[gparlakov]

@marimendez88 hi, did you manage to work out your issue? If so let's close this issue.

[venkatp57]

Hi, i am trying to use scuri in my project and i am getting some compilation issue on auto-spy.ts file

can you please help on this.

[gparlakov]

Hi, Sorry to hear that you're having trouble with Scuri. From reading the TS error I can't get what it's complaining about. I'll have to look deeper into it. In the meantime: what does your environment look like? TS version angular version node version and anything else that might help reproduce this?

…

On Tue, Aug 9, 2022, 18:30 venkatp57 ***@***.***> wrote: Hi, i am trying to use scuri in my project and i am getting some compilation issue on auto-spy.ts file [image: image] <https://user-images.githubusercontent.com/47427540/183692674-f7e2a1ea-af2a-464f-b6de-2bf4d3de7fd7.png> can you please help on this. — Reply to this email directly, view it on GitHub <#107 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AA2SEV2GPXAYRH3F63SJU6TVYJ2RTANCNFSM4USRDF2Q> . You are receiving this because you modified the open/close state.Message ID: ***@***.***>

[venkatp57]

Here are the details

"typescript": "~4.1.5",

[gparlakov]

Hey @venkatp57 I was able to reproduce the issue here -> stackblitz link
(it's a fully working example with the whole setup)

It boils down to telling typescript that we know what we are doing :)

Here's a version of autospy that works as expected on the environment you specified

/** Create an object with methods that are autoSpy-ed to use as mock dependency */
export function autoSpy<T>(obj: new (...args: any[]) => T): SpyOf<T> {
  const res: SpyOf<T> = {} as any;

  // turns out that in target:es2015 the methods attached to the prototype are not enumerable so Object.keys returns []. So to workaround that and keep some backwards compatibility - merge with ownPropertyNames - that disregards the enumerable property.
  // the Set remove duplicate entries
  const keys = new Set([
    ...(Object.keys(obj.prototype) as Array<keyof T>),
    ...(Object.getOwnPropertyNames(obj.prototype) as Array<keyof T>),
  ]);

  keys.forEach((key) => {
    if (typeof key === 'string') {
      (res[key] as any) = jasmine.createSpy(key);
    }
  });

  return res;
}

/** Keeps the types of properties of a type but assigns type of Spy to the methods */
export type SpyOf<T> = T &
  Partial<{
    [k in keyof T]: T[k] extends (...args: any[]) => any ? jasmine.Spy : T[k];
  }>;