test: create reporters tests

Author: araujogui

src/linter/reporters/console.mjs

@@ -21,10 +21,10 @@ export default issue => {
     ? ` (${issue.location.position.start.line}:${issue.location.position.end.line})`
     : '';
 
-  console.log(
+  process.stdout.write(
     styleText(
       levelToColorMap[issue.level],
       `${issue.message} at ${issue.location.path}${position}`
-    )
+    ) + '\n'
   );
 };

src/linter/tests/fixtures/issues.mjs

@@ -0,0 +1,36 @@
+// @ts-check
+
+/**
+ * @type {import('../../types').LintIssue}
+ */
+export const infoIssue = {
+  level: 'info',
+  location: {
+    path: 'doc/api/test.md',
+  },
+  message: 'This is a INFO issue',
+};
+
+/**
+ * @type {import('../../types').LintIssue}
+ */
+export const warnIssue = {
+  level: 'warn',
+  location: {
+    path: 'doc/api/test.md',
+    position: { start: { line: 1, column: 1 }, end: { line: 1, column: 2 } },
+  },
+  message: 'This is a WARN issue',
+};
+
+/**
+ * @type {import('../../types').LintIssue}
+ */
+export const errorIssue = {
+  level: 'error',
+  location: {
+    path: 'doc/api/test.md',
+    position: { start: { line: 1, column: 1 }, end: { line: 1, column: 2 } },
+  },
+  message: 'This is a ERROR issue',
+};

src/linter/tests/reporters/console.test.mjs

@@ -0,0 +1,26 @@
+import { describe, it } from 'node:test';
+import console from '../../reporters/console.mjs';
+import assert from 'node:assert';
+import { errorIssue, infoIssue, warnIssue } from '../fixtures/issues.mjs';
+
+describe('console', () => {
+  it('should write to stdout with the correct colors based on the issue level', t => {
+    t.mock.method(process.stdout, 'write');
+
+    console(infoIssue);
+    console(warnIssue);
+    console(errorIssue);
+
+    assert.strictEqual(process.stdout.write.mock.callCount(), 3);
+
+    const callsArgs = process.stdout.write.mock.calls.map(
+      call => call.arguments[0]
+    );
+
+    assert.deepStrictEqual(callsArgs, [
+      '\x1B[90mThis is a INFO issue at doc/api/test.md\x1B[39m\n',
+      '\x1B[33mThis is a WARN issue at doc/api/test.md (1:1)\x1B[39m\n',
+      '\x1B[31mThis is a ERROR issue at doc/api/test.md (1:1)\x1B[39m\n',
+    ]);
+  });
+});

src/linter/tests/reporters/gihub.test.mjs

@@ -0,0 +1,26 @@
+import { describe, it } from 'node:test';
+import github from '../../reporters/github.mjs';
+import assert from 'node:assert';
+import { errorIssue, infoIssue, warnIssue } from '../fixtures/issues.mjs';
+
+describe('github', () => {
+  it('should write to stdout with the correct fn based on the issue level', t => {
+    t.mock.method(process.stdout, 'write');
+
+    github(infoIssue);
+    github(warnIssue);
+    github(errorIssue);
+
+    assert.strictEqual(process.stdout.write.mock.callCount(), 3);
+
+    const callsArgs = process.stdout.write.mock.calls.map(
+      call => call.arguments[0]
+    );
+
+    assert.deepStrictEqual(callsArgs, [
+      '::notice file=doc/api/test.md::This is a INFO issue\n',
+      '::warning file=doc/api/test.md,line=1,endLine=1::This is a WARN issue\n',
+      '::error file=doc/api/test.md,line=1,endLine=1::This is a ERROR issue\n',
+    ]);
+  });
+});