clean: Clean up messages to user (#146)

## Problem

The logging of the removed folders did not account for folders that fell
within the desired aged to delete but could not be removed because they
are still in use. Thus they initial message about the number of folders
found did not agree with the number actually deleted.

## Changes

- Added a count of rejected deletions on the assumption it was because
they are in use still.
- modified the messaging to account for the rejected deletions
- removed the number deleted logging from the index as no longer being
informative

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Enhanced logging for folder deletion outcomes in the Sonar temporary
folder removal process, providing clearer feedback on operation success.

- **Bug Fixes**
- Improved feedback mechanism for folder deletion, addressing visibility
of successful and failed deletions.

- **Documentation**
- Added comments to clarify the purpose of functions related to
temporary folders created by SonarLint.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>

Author: begin-again

src/clean/clean.js

@@ -75,46 +75,56 @@ const removeTarget = async (name, regex, root = defaultTempPath) => {
     }
 };
 
-
 /**
+ * Remove old temporary folders created by SonarLint
  *
  * @param {object} options
  * @param {string} options.root - over-ride sonarlint work folder path for testing
- * @param {number=} options.age
  * @param {object=} logger
  * @returns {Promise<number>} - number of folders removed
  */
-const removeSonarTemp = async ({ root, age = 2 }, logger = console) => {
+const removeSonarTemp = async ({ root }, logger = console) => {
     const _root = root || realpathSync(join(process.env.HOME, '.sonarlint'));
-    const now = Date.now();
-    const DAY_MS = 86400000;
-    let folders = [];
     try {
         await fsPromises.access(_root, constants.R_OK | constants.W_OK);
 
-        folders = await fsPromises.readdir(_root, { withFileTypes: true });
-        const targetFolders = folders.filter(d => d.isDirectory() && (d.name.startsWith('.sonarlinttmp_') || d.name.startsWith('xodus-local-only')));
-        const foldersToDelete = targetFolders.filter(async d => {
-            const { ctimeMs } = await fsPromises.stat(join(_root, d.name)).catch(() => ({ ctimeMs: 0 }));
-            const daysOld = Math.floor((now - ctimeMs) / DAY_MS);
-            return daysOld >= age;
-        });
+        const folders = await fsPromises.readdir(_root, { withFileTypes: true });
+
+        const targetFolders = folders.filter(d =>
+            d.isDirectory() &&
+            (d.name.startsWith('.sonarlinttmp_') || d.name.startsWith('xodus-local-only')))
+        ;
 
-        logger.info(`Removing ${foldersToDelete.length} folders which are at least ${age} days ...`);
         const deleteFolders = await Promise.allSettled(
-            foldersToDelete.map(d => remover(join(_root, d.name), { recursive: true })
-                .then(() => `removed ${d.name}`)
-            )
+            targetFolders
+                .map(d => remover(join(_root, d.name), { recursive: true })
+                    .then(() => `removed ${d.name}`)
+                )
         );
 
-        return deleteFolders.filter(f => f.status === 'fulfilled').length;
+        const busyFoldersCount = deleteFolders.filter(f => f.status === 'rejected').length;
+        const deletedFoldersCount = deleteFolders.filter(f => f.status === 'fulfilled').length;
+
+        if(busyFoldersCount > 0 && deletedFoldersCount === 0) {
+            logger.info(`All folders are still in use and could not be deleted`);
+        }
+        else if(busyFoldersCount > 0 && deletedFoldersCount > 0) {
+            logger.info(`Removed ${deletedFoldersCount} folders, ${busyFoldersCount} folders are still in use`);
+        }
+        else if(busyFoldersCount === 0 && deletedFoldersCount > 0) {
+            logger.info(`Removed ${deletedFoldersCount} folders`);
+        }
+        else {
+            logger.info(`No folders to remove`);
+        }
+
+        return deletedFoldersCount;
     }
     catch (err) {
         logger.error(`Error during sonar cleanup: ${err.message}`);
         return 0;
     }
 
-
 };
 
 module.exports = {

src/clean/index.js

@@ -18,12 +18,6 @@ const sonar = {
             , type: 'string'
             , default: join(process.env.HOME, '.sonarlint')
         })
-        .option('age', {
-            alias: 'a'
-            , describe: 'how many days to keep. Must be an integer > 1'
-            , type: 'number'
-            , default: 2
-        })
         .option('logger', {
             type: 'object'
             , default: console
@@ -35,18 +29,10 @@ const sonar = {
             }
             throw new Error('root path not found');
         })
-        .check(argv => {
-            // eslint-disable-next-line no-magic-numbers
-            if(argv.age > 1 && argv.age <= 100 && Number.isInteger(argv.age)) {
-                return true;
-            }
-            throw new Error('age must be > 1');
-        })
     , handler: async (args) => {
-        const { root, age, logger } = args;
+        const { root, logger } = args;
         try {
-            const result = await removeSonarTemp({ root, age }, logger);
-            logger.info(`sonar cleanup completed, ${result} folders removed`);
+            await removeSonarTemp({ root }, logger);
         }
         catch (err) {
             logger.error(err.message);