add JSDoc to Vitest code

[yukulele]

Clear and concise description of the problem

Vitest functions have little or no documentation in the code, making them difficult to use and adopt.

This is what the editor shows me:

and this is what I hope to see:

Suggested solution

add JSDoc to Vitest code

Alternative

I have to go to the documentation every time I'm not sure how to use a function :/

Additional context

No response

Validations

• Follow our Code of Conduct
• Read the Contributing Guidelines.
• Read the docs.
• Check that there isn't already an issue that request the same feature to avoid creating a duplicate.

[geeksilva97]

hey folks, I'd like to take a look on it to get familiarized with the project. would you guys have any clue? I've been searching for where jsdocs are added in expect packages but I could not find yet.

[hi-ogawa]

You can add jsdoc to the type definition here

vitest/packages/expect/src/types.ts

Lines 116 to 164 in f969fb0

	export interface JestAssertion<T = any> extends jest.Matchers<void, T> {
	// Jest compact
	toEqual: <E>(expected: E) => void
	toStrictEqual: <E>(expected: E) => void
	toBe: <E>(expected: E) => void
	toMatch: (expected: string | RegExp) => void
	toMatchObject: <E extends {} | any[]>(expected: E) => void
	toContain: <E>(item: E) => void
	toContainEqual: <E>(item: E) => void
	toBeTruthy: () => void
	toBeFalsy: () => void
	toBeGreaterThan: (num: number | bigint) => void
	toBeGreaterThanOrEqual: (num: number | bigint) => void
	toBeLessThan: (num: number | bigint) => void
	toBeLessThanOrEqual: (num: number | bigint) => void
	toBeNaN: () => void
	toBeUndefined: () => void
	toBeNull: () => void
	toBeDefined: () => void
	toBeInstanceOf: <E>(expected: E) => void
	toBeCalledTimes: (times: number) => void
	toHaveLength: (length: number) => void
	toHaveProperty: <E>(
	property: string | (string | number)[],
	value?: E
	) => void
	toBeCloseTo: (number: number, numDigits?: number) => void
	toHaveBeenCalledTimes: (times: number) => void
	toHaveBeenCalled: () => void
	toBeCalled: () => void
	toHaveBeenCalledWith: <E extends any[]>(...args: E) => void
	toBeCalledWith: <E extends any[]>(...args: E) => void
	toHaveBeenNthCalledWith: <E extends any[]>(n: number, ...args: E) => void
	nthCalledWith: <E extends any[]>(nthCall: number, ...args: E) => void
	toHaveBeenLastCalledWith: <E extends any[]>(...args: E) => void
	lastCalledWith: <E extends any[]>(...args: E) => void
	toThrow: (expected?: string | Constructable | RegExp | Error) => void
	toThrowError: (expected?: string | Constructable | RegExp | Error) => void
	toReturn: () => void
	toHaveReturned: () => void
	toReturnTimes: (times: number) => void
	toHaveReturnedTimes: (times: number) => void
	toReturnWith: <E>(value: E) => void
	toHaveReturnedWith: <E>(value: E) => void
	toHaveLastReturnedWith: <E>(value: E) => void
	lastReturnedWith: <E>(value: E) => void
	toHaveNthReturnedWith: <E>(nthCall: number, value: E) => void
	nthReturnedWith: <E>(nthCall: number, value: E) => void
	}

For example,

  /**
   * write something...
   * @example
   *   expect("xxx").toEqual("xxx") // OK
   */
  toEqual: <E>(expected: E) => void

[geeksilva97]

Thanks a lot man!