feat(plugin-jsdocs): include end line number

Author: matejchalk

e2e/plugin-jsdocs-e2e/tests/__snapshots__/collect.e2e.test.ts.snap

@@ -201,6 +201,7 @@ exports[`PLUGIN collect report with jsdocs-plugin NPM package > should run JSDoc
                             "coverage": 0,
                             "missing": [
                               {
+                                "endLine": 3,
                                 "kind": "function",
                                 "name": "notRealisticFunction",
                                 "startLine": 1,
@@ -221,6 +222,7 @@ exports[`PLUGIN collect report with jsdocs-plugin NPM package > should run JSDoc
                             "coverage": 0.5,
                             "missing": [
                               {
+                                "endLine": 5,
                                 "kind": "function",
                                 "name": "mapEventToCustomEvent",
                                 "startLine": 3,
@@ -287,6 +289,7 @@ exports[`PLUGIN collect report with jsdocs-plugin NPM package > should run JSDoc
                             "coverage": 0,
                             "missing": [
                               {
+                                "endLine": 1,
                                 "kind": "variable",
                                 "name": "someVariable",
                                 "startLine": 1,
@@ -406,6 +409,7 @@ exports[`PLUGIN collect report with jsdocs-plugin NPM package > should run JSDoc
                             "coverage": 0.5,
                             "missing": [
                               {
+                                "endLine": 17,
                                 "kind": "method",
                                 "name": "sendEvent",
                                 "startLine": 15,
@@ -472,6 +476,7 @@ exports[`PLUGIN collect report with jsdocs-plugin NPM package > should run JSDoc
                             "coverage": 0,
                             "missing": [
                               {
+                                "endLine": 5,
                                 "kind": "property",
                                 "name": "title",
                                 "startLine": 5,

packages/plugin-jsdocs/mocks/node.mock.ts

@@ -12,6 +12,7 @@ export function nodeMock(options: {
     getJsDocs: () => (options.isCommented ? ['Comment'] : []),
     getName: () => 'test',
     getStartLineNumber: () => options.line,
+    getEndLineNumber: () => options.line,
     getDeclarations: () => [],
     // Only for classes
     getMethods: () => [],

packages/plugin-jsdocs/src/lib/runner/__snapshots__/doc-processor.unit.test.ts.snap

@@ -7,11 +7,13 @@ exports[`getDocumentationReport > should produce a full report 1`] = `
       "covered": 1,
       "missing": [
         {
+          "endLine": 4,
           "kind": "class",
           "name": "test",
           "startLine": 4,
         },
         {
+          "endLine": 5,
           "kind": "class",
           "name": "test",
           "startLine": 5,
@@ -26,11 +28,13 @@ exports[`getDocumentationReport > should produce a full report 1`] = `
       "covered": 1,
       "missing": [
         {
+          "endLine": 8,
           "kind": "enum",
           "name": "test",
           "startLine": 8,
         },
         {
+          "endLine": 9,
           "kind": "enum",
           "name": "test",
           "startLine": 9,
@@ -53,6 +57,7 @@ exports[`getDocumentationReport > should produce a full report 1`] = `
       "covered": 2,
       "missing": [
         {
+          "endLine": 15,
           "kind": "interface",
           "name": "test",
           "startLine": 15,
@@ -83,11 +88,13 @@ exports[`getDocumentationReport > should produce a full report 1`] = `
       "covered": 2,
       "missing": [
         {
+          "endLine": 10,
           "kind": "type",
           "name": "test",
           "startLine": 10,
         },
         {
+          "endLine": 11,
           "kind": "type",
           "name": "test",
           "startLine": 11,

packages/plugin-jsdocs/src/lib/runner/doc-processor.integration.test.ts

@@ -25,6 +25,7 @@ describe('processJsDocs', () => {
             kind: 'class',
             name: 'ExampleClass',
             startLine: 1,
+            endLine: 1,
           },
         ],
       },
@@ -63,6 +64,7 @@ describe('processJsDocs', () => {
             kind: 'method',
             name: 'exampleMethod',
             startLine: 5,
+            endLine: 7,
           },
         ],
       },
@@ -101,6 +103,7 @@ describe('processJsDocs', () => {
             kind: 'interface',
             name: 'ExampleInterface',
             startLine: 1,
+            endLine: 1,
           },
         ],
       },
@@ -139,6 +142,7 @@ describe('processJsDocs', () => {
             kind: 'variable',
             name: 'exampleVariable',
             startLine: 1,
+            endLine: 1,
           },
         ],
       },
@@ -177,6 +181,7 @@ describe('processJsDocs', () => {
             kind: 'property',
             name: 'exampleProperty',
             startLine: 5,
+            endLine: 5,
           },
         ],
       },
@@ -215,6 +220,7 @@ describe('processJsDocs', () => {
             kind: 'type',
             name: 'ExampleType',
             startLine: 1,
+            endLine: 1,
           },
         ],
       },
@@ -253,6 +259,7 @@ describe('processJsDocs', () => {
             kind: 'enum',
             name: 'ExampleEnum',
             startLine: 1,
+            endLine: 1,
           },
         ],
       },

packages/plugin-jsdocs/src/lib/runner/doc-processor.ts

@@ -23,6 +23,7 @@ type Node = {
   getKind: () => SyntaxKind;
   getName: () => string | undefined;
   getStartLineNumber: () => number;
+  getEndLineNumber: () => number;
   getJsDocs: () => JSDoc[];
 };
 
@@ -33,13 +34,14 @@ type Node = {
  */
 export function getVariablesInformation(
   variableStatements: VariableStatement[],
-) {
+): Node[] {
   return variableStatements.flatMap(variable => {
     // Get parent-level information
     const parentInfo = {
       getKind: () => variable.getKind(),
       getJsDocs: () => variable.getJsDocs(),
       getStartLineNumber: () => variable.getStartLineNumber(),
+      getEndLineNumber: () => variable.getEndLineNumber(),
     };
 
     // Map each declaration to combine parent info with declaration-specific info
@@ -125,6 +127,7 @@ function getCoverageFromAllNodesOfFile(nodes: Node[], filePath: string) {
                     kind: singularCoverageType(nodeType),
                     name: node.getName(),
                     startLine: node.getStartLineNumber(),
+                    endLine: node.getEndLineNumber(),
                   },
                 ],
               }),

packages/plugin-jsdocs/src/lib/runner/doc-processor.unit.test.ts

@@ -61,6 +61,7 @@ describe('getDocumentationReport', () => {
     >([
       {
         startLine: 1,
+        endLine: 1,
         kind: 'function',
         name: 'test',
       },
@@ -97,6 +98,7 @@ describe('getVariablesInformation', () => {
       getKind: () => 'const',
       getJsDocs: () => ['some docs'],
       getStartLineNumber: () => 42,
+      getEndLineNumber: () => 44,
       getDeclarations: () => [mockDeclaration],
     };
 
@@ -109,13 +111,15 @@ describe('getVariablesInformation', () => {
       getKind: expect.any(Function),
       getJsDocs: expect.any(Function),
       getStartLineNumber: expect.any(Function),
+      getEndLineNumber: expect.any(Function),
       getName: expect.any(Function),
     });
     // It must be defined
     expect(result[0]!.getName()).toBe('testVariable');
     expect(result[0]!.getKind()).toBe('const');
     expect(result[0]!.getJsDocs()).toEqual(['some docs']);
     expect(result[0]!.getStartLineNumber()).toBe(42);
+    expect(result[0]!.getEndLineNumber()).toBe(44);
   });
 
   it('should handle multiple declarations in a single variable statement', () => {
@@ -128,6 +132,7 @@ describe('getVariablesInformation', () => {
       getKind: () => 'let',
       getJsDocs: () => [],
       getStartLineNumber: () => 10,
+      getEndLineNumber: () => 10,
       getDeclarations: () => mockDeclarations,
     };
 
@@ -153,6 +158,7 @@ describe('getVariablesInformation', () => {
       getKind: () => 'const',
       getJsDocs: () => [],
       getStartLineNumber: () => 1,
+      getEndLineNumber: () => 1,
       getDeclarations: () => [],
     };