feat: detect language based on file name

Author: marabesi

cli/README.md

@@ -28,13 +28,13 @@ docker run --rm smelly-cli
 Single file
 
 ```sh
-npx smelly-cli /smells/my-test.ts typescript 
+npx smelly-cli /smells/my-test.ts
 ```
 
 Report (must be a path with tests in it)
 
 ```sh
-npx smelly-cli /smells/ javascript --report=html $(pwd)
+npx smelly-cli /smells/ --report=html $(pwd)
 ```
 
 ## Resources

cli/src/find-smells.ts

@@ -7,9 +7,8 @@ import { statSync } from 'fs';
 
 const args = process.argv;
 const fileName = args[2];
-const language = args[3] as SupportedLanguages || SupportedLanguages.javascript;
-const report = args[4];
-const reportOutput = args[5];
+const report = args[3];
+const reportOutput = args[4];
 
 if (!fileName) {
   console.error('[SMELLY] please provide a test file or a regex to search for test files');
@@ -41,7 +40,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 smellDetector = new SmellDetector(file, fileContent);
         const smells = smellDetector.findAll();
         aggregator.push(smells.smellsList);
         testCases.push(...smells.testCases);
@@ -58,7 +57,7 @@ async function execute() {
     const output: any[] = [];
     for (const file of pathWithAllFilesFound) {
       const fileContents = await fs.readFile(file, { encoding: 'utf8' });
-      const smellDetector = new SmellDetector(file, fileContents, language);
+      const smellDetector = new SmellDetector(file, fileContents);
       const result = smellDetector.findAll().smellsList.smells;
 
       if (result.length) {

cli/test/cli.test.ts

@@ -20,28 +20,28 @@ describe('cli', () => {
     });
 
     test('find no smells for a single file', async () => {
-      const { stdout } = await execPromise(`npm run cli -- fake-data/no-smells/no-smells.test.js javascript --report=html --report-output=.`);
+      const { stdout } = await execPromise(`npm run cli -- fake-data/no-smells/no-smells.test.js --report=html --report-output=.`);
 
       expect(stdout).toContain("Report HTML generated");
       expect(stdout).not.toContain("Error:");
     });
 
     test('find no smells for a given path', async () => {
-      const { stdout } = await execPromise(`npm run cli -- fake-data/no-smells/ javascript --report=html --report-output=$(pwd)`);
+      const { stdout } = await execPromise(`npm run cli -- fake-data/no-smells/ --report=html --report-output=$(pwd)`);
 
       expect(stdout).toContain("[SMELLY] please use a regex or a file");
     });
 
     test('find no smells for a path with regex', async () => {
-      const { stdout } = await execPromise(`npm run cli -- fake-data/no-smells/**/*test.js javascript --report=html --report-output=$(pwd)`);
+      const { stdout } = await execPromise(`npm run cli -- fake-data/no-smells/**/*test.js --report=html --report-output=$(pwd)`);
 
       expect(stdout).toContain("Report HTML generated");
       expect(stdout).not.toContain("Error:");
     });
 
     describe('validations', () => {
       test('generate empty report if path does not exists', async () => {
-        const { stdout } = await execPromise(`npm run cli -- /bla/foo/whatever/ javascript --report=html --report-output=$(pwd)`);
+        const { stdout } = await execPromise(`npm run cli -- /bla/foo/whatever/ --report=html --report-output=$(pwd)`);
 
         expect(stdout).toContain("Report HTML generated");
       });

detector/README.md

@@ -20,7 +20,7 @@ The detector package can be used as a standalone package.
 ```typescript
 import { SmellDetector } from 'smelly-detector';
 
-const detector = new SmellDetector("my source code", "javascript");
+const detector = new SmellDetector("my-file.js", "my source code");
 
 console.log(detector.findAll());
 ```

detector/src/smells-detector.ts

@@ -1,31 +1,15 @@
-import { parseScript } from 'esprima';
 import * as ts from 'typescript';
-import { JavascriptSmells } from './languages/JavascriptSmells';
 import { TypescriptSmells } from './languages/TypescriptSmells';
 import { SmellDetectorRunnerResult, SupportedLanguages, TestCase } from './types';
 
 export class SmellDetector {
 
   constructor(
     private readonly fileName: string,
-    private readonly code: string,
-    private readonly language: string
+    private readonly code: string
   ) { }
 
   findAll(): SmellDetectorRunnerResult {
-    if (this.language === SupportedLanguages.javascript) {
-      const ast = parseScript(this.code, { loc: true });
-
-      const finder = new JavascriptSmells(ast);
-      const smellsList = {
-        fileName: this.fileName,
-        fileContent: this.code,
-        smells: finder.searchSmells(),
-        language: this.language
-      };
-      return { smellsList, testCases: [] };
-    }
-
     // wondering why createSource? https://stackoverflow.com/a/60462133/2258921
     const ast = ts.createSourceFile('temp.ts', this.code, ts.ScriptTarget.ES2020, true);
 
@@ -36,18 +20,24 @@ export class SmellDetector {
       endsAt: endsAt,
     }));
 
+    const language = this.isJavascriptFile() ? SupportedLanguages.javascript : SupportedLanguages.typescript;
+
     const foundItEachCalls = this.findItEachCalls(ast);
     testCases.push(...foundItEachCalls);
     testCases.push(...this.findItSkipCalls(ast));
 
     const smellsList = {
       fileName: this.fileName,
       fileContent: this.code,
-      smells: new TypescriptSmells(ast).searchSmells(), language: SupportedLanguages.typescript
+      smells: new TypescriptSmells(ast).searchSmells(), language 
     };
     return { smellsList, testCases };
   }
 
+  private isJavascriptFile() {
+    return this.fileName.endsWith('.js') || this.fileName.endsWith('.jsx');
+  }
+
   private findItCalls(sourceFile: ts.SourceFile): { lineStart: number, startAt: number, lineEnd: number, endsAt: number }[] {
     const itCalls: { lineStart: number, startAt: number, lineEnd: number, endsAt: number }[] = [];
 

detector/test/smells-detector-builder.ts

@@ -9,15 +9,15 @@ export const TIMEOUT = 'timeout';
 export const CONSOLE = 'console-statement';
 export const MOCKERY = 'excessive-jest-mock';
 
-export const JAVASCRIPT = 'javascript';
-export const TYPESCRIPT = 'typescript';
+export const JAVASCRIPT_FILE = 'javascript.js';
+export const TYPESCRIPT_FILE = 'javascript.ts';
 
 export function smellDetectorInstance(code: string, language: string): Smell[] {
-  const smellDetector = new SmellDetector('my-file', code, language);
+  const smellDetector = new SmellDetector(language, code);
   return smellDetector.findAll().smellsList.smells;
 }
 
 export function totalTestCaseDetectorInstance(code: string, language: string): TestCase[] {
-  const smellDetector = new SmellDetector('my-file', code, language);
+  const smellDetector = new SmellDetector(language, code);
   return smellDetector.findAll().testCases;
 }