refactor: changed signature result from smell detector

BREAKING CHANGE: changed result signature from smells detector

Author: marabesi

cli/src/find-smells.ts

@@ -41,7 +41,7 @@ async function execute() {
       for (const file of pathWithAllFilesFound) {
         const fileContent = await fs.readFile(file, { encoding: 'utf8' });
         const smellDetector = new SmellDetector(file, fileContent, language);
-        const smells = smellDetector.findAll().smells;
+        const smells = smellDetector.findAll().smellsList.smells;
         aggregator.push({ fileName: file, smells, language, fileContent });
       }
 
@@ -57,7 +57,7 @@ async function execute() {
     for (const file of pathWithAllFilesFound) {
       const fileContents = await fs.readFile(file, { encoding: 'utf8' });
       const smellDetector = new SmellDetector(file, fileContents, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetector.findAll().smellsList.smells;
 
       if (result.length) {
         result.forEach((e: Smell) => {

detector/src/reporters/types.ts

@@ -14,4 +14,3 @@ export interface AggregatedData {
 export interface ExportOptions {
   to: string
 }
-

detector/src/smells-detector.ts

@@ -17,7 +17,7 @@ export class SmellDetector {
       const ast = parseScript(this.code, { loc: true });
 
       const finder = new JavascriptSmells(ast);
-      return { smells: finder.searchSmells(), testCases: [] };
+      return { smellsList: { fileName: this.fileName, fileContent: this.code, smells: finder.searchSmells(), language: this.language }, testCases: [] };
     }
 
     // wondering why createSource? https://stackoverflow.com/a/60462133/2258921
@@ -30,7 +30,7 @@ export class SmellDetector {
       endsAt: columnEnd,
     }));
 
-    return { smells: new TypescriptSmells(ast).searchSmells(), testCases };
+    return { smellsList: { fileName: this.fileName, fileContent: this.code, smells: new TypescriptSmells(ast).searchSmells(), language: SupportedLanguages.typescript }, testCases };
   }
 }
 

detector/src/types.ts

@@ -27,7 +27,7 @@ export interface SmellsFinder {
 }
 
 export type SmellDetectorRunnerResult = {
-  smells: Smell[];
+  smellsList: SmellsList;
   testCases: TestCase[];
 };
 

detector/test/smells-detector-builder.ts

@@ -1,3 +1,6 @@
+import { SmellDetector } from "../src";
+import { Smell } from "../src/types";
+
 export const IF_STATEMENT = 'if-statement';
 export const FOR_OF = 'for-of-statement';
 export const FOR_IN = 'for-in-statement';
@@ -7,4 +10,11 @@ export const CONSOLE = 'console-statement';
 export const MOCKERY = 'excessive-jest-mock';
 
 export const JAVASCRIPT = 'javascript';
-export const TYPESCRIPT = 'typescript';
+export const TYPESCRIPT = 'typescript';
+
+
+export function smellDetectorInstance(code: string, language: string): Smell[] {
+  const smellDetector = new SmellDetector('my-file', code, language);
+  const result = smellDetector.findAll().smellsList.smells;
+  return result;
+}

detector/test/smells-detector-with-smells.test.ts

@@ -1,6 +1,6 @@
 import { describe, expect, test } from 'vitest';
 import { SmellDetector } from '../src/index';
-import { CONSOLE, FOR, FOR_IN, FOR_OF, IF_STATEMENT, JAVASCRIPT, MOCKERY, TIMEOUT, TYPESCRIPT } from './smells-detector-builder';
+import { CONSOLE, FOR, FOR_IN, FOR_OF, IF_STATEMENT, JAVASCRIPT, MOCKERY, smellDetectorInstance, TIMEOUT, TYPESCRIPT } from './smells-detector-builder';
 
 
 describe('Smelly Test Smell Detection Suite', () => {
@@ -364,57 +364,49 @@ jest.mock("../");`,
   ])(`detect test smell for %s %s: type %s %s at index %s`, ({ code, language, index, type, lineStart, lineEnd, startAt, endsAt, total, description, diagnostic }) => {
 
     test(`should find ${total} test smells`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result.length).toEqual(total);
     });
 
     test(`at ${index} should match ${type}`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].type).toEqual(type);
     });
 
     test(`at ${index} should find line start`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].lineStart).toEqual(lineStart);
     });
 
     test(`at ${index} should find line end`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].lineEnd).toEqual(lineEnd);
     });
 
     test(`at ${index} should find column start at`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].startAt).toEqual(startAt);
     });
 
     test(`at ${index} should find column ends at`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].endsAt).toEqual(endsAt);
     });
 
     test(`at ${index} should find description`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].description).toEqual(description);
     });
 
     test(`at ${index} should find diagnostic`, () => {
-      const smellDetector = new SmellDetector('my-file', code, language);
-      const result = smellDetector.findAll().smells;
+      const result = smellDetectorInstance(code, language);
 
       expect(result[index].diagnostic).toEqual(diagnostic);
     });
@@ -500,4 +492,4 @@ test("b", () => {});`,
       expect(result[index].endsAt).toEqual(testCases[index].endsAt);
     });
    });
-});
+});

detector/test/smells-detector-without-smells.test.ts

@@ -1,6 +1,5 @@
 import { describe, expect, test } from 'vitest';
-import { SmellDetector } from '../src/index';
-import { TYPESCRIPT } from './smells-detector-builder';
+import { smellDetectorInstance, TYPESCRIPT } from './smells-detector-builder';
 
 describe('Smelly Test Smell Detection Suite', () => {
   test.each([{
@@ -9,9 +8,7 @@ jest.mock("../");`,
     language: TYPESCRIPT,
   }
   ])(`detect code without smells`, ({ code, language }) => {
-    const smellDetector = new SmellDetector(code, language);
-    const result = smellDetector.findAll().smells;
-
+    const result = smellDetectorInstance(code, language);
     expect(result.length).toEqual(0);
   });
 });

vscode/src/extension.ts

@@ -192,7 +192,7 @@ function generateHighlighting(context: vscode.ExtensionContext) {
 
 const findSmells = (fileName: string, text: string, language: string): Smell[] => {
   const detect = new SmellDetector(fileName, text, language);
-  return detect.findAll().smells;
+  return detect.findAll().smellsList.smells;
 };
 
 export function findMatch(fileName: string, text: string, language: string): void {