refactor: rename FoundFolder to ScanFoundFolder

Author: zaldih

src/cli/cli.controller.ts

@@ -10,7 +10,7 @@ import {
   UI_POSITIONS,
 } from '../constants/index.js';
 import { ERROR_MSG, INFO_MSGS } from '../constants/messages.constants.js';
-import { IConfig, ScanFolderResult, IKeyPress } from './interfaces/index.js';
+import { IConfig, CliScanFoundFolder, IKeyPress } from './interfaces/index.js';
 import { Observable } from 'rxjs';
 import { filter, map, mergeMap, switchMap, tap } from 'rxjs/operators';
 
@@ -391,7 +391,7 @@ export class CliController {
 
     nonExcludedResults$
       .pipe(
-        map<string, ScanFolderResult>((path) => ({
+        map<string, CliScanFoundFolder>((path) => ({
           path,
           size: 0,
           modificationTime: -1,
@@ -442,8 +442,8 @@ export class CliController {
   }
 
   private calculateFolderStats(
-    nodeFolder: ScanFolderResult,
-  ): Observable<ScanFolderResult> {
+    nodeFolder: CliScanFoundFolder,
+  ): Observable<CliScanFoundFolder> {
     this.logger.info(`Calculating stats for ${String(nodeFolder.path)}`);
     return this.fileService.getFolderSize(nodeFolder.path).pipe(
       tap((size) => {
@@ -520,7 +520,7 @@ export class CliController {
     new GeneralUi().printExitMessage({ spaceReleased });
   }
 
-  private deleteFolder(folder: ScanFolderResult): void {
+  private deleteFolder(folder: CliScanFoundFolder): void {
     if (folder.status === 'deleted' || folder.status === 'deleting') {
       return;
     }

src/cli/interfaces/stats.interface.ts

@@ -1,6 +1,6 @@
-import { FoundFolder } from '@core/interfaces';
+import { ScanFoundFolder } from '@core/interfaces';
 
-export interface ScanFolderResult extends FoundFolder {
+export interface CliScanFoundFolder extends ScanFoundFolder {
   size: number;
   modificationTime: number;
   isDangerous: boolean;

src/cli/services/results.service.ts

@@ -1,10 +1,10 @@
-import { ScanFolderResult, IStats } from '../interfaces/index.js';
+import { CliScanFoundFolder, IStats } from '../interfaces/index.js';
 import { FOLDER_SORT } from '../../constants/sort.result.js';
 
 export class ResultsService {
-  results: ScanFolderResult[] = [];
+  results: CliScanFoundFolder[] = [];
 
-  addResult(result: ScanFolderResult): void {
+  addResult(result: CliScanFoundFolder): void {
     this.results = [...this.results, result];
   }
 

src/cli/ui/components/results.ui.ts

@@ -17,15 +17,15 @@ import { Subject } from 'rxjs';
 import colors from 'colors';
 import { resolve } from 'node:path';
 import { FileService } from '@core/services/files/index.js';
-import { ScanFolderResult } from 'src/cli/interfaces/stats.interface.js';
+import { CliScanFoundFolder } from 'src/cli/interfaces/stats.interface.js';
 
 export class ResultsUi extends HeavyUi implements InteractiveUi {
   resultIndex = 0;
   previousIndex = 0;
   scroll: number = 0;
   private haveResultsAfterCompleted = true;
 
-  readonly delete$ = new Subject<ScanFolderResult>();
+  readonly delete$ = new Subject<CliScanFoundFolder>();
   readonly showErrors$ = new Subject<null>();
   readonly openFolder$ = new Subject<string>();
 
@@ -98,7 +98,7 @@ export class ResultsUi extends HeavyUi implements InteractiveUi {
   private printResults(): void {
     const visibleFolders = this.getVisibleScrollFolders();
 
-    visibleFolders.forEach((folder: ScanFolderResult, index: number) => {
+    visibleFolders.forEach((folder: CliScanFoundFolder, index: number) => {
       const row = MARGINS.ROW_RESULTS_START + index;
       this.printFolderRow(folder, row);
     });
@@ -115,7 +115,7 @@ export class ResultsUi extends HeavyUi implements InteractiveUi {
     });
   }
 
-  private printFolderRow(folder: ScanFolderResult, row: number): void {
+  private printFolderRow(folder: CliScanFoundFolder, row: number): void {
     this.clearLine(row);
     let { path, lastModification, size } = this.getFolderTexts(folder);
     const isRowSelected = row === this.getRealCursorPosY();
@@ -147,7 +147,7 @@ export class ResultsUi extends HeavyUi implements InteractiveUi {
     });
   }
 
-  private getFolderTexts(folder: ScanFolderResult): {
+  private getFolderTexts(folder: CliScanFoundFolder): {
     path: string;
     size: string;
     lastModification: string;
@@ -278,7 +278,7 @@ export class ResultsUi extends HeavyUi implements InteractiveUi {
     this.fitScroll();
   }
 
-  private getFolderPathText(folder: ScanFolderResult): string {
+  private getFolderPathText(folder: CliScanFoundFolder): string {
     let cutFrom = OVERFLOW_CUT_FROM;
     let text = folder.path;
     const ACTIONS = {
@@ -350,7 +350,7 @@ export class ResultsUi extends HeavyUi implements InteractiveUi {
     return this.getRow(this.resultIndex) - this.scroll;
   }
 
-  private getVisibleScrollFolders(): ScanFolderResult[] {
+  private getVisibleScrollFolders(): CliScanFoundFolder[] {
     return this.resultsService.results.slice(
       this.scroll,
       this.getRowsAvailable() + this.scroll,

src/constants/sort.result.ts

@@ -1,11 +1,11 @@
-import { ScanFolderResult } from 'src/cli/interfaces';
+import { CliScanFoundFolder } from 'src/cli/interfaces';
 
 export const FOLDER_SORT = {
-  path: (a: ScanFolderResult, b: ScanFolderResult) =>
+  path: (a: CliScanFoundFolder, b: CliScanFoundFolder) =>
     a.path > b.path ? 1 : -1,
-  size: (a: ScanFolderResult, b: ScanFolderResult) =>
+  size: (a: CliScanFoundFolder, b: CliScanFoundFolder) =>
     a.size < b.size ? 1 : -1,
-  'last-mod': (a: ScanFolderResult, b: ScanFolderResult) => {
+  'last-mod': (a: CliScanFoundFolder, b: CliScanFoundFolder) => {
     if (a.modificationTime === b.modificationTime) {
       return FOLDER_SORT.path(a, b);
     }

src/core/interfaces/folder.interface.ts

@@ -1,4 +1,4 @@
-export interface FoundFolder {
+export interface ScanFoundFolder {
   path: string;
 }
 

src/core/interfaces/npkill.interface.ts

@@ -1,6 +1,6 @@
 import { Observable } from 'rxjs';
 import {
-  FoundFolder,
+  ScanFoundFolder,
   GetFolderLastModificationOptions,
   GetFolderLastModificationResult,
   GetFolderSizeOptions,
@@ -10,7 +10,7 @@ import {
 import { IFileService } from '.';
 
 export interface NpkillInterface {
-  startScan$(options: ScanOptions): Observable<FoundFolder>;
+  startScan$(options: ScanOptions): Observable<ScanFoundFolder>;
   getFolderSize(options: GetFolderSizeOptions): Promise<GetFolderSizeResult>;
   getFolderLastModification(
     options: GetFolderLastModificationOptions,
@@ -26,5 +26,8 @@ export interface DeleteOptions {
 export interface DeleteResult {
   path: string;
   success: boolean;
-  error?: string;
+  error?: {
+    message: string;
+    code?: string;
+  };
 }

src/core/npkill.ts

@@ -8,7 +8,7 @@ import { LoggerService } from './services/logger.service.js';
 import { StreamService } from './services/stream.service.js';
 import { Services } from './interfaces/services.interface.js';
 import {
-  FoundFolder,
+  ScanFoundFolder,
   GetFolderLastModificationOptions,
   GetFolderLastModificationResult,
   GetFolderSizeOptions,
@@ -33,7 +33,7 @@ export class Npkill implements NpkillInterface {
     this.services = { ...defaultServices, ...customServices };
   }
 
-  startScan$(options: ScanOptions): Observable<FoundFolder> {
+  startScan$(options: ScanOptions): Observable<ScanFoundFolder> {
     const { fileService } = this.services;
 
     return fileService.listDir(options).pipe(