refactor: better name

Author: araujogui

src/linter/context.mjs

@@ -18,7 +18,7 @@ const createContext = (file, tree) => {
   /**
    * Reports a lint issue.
    *
-   * @param {import('./types').ReportIssueProps} issue
+   * @param {import('./types').IssueDescriptor} descriptor
    * @returns {void}
    */
   const report = ({ level, message, position }) => {

src/linter/tests/fixtures/report.mjs src/linter/tests/fixtures/descriptors.mjssrc/linter/tests/fixtures/report.mjs renamed to src/linter/tests/fixtures/descriptors.mjs

@@ -1,24 +1,24 @@
 /**
- * @type {import('../../types').ReportIssueProps}
+ * @type {import('../../types').IssueDescriptor}
  */
-export const infoReport = {
+export const infoDescriptor = {
   level: 'info',
   message: 'This is a INFO issue',
 };
 
 /**
- * @type {import('../../types').ReportIssueProps}
+ * @type {import('../../types').IssueDescriptor}
  */
-export const warnReport = {
+export const warnDescriptor = {
   level: 'warn',
   message: 'This is a WARN issue',
   position: { start: { line: 1, column: 1 }, end: { line: 1, column: 2 } },
 };
 
 /**
- * @type {import('../../types').ReportIssueProps}
+ * @type {import('../../types').IssueDescriptor}
  */
-export const errorReport = {
+export const errorDescriptor = {
   level: 'error',
   message: 'This is a ERROR issue',
   position: { start: { line: 1, column: 1 }, end: { line: 1, column: 2 } },

src/linter/tests/index.test.mjs

@@ -1,10 +1,15 @@
 import { describe, mock, it } from 'node:test';
 import assert from 'node:assert/strict';
+import { VFile } from 'vfile';
+
 import createLinter from '../index.mjs';
 import { errorIssue, infoIssue, warnIssue } from './fixtures/issues.mjs';
-import { VFile } from 'vfile';
 import createContext from '../context.mjs';
-import { errorReport, infoReport, warnReport } from './fixtures/report.mjs';
+import {
+  errorDescriptor,
+  infoDescriptor,
+  warnDescriptor,
+} from './fixtures/descriptors.mjs';
 import { emptyTree } from './fixtures/tree.mjs';
 
 describe('createLinter', () => {
@@ -33,11 +38,11 @@ describe('createLinter', () => {
 
   it('should return the aggregated issues from all rules', () => {
     const rule1 = mock.fn(ctx => {
-      ctx.report(infoReport);
-      ctx.report(warnReport);
+      ctx.report(infoDescriptor);
+      ctx.report(warnDescriptor);
     });
 
-    const rule2 = mock.fn(ctx => ctx.report(errorReport));
+    const rule2 = mock.fn(ctx => ctx.report(errorDescriptor));
 
     const linter = createLinter([rule1, rule2]);
 

src/linter/types.d.ts

@@ -27,14 +27,14 @@ export interface Linter {
   hasError: () => boolean;
 }
 
-export interface ReportIssueProps {
+export interface IssueDescriptor {
   level: IssueLevel;
   message: string;
   position?: Position;
 }
 
 export interface LintContext {
   readonly tree: Root;
-  report(issue: ReportIssueProps): void;
+  report(descriptor: IssueDescriptor): void;
   getIssues(): LintIssue[];
 }