typeScript.test.ts

import * as prettier from "prettier";
import { AllOptions } from "../src/types";

function subject(code: string, options: Partial<AllOptions> = {}) {
  return prettier.format(code, {
    parser: "typescript",
    plugins: ["prettier-plugin-jsdoc"],
    jsdocSpaces: 1,
    ...options,
  } as AllOptions);
}

test("JS code should be formatted as usuall", async () => {
  const result = await subject(`
  /**
 @typedef {
    {
        "userId": string,
        "title": string,
        "profileImageLink": string,
        "identityStatus": "None",
        "isBusinessUser": boolean,
        "isResellerUser": boolean,
        "isSubUser": boolean,
        "shareCode": number,
        "referredBy": string,
        "businessName": string,
        "businessUserId": string,
        "nationalCode": string,
        "state": string,
        "city": string,
        "address": string,
        "phoneNumber": string
      }
     } User
     */
  export let User

  /**
     @typedef {
      {
        "domainId": 0,
        persianName: string,
        "englishName": string, // comment
        "resellerUserId": string,
        "isActive": true,
        "logoFileUniqueId": string,
        "logoFileName": string,
        "logoFileUrl": string,
        "domainPersianName": string,
        "domainEnglishName": string,
        "resellerUserDisplayName": string,
        "about": string
      }
     } SubDomain
     */

    /**
     @typedef {
      () => a.b
     } SubDomain
     */
    `);

  expect(result).toMatchSnapshot();
});

test("hoisted object", async () => {
  const result = await subject(`
  /**
 @typedef {
    {
        "userId": {
        title: string,
        "profileImageLink": *,
        "identityStatus": "None",
        "isBusinessUser": "isResellerUser"|"isBoolean"|  "isSubUser" |    "isNot",
        "shareCode": number,
        "referredBy": any,
        },
        id:number
      }
     } User
     */

    `);

  expect(result).toMatchSnapshot();
});

test("max width challenge", async () => {
  const result = await subject(
    `
class test {
  /**
   * Replaces text in a string, using a regular expression or search string.
   * @param {string | RegExp} searchValue A string to search for.
   * @param {string | (substring: string, ...args: any[]) => string} replaceValue A string containing the text to replace for every successful match of searchValue in this string.
   * @param {string | (substring: string, ...args: any[]) => string} A_big_string_for_test A string containing the text to replace for every successful match of searchValue in this string.
   * @param {string | (substring: string, ...args: any[]) => string} replaceValue A_big_string_for_test string containing the text to replace for every successful match of searchValue in this string.
   * @param {string | (substring: string, ...args: any[]) => string} A_big_string_for_test A_big_string_for_test string containing the text to replace for every successful match of searchValue in this string.
   * @returns {StarkStringType & NativeString}
   */
  replace(searchValue, replaceValue) {
    class test{
      /**
     * Replaces text in a string, using a regular expression or search string.
     *
     * @param {string | RegExp} searchValue A string to search for.
     * @param {string | (substring: string, ...args: any[]) => string} replaceValue
     *     A string containing the text to replace for every successful match of
     *     searchValue in this string.
     * @param {string | (substring: string, ...args: any[]) => string} A_big_string_for_test
     *     A string containing the text to replace for every successful match of searchValue
     *     in this string.
     * @param {string | (substring: string, ...args: any[]) => string} replaceValue
     *     A_big_string_for_test string containing the text to replace for every
     *     successful match of searchValue in this string.
     * @param {string | (substring: string, ...args: any[]) => string} A_big_string_for_test
     *     A_big_string_for_test string containing the text to replace for every successful
     *     match of searchValue in this string.
     * @returns {StarkStringType & NativeString}
     */
        testFunction(){

        }
      }

    this._value = this._value.replace(searchValue, replaceValue);
    return this;
  }
}
`,
  );

  expect(result).toMatchSnapshot();
});

test("description in interface", async () => {
  const result = await subject(
    `
export interface FetchCallbackResponseArray<T, V> {
  resource: Resource<T>;
      /**
       * @deprecated Resolve clear with condition in your fetch api this function will be remove
       */
  refetch: (...arg: V[]) => void;
  /**
   * @deprecated Resolve clear with condition in your fetch api this function will be remove
   */
  clear: () => void;
}
`,
  );

  expect(await subject(await subject(result))).toMatchSnapshot();
});

test("Default export", async () => {
  const result = await subject(`
/**
 * @typedef {import("Foo")} Foo
 */
`);

  expect(result).toMatchSnapshot();
});

test("Union types", async () => {
  const result = await subject(`
/**
 * @typedef {{ foo: string } | { bar: string; manyMoreLongArguments: object } | { baz: string }} Foo
 */
`);

  expect(result).toMatchSnapshot();
});

test("Long type Union types", async () => {
  const result = await subject(`
  /**
   * Gets a configuration object assembled from environment variables and .env configuration files.
   *
   * @memberof Config
   * @function getEnvConfig
   * @returns {Config.SomeConfiguration | Config.SomeOtherConfiguration | Config.AnotherConfiguration | Config.YetAnotherConfiguration } The environment configuration
   */
  export default () => configurator.config;
`);

  expect(result).toMatchSnapshot();
});

test("type imports", async () => {
  const result = await subject(
    `
/**
 * @import BM, { B as B1,
 * B2   , B4 } from 'moduleb'
 * @typedef {Object} Foo
 * @import BMain, {B3  } from "moduleb"
 * @import {A} from 'modulea'
 */
/**
 * @import BDefault, {        B5 } from   'moduleb'
 * @import C    from    "modulec"
 */
    `,
  );

  expect(result).toMatchSnapshot();
});