@kud/soap-cli 1.0.0-4

package/README.md

@@ -0,0 +1,53 @@
+# Soap 🧼 - An app cleaner cli for macOS
+
+> I was so lazy to use any GUI to clean my macOS. - @kud
+
+A simple command in your shell to remove the application you want to delete and the related files as well (like preferences, logs, `.dmg`, cask formula).
+
+## Motivation
+
+I used to use AppCleaner and [App Eraser](https://github.com/davunt/app-eraser) but the first one is not open source (and could have trackers) and the second one is not a CLI but a GUI. Here comes _soap_.
+
+## Install
+
+```shell
+npm install -g @kud/soap
+```
+
+## Usage
+
+You've got two ways to uninstall an application, via its path or via its cask name.
+
+#### Application path
+
+```shell
+soap <app-path>
+# ex: soap '/Applications/Android Studio.app'
+```
+
+_warning: it won't remove the cask formula even if you've installed the app via homebrew._
+
+#### Cask name
+
+```shell
+soap <cask-name>
+# ex: soap android-studio
+```
+
+It will delete for instance this kind of files:
+
+```
+/Applications/Android Studio.app
+/Users/kud/Downloads/android-studio-ide-182.5314842-mac.dmg
+/Users/kud/Library/Preferences/com.google.android.studio.plist
+/Users/kud/Library/Saved Application State/com.google.android.studio.savedState
+/Users/kud/Library/Application Support/google/AndroidStudio4.2
+/Users/kud/Library/Caches/google/AndroidStudio4.2
+/Users/kud/Library/Logs/google/AndroidStudio4.2
+```
+
+No worries, soap will move them into your Trash, so if something wrong has happened, you can check there your files.
+
+## Credits
+
+Inspired from [App Eraser](https://github.com/davunt/app-eraser)

package/index.js

@@ -0,0 +1,119 @@
+#!/usr/bin/env node
+import inquirer from "inquirer"
+import signale from "signale"
+import trash from "trash"
+import chalk from "chalk"
+import { $ } from "zx/core"
+
+import {
+  appNameFromPath,
+  appNameFromCaskName,
+  getBundleIdentifier,
+  findAppFiles,
+} from "./lib/index.js"
+
+$.verbose = false // true for debugging
+
+const [param] = process.argv.slice(2)
+
+if (!param) {
+  console.error(`No parameter specified.`)
+
+  process.exit(0)
+}
+
+const isCask = !param.includes(".app")
+
+console.log(
+  `Welcome to ${chalk.bold("soap")} 🧼, ${chalk.italic("the app cleaner")}.\n`,
+)
+
+try {
+  const appName = isCask
+    ? await appNameFromCaskName(param)
+    : appNameFromPath(param)
+  const bundleId = await getBundleIdentifier(appName)
+  const _appFiles = await findAppFiles(appName, bundleId)
+  const appFiles = isCask ? _appFiles.slice(1) : _appFiles
+  const isAppFilesEmpty = appFiles.length === 0
+
+  signale.info(
+    `You want me to clean this application: ${chalk.bold(appName)} 📦.`,
+  )
+
+  signale.info(
+    isCask
+      ? `I also assume ${chalk.bold("you gave me a cask name")}.`
+      : `I also assume you gave me an application path. ${chalk.bold(
+          "No homebrew cask will be deleted then",
+        )}.`,
+  )
+
+  console.log("")
+
+  const { deletedFilesWish } = await inquirer.prompt([
+    {
+      type: "checkbox",
+      name: "deletedFilesWish",
+      when: !isAppFilesEmpty,
+      message:
+        "This is what I've found about it. Please select the files you want to delete.",
+      choices: appFiles.map((appFile) => ({
+        name: appFile,
+        value: appFile,
+        checked: true,
+      })),
+    },
+    {
+      type: "confirm",
+      when: isCask,
+      name: "deletedCaskWish",
+      message: `Do you want to uninstall "${param}" via homebrew?`,
+    },
+  ])
+
+  if (!isAppFilesEmpty) {
+    await trash(deletedFilesWish, { force: true })
+
+    console.log("")
+
+    console.log("Files deleted:")
+    deletedFilesWish.forEach((deletedPath) => console.log(`· ${deletedPath}`))
+  }
+
+  if (isCask) {
+    console.log("")
+
+    signale.pending(`Starting cask uninstallation.`)
+
+    await $`brew uninstall ${param}`
+  }
+
+  console.log("")
+
+  signale.success("Operation successful.")
+} catch (error) {
+  signale.error(`Something wrong appeared. Check the log below.\n`)
+  console.error(error)
+  console.error("")
+
+  if (isCask) {
+    inquirer
+      .prompt([
+        {
+          type: "confirm",
+          name: "forceUninstall",
+          message:
+            "An error occurred. It could happen when the app file no longer exists, but the cask is still present in Homebrew.\nWould you like to forcefully uninstall the cask by running `brew uninstall`?",
+        },
+      ])
+      .then(async (answers) => {
+        if (answers.forceUninstall) {
+          console.error("")
+          signale.pending(`Forcefully uninstalling cask.`)
+          await $`brew uninstall --force ${param}`
+          signale.success("Force uninstallation successful.")
+        }
+      })
+  }
+}

package/lib/file-regex.js

@@ -0,0 +1,22 @@
+const uuidReg =
+  /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/g
+
+const dateReg = /[0-9]{4}-[0-9]{2}-[0-9]{2}-[0-9]{6}/g
+
+const diagReg = /.[a-zA-Z]+_resource.diag/
+
+const commonExtensions = [
+  ".dmg",
+  ".app",
+  ".bom",
+  ".plist",
+  ".XPCHelper",
+  ".beta",
+  ".extensions",
+  ".savedState",
+  ".driver",
+  ".wakeups_resource",
+  ".diag",
+]
+
+export const fileRegex = [uuidReg, dateReg, diagReg, ...commonExtensions]

package/lib/index.js

@@ -0,0 +1,186 @@
+import { $ } from "zx"
+$.verbose = false
+
+import { execSync } from "child_process"
+import fs from "fs/promises"
+import { pathLocations, commonSuffix } from "./path-locations.js"
+import { fileRegex } from "./file-regex.js"
+
+const scoreThreshold = 0.4
+
+let compNameGlob
+
+function stripString(file) {
+  let transformedString = file
+  fileRegex.forEach((regex1) => {
+    transformedString = transformedString.replace(regex1, "")
+  })
+
+  const normCompName = normalizeString(compNameGlob, "-")
+    .replace(/\u2019/g, "")
+    .replace(/\(/g, "")
+    .replace(/\)/g, "")
+
+  transformedString = transformedString.replace(normCompName, "")
+
+  return transformedString
+}
+
+const normalizeString = (str, spacer = "") =>
+  str.toLowerCase().replace(/ /g, spacer)
+
+async function getFilePatternArray(appName, bundleId) {
+  const nameVariations = createNameVariations(appName, bundleId)
+  const appNameNorm = normalizeString(appName)
+  const bundleIdNorm = normalizeString(bundleId)
+
+  let patternArray = [...nameVariations]
+
+  const appNameComponents = appNameNorm.split(".")
+  if (appNameComponents) patternArray.push(appNameComponents[0])
+
+  const bundleIdComponents = bundleIdNorm.split(".")
+  if (
+    bundleIdComponents.length > 2 &&
+    bundleIdComponents[bundleIdComponents.length - 1].toLowerCase() === "app"
+  ) {
+    patternArray.push(
+      `${bundleIdComponents.slice(0, bundleIdComponents.length - 1).join(".")}`,
+    )
+  }
+
+  const appWithSuffix = new Set([])
+  commonSuffix.forEach((suffix) =>
+    nameVariations.forEach((nameVariation) =>
+      appWithSuffix.add(`${nameVariation}${suffix}`),
+    ),
+  )
+
+  patternArray = [...patternArray, [...appWithSuffix]]
+
+  return patternArray
+}
+
+function isPatternInFile(patterns, fileToCheck) {
+  return patterns.find((filePatten) => {
+    if (fileToCheck.includes(filePatten)) {
+      const strippedFile = stripString(fileToCheck)
+
+      let score = 0
+      const indexOfString = strippedFile.indexOf(filePatten)
+      for (let i = 0; i < strippedFile.length; i += 1) {
+        if (i === indexOfString) {
+          i += indexOfString + filePatten.length
+          score += filePatten.length
+        }
+        if (strippedFile[parseInt(i, 10)] === ".") score += 0.5
+        if (strippedFile[parseInt(i, 10)] === "_") score += 0.5
+      }
+      if (score / strippedFile.length > scoreThreshold) {
+        return true
+      }
+      return false
+    }
+    return false
+  })
+}
+
+function createNameVariations(appName, bundleId) {
+  const appNameNorm = appName.toLowerCase().replace(" ", "")
+  const appNameWithoutDot = appNameNorm.toLowerCase().replace(".", "")
+  const appNameUnderscore = appName.toLowerCase().replace(" ", "_")
+  const appNameDash = appName.toLowerCase().replace(" ", "-")
+  const appNameDot = appName.toLowerCase().replace(" ", ".")
+
+  const bundleIdNorm = bundleId.toLowerCase().replace(" ", "")
+
+  return [
+    appNameNorm,
+    appNameWithoutDot,
+    appNameUnderscore,
+    appNameDash,
+    appNameDot,
+    bundleIdNorm,
+  ]
+}
+
+function appNameFromPath(appPath) {
+  const pathArr = appPath.split("/")
+  const appNameWithExt = pathArr[pathArr.length - 1]
+  // remove .app extension
+  return appNameWithExt.replace(".app", "")
+}
+
+export const appNameFromCaskName = async (caskName) => {
+  try {
+    const { stdout: info } = await $`brew info ${caskName} --json=v2`
+    const caskData = JSON.parse(info).casks?.[0]
+
+    if (!caskData) {
+      throw new Error("Cask data not available.")
+    }
+
+    return caskData.artifacts?.[0]?.app?.[0] || null
+  } catch (error) {
+    console.error(`Error fetching app name for cask ${caskName}:`, error)
+
+    return null
+  }
+}
+
+async function getComputerName() {
+  const compName = await execSync("scutil --get ComputerName").toString()
+
+  // remove empty space at end of string
+  return compName.substring(0, compName.length - 1)
+}
+
+async function getBundleIdentifier(appName) {
+  const bundleId = await execSync(
+    `osascript -e 'id of app "${appName}"'`,
+  ).toString()
+
+  // remove empty space at end of string
+  return bundleId.substring(0, bundleId.length - 1)
+}
+
+async function findAppFiles(appName, bundleId) {
+  try {
+    compNameGlob = await getComputerName()
+    const bundleIdComponents = bundleId.split(".")
+
+    const companyDirs = pathLocations.map(
+      (pathLocation) => `${pathLocation}/${bundleIdComponents[1]}`,
+    )
+    const pathsToSearch = [...pathLocations, ...companyDirs]
+    const directoryFilesPromiseArr = pathsToSearch.map((pathLocation) =>
+      fs.readdir(pathLocation),
+    )
+    const directoryFiles = await Promise.allSettled(directoryFilesPromiseArr)
+
+    const patternArray = await getFilePatternArray(appName, bundleId)
+
+    const filesToRemove = new Set([])
+
+    directoryFiles.forEach((dir, index) => {
+      if (dir.status === "fulfilled") {
+        dir.value.forEach((dirFile) => {
+          const dirFileNorm = dirFile.toLowerCase().replace(" ", "")
+          if (isPatternInFile(patternArray, dirFileNorm)) {
+            filesToRemove.add(
+              `${pathsToSearch[parseInt(index, 10)]}/${dirFile}`,
+            )
+          }
+        })
+      }
+    })
+
+    // convert set to array
+    return [...filesToRemove]
+  } catch (err) {
+    console.error(err)
+    throw err
+  }
+}
+
+export { appNameFromPath, getBundleIdentifier, findAppFiles }

package/lib/path-locations.js

@@ -0,0 +1,28 @@
+import { homedir } from "os"
+
+export const pathLocations = [
+  "/Applications",
+  "/private/var/db/receipts",
+  "/Library/LaunchDaemons",
+  `${homedir}/Downloads`,
+  `${homedir}/Library`,
+  `${homedir}/Library/Application Support`,
+  `${homedir}/Library/Application Scripts`,
+  `${homedir}/Library/Application Support/CrashReporter`,
+  `${homedir}/Library/Containers`,
+  `${homedir}/Library/Caches`,
+  `${homedir}/Library/HTTPStorages`,
+  `${homedir}/Library/Group Containers`,
+  `${homedir}/Library/Internet Plug-Ins`,
+  `${homedir}/Library/LaunchAgents`,
+  `${homedir}/Library/Logs`,
+  "/Library/Logs/DiagnosticReports",
+  `${homedir}/Library/Preferences`,
+  `${homedir}/Library/Preferences/ByHost`,
+  `${homedir}/Library/Saved Application State`,
+  `${homedir}/Library/WebKit`,
+  `${homedir}/Library/Caches/com.apple.helpd/Generated`,
+  "/Library/Audio/Plug-Ins/HAL",
+]
+
+export const commonSuffix = ["install"]

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@kud/soap-cli",
+  "version": "1.0.0-4",
+  "description": "An app cleaner cli for macOS",
+  "main": "index.js",
+  "bin": {
+    "soap": "index.js"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "scripts": {
+    "dev": "node ./index.js",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kud/soap.git"
+  },
+  "keywords": [],
+  "author": "Erwann Mest <m@kud.io>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/kud/soap/issues"
+  },
+  "homepage": "https://github.com/kud/soap#readme",
+  "type": "module",
+  "dependencies": {
+    "chalk": "5.3.0",
+    "del": "7.1.0",
+    "inquirer": "9.2.11",
+    "signale": "1.4.0",
+    "trash": "8.1.1",
+    "zx": "7.2.3"
+  },
+  "devDependencies": {}
+}