From f8211a01b11a1f2fdab442f283c87bb79be54511 Mon Sep 17 00:00:00 2001 From: marabesi Date: Sun, 30 Jun 2024 10:00:10 +0200 Subject: [PATCH] refactor: moved code under modules --- vscode/package.json | 2 +- vscode/src/extension.ts | 4 ++-- vscode/src/extension.types.ts | 2 +- vscode/src/modules/SmellsFinder.ts | 5 ----- vscode/src/{ => modules}/cli/find-smells.ts | 2 +- .../{ => smells-finder/languages}/JavascriptSmells.ts | 3 +-- .../{ => smells-finder/languages}/TypescriptSmells.ts | 3 +-- vscode/src/modules/{ => smells-finder}/smells-detector.ts | 4 ++-- .../{ => smells-finder}/test/smells-detector.test.ts | 0 vscode/src/modules/{ => smells-finder}/types.ts | 6 +++++- 10 files changed, 14 insertions(+), 17 deletions(-) delete mode 100644 vscode/src/modules/SmellsFinder.ts rename vscode/src/{ => modules}/cli/find-smells.ts (88%) rename vscode/src/modules/{ => smells-finder/languages}/JavascriptSmells.ts (97%) rename vscode/src/modules/{ => smells-finder/languages}/TypescriptSmells.ts (95%) rename vscode/src/modules/{ => smells-finder}/smells-detector.ts (73%) rename vscode/src/modules/{ => smells-finder}/test/smells-detector.test.ts (100%) rename vscode/src/modules/{ => smells-finder}/types.ts (76%) diff --git a/vscode/package.json b/vscode/package.json index 7b82ee4..44e83b3 100644 --- a/vscode/package.json +++ b/vscode/package.json @@ -43,7 +43,7 @@ "test:all": "mocha -r ts-node/register src/modules/**/**.test.ts", "test:coverage": "nyc --reporter=text mocha -r ts-node/register src/modules/**/**.test.ts", "coveralls": "npm run test:coveralls:coverage && coveralls --verbose < lcov.info", - "cli": "ts-node src/cli/find-smells.ts" + "cli": "ts-node src/modules/cli/find-smells.ts" }, "devDependencies": { "@types/esprima": "^4.0.6", diff --git a/vscode/src/extension.ts b/vscode/src/extension.ts index df5d480..9286fd3 100644 --- a/vscode/src/extension.ts +++ b/vscode/src/extension.ts @@ -1,7 +1,7 @@ import * as vscode from 'vscode'; import path from 'path'; -import { SmellDetector } from './modules/smells-detector'; -import { Smell } from './modules/types'; +import { SmellDetector } from './modules/smells-finder/smells-detector'; +import { Smell } from './modules/smells-finder/types'; import { ComposedSmell, warningDecorationType } from './extension.types'; let currentDecoration = warningDecorationType; diff --git a/vscode/src/extension.types.ts b/vscode/src/extension.types.ts index 1e4d427..0dc4d74 100644 --- a/vscode/src/extension.types.ts +++ b/vscode/src/extension.types.ts @@ -1,5 +1,5 @@ import { Range, window } from 'vscode'; -import { Smell } from "./modules/types"; +import { Smell } from "./modules/smells-finder/types"; export type ComposedSmell = { smell: Smell; diff --git a/vscode/src/modules/SmellsFinder.ts b/vscode/src/modules/SmellsFinder.ts deleted file mode 100644 index 5502f6d..0000000 --- a/vscode/src/modules/SmellsFinder.ts +++ /dev/null @@ -1,5 +0,0 @@ -import { Smell } from "./types"; - -export interface SmellsFinder { - searchSmells(): Smell[]; -} \ No newline at end of file diff --git a/vscode/src/cli/find-smells.ts b/vscode/src/modules/cli/find-smells.ts similarity index 88% rename from vscode/src/cli/find-smells.ts rename to vscode/src/modules/cli/find-smells.ts index 1671a71..99f32b9 100644 --- a/vscode/src/cli/find-smells.ts +++ b/vscode/src/modules/cli/find-smells.ts @@ -1,5 +1,5 @@ import fs from 'node:fs/promises'; -import { SmellDetector } from '../modules/smells-detector'; +import { SmellDetector } from '../smells-finder/smells-detector'; const args = process.argv; const fileName = args[2]; diff --git a/vscode/src/modules/JavascriptSmells.ts b/vscode/src/modules/smells-finder/languages/JavascriptSmells.ts similarity index 97% rename from vscode/src/modules/JavascriptSmells.ts rename to vscode/src/modules/smells-finder/languages/JavascriptSmells.ts index ca8d145..c296fff 100644 --- a/vscode/src/modules/JavascriptSmells.ts +++ b/vscode/src/modules/smells-finder/languages/JavascriptSmells.ts @@ -1,6 +1,5 @@ import { Syntax, parseScript } from "esprima"; -import { SmellsFinder } from "./SmellsFinder"; -import { Smell } from "./types"; +import { Smell, SmellsFinder } from "../types"; export class JavascriptSmells implements SmellsFinder { diff --git a/vscode/src/modules/TypescriptSmells.ts b/vscode/src/modules/smells-finder/languages/TypescriptSmells.ts similarity index 95% rename from vscode/src/modules/TypescriptSmells.ts rename to vscode/src/modules/smells-finder/languages/TypescriptSmells.ts index a96323e..9311fcc 100644 --- a/vscode/src/modules/TypescriptSmells.ts +++ b/vscode/src/modules/smells-finder/languages/TypescriptSmells.ts @@ -1,7 +1,6 @@ import * as ts from 'typescript'; -import { SmellsFinder } from "./SmellsFinder"; -import { Smell } from "./types"; +import { Smell, SmellsFinder } from "../types"; export class TypescriptSmells implements SmellsFinder { diff --git a/vscode/src/modules/smells-detector.ts b/vscode/src/modules/smells-finder/smells-detector.ts similarity index 73% rename from vscode/src/modules/smells-detector.ts rename to vscode/src/modules/smells-finder/smells-detector.ts index 233af9b..c15d901 100644 --- a/vscode/src/modules/smells-detector.ts +++ b/vscode/src/modules/smells-finder/smells-detector.ts @@ -1,5 +1,5 @@ -import { JavascriptSmells } from './JavascriptSmells'; -import { TypescriptSmells } from './TypescriptSmells'; +import { JavascriptSmells } from './languages/JavascriptSmells'; +import { TypescriptSmells } from './languages/TypescriptSmells'; import { Smell } from './types'; export class SmellDetector { diff --git a/vscode/src/modules/test/smells-detector.test.ts b/vscode/src/modules/smells-finder/test/smells-detector.test.ts similarity index 100% rename from vscode/src/modules/test/smells-detector.test.ts rename to vscode/src/modules/smells-finder/test/smells-detector.test.ts diff --git a/vscode/src/modules/types.ts b/vscode/src/modules/smells-finder/types.ts similarity index 76% rename from vscode/src/modules/types.ts rename to vscode/src/modules/smells-finder/types.ts index 9febbe5..29ae68c 100644 --- a/vscode/src/modules/types.ts +++ b/vscode/src/modules/smells-finder/types.ts @@ -6,4 +6,8 @@ export type Smell = { endsAt: number; description: string; //supports markdown diagnostic: string; //no support for markdown -}; \ No newline at end of file +}; + +export interface SmellsFinder { + searchSmells(): Smell[]; +} \ No newline at end of file