prettier-plugin-jsdoc/tests/default.test.ts at master · fardad-dev/prettier-plugin-jsdoc · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
import * as prettier from "prettier";
import { AllOptions } from "../src/types";

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

test("default string with description", async () => {
  const result = await subject(`
  /**
   * The summary
   *
   * @default "type" description
   */
`);

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

test("convert double quote @default to single quote", async () => {
  const result = await subject(
    `
  /**
   * The summary
   *
   * @default "value"
   */
`,
    { singleQuote: true },
  );

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

test("convert single quote @default to double quote", async () => {
  const result = await subject(
    `
  /**
   * The summary
   *
   * @default 'value'
   */
`,
    { singleQuote: false },
  );

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

test("Can't convert double quote @default if a single quote character is in the string", async () => {
  const result = await subject(
    `
  /**
   * The summary
   *
   * @default "This isn't bad"
   */
`,
    { singleQuote: true },
  );

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

test("default empty array", async () => {
  const input = `
  /**
   * The summary
   *
   * @default []
   */
`;
  const result = await subject(input);

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

test("default empty object", async () => {
  const input = `
  /**
   * The summary
   *
   * @default {}
   */
`;
  const result = await subject(input);

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

test("empty default tag", async () => {
  const input = `
  /**
   * The summary
   *
   * @default
   */
`;
  const result = await subject(input);

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

["default", "defaultValue"].forEach((tag: string) => {
  test(`@${tag} filled array`, async () => {
    const input = `
    /**
     * The summary
     *
     * @${tag} [1,'two',{three:true},['four']]
     */
  `;
    const result = await subject(input);

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

  test(`@${tag} filled object`, async () => {
    const input = `
    /**
     * The summary
     *
     * @${tag} {object:'value',nestingTest:{obj:'nested'}}
     */
  `;
    const result = await subject(input);

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

test("double default one", async () => {
  const input = `
  /**
   * The summary
   *
   * @default "something"
   * @default {}
   */
`;
  const result = await subject(input);

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

test("double default two", async () => {
  const input = `
  /**
   * The summary
   *
   * @default {}
   * @default "something"
   */
`;
  const result = await subject(input);

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

test("Single line codegen", async () => {
  const result = await subject(
    `
    /** @default codegen */
`,
  );

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

test("Multi line codegen", async () => {
  const result = await subject(
    `
    /**
     * @default codegen
     */
`,
  );

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

test("code in default", async () => {
  const result = await subject(
    `/**
     * The path to the config file or directory contains the config file.
     *
     * @default process.cwd()
     */
`,
  );

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