doc-kit/src/linter/rules/__tests__/missing-introduced-in.test.mjs at b56c5409fd2420c89a1aba3c85c55e2e8b5f69d4 · nodejs/doc-kit · 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
import { deepStrictEqual, strictEqual } from 'node:assert';
import { describe, it, mock } from 'node:test';

import { missingIntroducedIn } from '../../rules/missing-introduced-in.mjs';

describe('missingIntroducedIn', () => {
  it('should not report if the introduced_in field is not missing', () => {
    const context = {
      tree: {
        type: 'root',
        children: [
          {
            type: 'html',
            value: '<!--introduced_in=12.0.0-->',
          },
        ],
      },
      report: mock.fn(),
      getIssues: mock.fn(),
    };

    missingIntroducedIn(context);

    strictEqual(context.report.mock.callCount(), 0);
  });

  it('should report an issue if the introduced_in field is missing in the first entry', () => {
    const context = {
      tree: {
        type: 'root',
        children: [
          {
            type: 'heading',
            depth: 2,
          },
          {
            type: 'html',
            value: '<!--introduced_in=12.0.0-->',
          },
        ],
      },
      report: mock.fn(),
      getIssues: mock.fn(),
    };

    missingIntroducedIn(context);

    strictEqual(context.report.mock.callCount(), 1);

    const call = context.report.mock.calls[0];

    deepStrictEqual(call.arguments, [
      {
        level: 'info',
        message: "Missing 'introduced_in' field in the API doc entry",
      },
    ]);
  });

  it('should report an issue if the introduced_in property is missing', () => {
    const context = {
      tree: {
        type: 'root',
        children: [],
      },
      report: mock.fn(),
      getIssues: mock.fn(),
    };

    missingIntroducedIn(context);

    strictEqual(context.report.mock.callCount(), 1);

    const call = context.report.mock.calls[0];

    deepStrictEqual(call.arguments, [
      {
        level: 'info',
        message: "Missing 'introduced_in' field in the API doc entry",
      },
    ]);
  });
});