appclean 1.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (154) hide show
  1. package/.github/workflows/publish.yml +41 -0
  2. package/.github/workflows/test.yml +37 -0
  3. package/ACTION_CHECKLIST.md +342 -0
  4. package/APPCLEAN_SUMMARY.md +309 -0
  5. package/CHANGELOG.md +205 -0
  6. package/CODE_OF_CONDUCT.md +49 -0
  7. package/CODE_REVIEW_REPORT.md +447 -0
  8. package/COMMUNITY_POSTS.md +307 -0
  9. package/CONTRIBUTING.md +121 -0
  10. package/DEPLOYMENT_GUIDE.md +345 -0
  11. package/DEPLOYMENT_STATUS.md +182 -0
  12. package/EXECUTIVE_REPORT.md +393 -0
  13. package/GITHUB_OPTIMIZATION.md +383 -0
  14. package/INDEX.md +165 -0
  15. package/LICENSE +21 -0
  16. package/MARKETING_SUMMARY.md +352 -0
  17. package/NPM_PACKAGE_OPTIMIZATION.md +281 -0
  18. package/NPM_PUBLISH.md +116 -0
  19. package/PROJECT_SUMMARY.txt +249 -0
  20. package/QUICKSTART.md +219 -0
  21. package/README.md +548 -0
  22. package/SECURITY.md +104 -0
  23. package/SETUP_GITHUB.md +237 -0
  24. package/TESTING_SUMMARY.md +379 -0
  25. package/dist/core/appUpdateChecker.d.ts +23 -0
  26. package/dist/core/appUpdateChecker.d.ts.map +1 -0
  27. package/dist/core/appUpdateChecker.js +159 -0
  28. package/dist/core/appUpdateChecker.js.map +1 -0
  29. package/dist/core/detector.d.ts +13 -0
  30. package/dist/core/detector.d.ts.map +1 -0
  31. package/dist/core/detector.js +99 -0
  32. package/dist/core/detector.js.map +1 -0
  33. package/dist/core/duplicateFileFinder.d.ts +14 -0
  34. package/dist/core/duplicateFileFinder.d.ts.map +1 -0
  35. package/dist/core/duplicateFileFinder.js +80 -0
  36. package/dist/core/duplicateFileFinder.js.map +1 -0
  37. package/dist/core/orphanedDependencyDetector.d.ts +19 -0
  38. package/dist/core/orphanedDependencyDetector.d.ts.map +1 -0
  39. package/dist/core/orphanedDependencyDetector.js +148 -0
  40. package/dist/core/orphanedDependencyDetector.js.map +1 -0
  41. package/dist/core/performanceOptimizer.d.ts +37 -0
  42. package/dist/core/performanceOptimizer.d.ts.map +1 -0
  43. package/dist/core/performanceOptimizer.js +128 -0
  44. package/dist/core/performanceOptimizer.js.map +1 -0
  45. package/dist/core/permissionHandler.d.ts +9 -0
  46. package/dist/core/permissionHandler.d.ts.map +1 -0
  47. package/dist/core/permissionHandler.js +89 -0
  48. package/dist/core/permissionHandler.js.map +1 -0
  49. package/dist/core/pluginSystem.d.ts +39 -0
  50. package/dist/core/pluginSystem.d.ts.map +1 -0
  51. package/dist/core/pluginSystem.js +120 -0
  52. package/dist/core/pluginSystem.js.map +1 -0
  53. package/dist/core/removalRecorder.d.ts +32 -0
  54. package/dist/core/removalRecorder.d.ts.map +1 -0
  55. package/dist/core/removalRecorder.js +79 -0
  56. package/dist/core/removalRecorder.js.map +1 -0
  57. package/dist/core/remover.d.ts +15 -0
  58. package/dist/core/remover.d.ts.map +1 -0
  59. package/dist/core/remover.js +225 -0
  60. package/dist/core/remover.js.map +1 -0
  61. package/dist/core/reportGenerator.d.ts +9 -0
  62. package/dist/core/reportGenerator.d.ts.map +1 -0
  63. package/dist/core/reportGenerator.js +328 -0
  64. package/dist/core/reportGenerator.js.map +1 -0
  65. package/dist/core/scheduledCleanup.d.ts +38 -0
  66. package/dist/core/scheduledCleanup.d.ts.map +1 -0
  67. package/dist/core/scheduledCleanup.js +127 -0
  68. package/dist/core/scheduledCleanup.js.map +1 -0
  69. package/dist/core/serviceFileDetector.d.ts +18 -0
  70. package/dist/core/serviceFileDetector.d.ts.map +1 -0
  71. package/dist/core/serviceFileDetector.js +136 -0
  72. package/dist/core/serviceFileDetector.js.map +1 -0
  73. package/dist/core/verificationModule.d.ts +14 -0
  74. package/dist/core/verificationModule.d.ts.map +1 -0
  75. package/dist/core/verificationModule.js +102 -0
  76. package/dist/core/verificationModule.js.map +1 -0
  77. package/dist/index.d.ts +3 -0
  78. package/dist/index.d.ts.map +1 -0
  79. package/dist/index.js +333 -0
  80. package/dist/index.js.map +1 -0
  81. package/dist/managers/brewManager.d.ts +10 -0
  82. package/dist/managers/brewManager.d.ts.map +1 -0
  83. package/dist/managers/brewManager.js +130 -0
  84. package/dist/managers/brewManager.js.map +1 -0
  85. package/dist/managers/customManager.d.ts +8 -0
  86. package/dist/managers/customManager.d.ts.map +1 -0
  87. package/dist/managers/customManager.js +139 -0
  88. package/dist/managers/customManager.js.map +1 -0
  89. package/dist/managers/linuxManager.d.ts +10 -0
  90. package/dist/managers/linuxManager.d.ts.map +1 -0
  91. package/dist/managers/linuxManager.js +191 -0
  92. package/dist/managers/linuxManager.js.map +1 -0
  93. package/dist/managers/npmManager.d.ts +10 -0
  94. package/dist/managers/npmManager.d.ts.map +1 -0
  95. package/dist/managers/npmManager.js +119 -0
  96. package/dist/managers/npmManager.js.map +1 -0
  97. package/dist/types/index.d.ts +44 -0
  98. package/dist/types/index.d.ts.map +1 -0
  99. package/dist/types/index.js +3 -0
  100. package/dist/types/index.js.map +1 -0
  101. package/dist/ui/guiServer.d.ts +10 -0
  102. package/dist/ui/guiServer.d.ts.map +1 -0
  103. package/dist/ui/guiServer.js +134 -0
  104. package/dist/ui/guiServer.js.map +1 -0
  105. package/dist/ui/menu.d.ts +6 -0
  106. package/dist/ui/menu.d.ts.map +1 -0
  107. package/dist/ui/menu.js +93 -0
  108. package/dist/ui/menu.js.map +1 -0
  109. package/dist/ui/prompts.d.ts +13 -0
  110. package/dist/ui/prompts.d.ts.map +1 -0
  111. package/dist/ui/prompts.js +161 -0
  112. package/dist/ui/prompts.js.map +1 -0
  113. package/dist/utils/filesystem.d.ts +13 -0
  114. package/dist/utils/filesystem.d.ts.map +1 -0
  115. package/dist/utils/filesystem.js +152 -0
  116. package/dist/utils/filesystem.js.map +1 -0
  117. package/dist/utils/logger.d.ts +12 -0
  118. package/dist/utils/logger.d.ts.map +1 -0
  119. package/dist/utils/logger.js +49 -0
  120. package/dist/utils/logger.js.map +1 -0
  121. package/dist/utils/platform.d.ts +9 -0
  122. package/dist/utils/platform.d.ts.map +1 -0
  123. package/dist/utils/platform.js +75 -0
  124. package/dist/utils/platform.js.map +1 -0
  125. package/jest.config.js +20 -0
  126. package/logo.svg +60 -0
  127. package/package.json +55 -0
  128. package/setup-github.sh +125 -0
  129. package/src/core/appUpdateChecker.ts +220 -0
  130. package/src/core/detector.ts +133 -0
  131. package/src/core/duplicateFileFinder.ts +113 -0
  132. package/src/core/orphanedDependencyDetector.ts +195 -0
  133. package/src/core/performanceOptimizer.ts +209 -0
  134. package/src/core/permissionHandler.ts +121 -0
  135. package/src/core/pluginSystem.ts +194 -0
  136. package/src/core/removalRecorder.ts +146 -0
  137. package/src/core/remover.ts +280 -0
  138. package/src/core/reportGenerator.ts +354 -0
  139. package/src/core/scheduledCleanup.ts +204 -0
  140. package/src/core/serviceFileDetector.ts +181 -0
  141. package/src/core/verificationModule.ts +140 -0
  142. package/src/index.ts +449 -0
  143. package/src/managers/brewManager.ts +149 -0
  144. package/src/managers/customManager.ts +167 -0
  145. package/src/managers/linuxManager.ts +210 -0
  146. package/src/managers/npmManager.ts +137 -0
  147. package/src/types/index.ts +59 -0
  148. package/src/ui/guiServer.ts +155 -0
  149. package/src/ui/menu.ts +100 -0
  150. package/src/ui/prompts.ts +177 -0
  151. package/src/utils/filesystem.ts +145 -0
  152. package/src/utils/logger.ts +48 -0
  153. package/src/utils/platform.ts +75 -0
  154. package/tsconfig.json +20 -0
package/NPM_PUBLISH.md ADDED
@@ -0,0 +1,116 @@
1
+ # ๐Ÿ“ฆ Publishing AppClean to npm
2
+
3
+ Your AppClean is ready to be published to npm! Follow these simple steps to publish your package.
4
+
5
+ ## โœ… What's Ready
6
+
7
+ - โœ… Code is complete and built
8
+ - โœ… GitHub repository is public: https://github.com/praveenkay/AppClean
9
+ - โœ… Version tagged as v1.0.0
10
+ - โœ… README updated with professional design
11
+ - โœ… Logo added
12
+ - โœ… All documentation in place
13
+
14
+ ## ๐Ÿš€ How to Publish to npm
15
+
16
+ ### Step 1: Create npm Account (if you don't have one)
17
+
18
+ 1. Visit https://www.npmjs.com/signup
19
+ 2. Sign up with your email
20
+ 3. Verify your email address
21
+
22
+ ### Step 2: Login to npm (One-time)
23
+
24
+ ```bash
25
+ npm login
26
+ ```
27
+
28
+ You'll be prompted for:
29
+ - **Username**: Your npm username
30
+ - **Password**: Your npm password
31
+ - **Email**: Your email address
32
+ - **OTP** (if 2FA is enabled): Enter the code from your authenticator
33
+
34
+ ### Step 3: Verify Login
35
+
36
+ ```bash
37
+ npm whoami
38
+ ```
39
+
40
+ This should display your npm username if you're logged in.
41
+
42
+ ### Step 4: Publish to npm
43
+
44
+ Navigate to the project directory and run:
45
+
46
+ ```bash
47
+ cd /tmp/appclean
48
+ npm publish
49
+ ```
50
+
51
+ ### Success!
52
+
53
+ Once published, users can install AppClean with:
54
+
55
+ ```bash
56
+ npm install -g appclean
57
+ ```
58
+
59
+ Your package will be available at:
60
+ - **npm**: https://npmjs.com/package/appclean
61
+ - **GitHub**: https://github.com/praveenkay/AppClean
62
+
63
+ ## ๐Ÿ“ Future Releases
64
+
65
+ To release a new version in the future:
66
+
67
+ ```bash
68
+ # Update version (patch, minor, or major)
69
+ npm version patch
70
+
71
+ # Push to GitHub
72
+ git push origin main
73
+ git push origin v1.0.1
74
+
75
+ # Publish to npm
76
+ npm publish
77
+ ```
78
+
79
+ ## ๐Ÿ”‘ API Token (Alternative Method)
80
+
81
+ If you prefer using an API token instead of your password:
82
+
83
+ 1. Go to https://www.npmjs.com/settings/tokens
84
+ 2. Create a new "Automation" token
85
+ 3. Create `.npmrc` file in your home directory:
86
+
87
+ ```bash
88
+ echo "//registry.npmjs.org/:_authToken=YOUR_TOKEN_HERE" > ~/.npmrc
89
+ ```
90
+
91
+ 4. Then run: `npm publish`
92
+
93
+ ## โœจ What Happens After Publishing
94
+
95
+ 1. Package becomes available on npm registry
96
+ 2. Users can install with `npm install -g appclean`
97
+ 3. GitHub Actions will auto-publish future releases when you tag
98
+
99
+ ## ๐ŸŽฏ Quick Checklist
100
+
101
+ - [ ] Create npm account at https://npmjs.com
102
+ - [ ] Run `npm login` to authenticate
103
+ - [ ] Run `npm whoami` to verify
104
+ - [ ] Run `npm publish` to publish
105
+ - [ ] Visit https://npmjs.com/package/appclean to verify
106
+ - [ ] Test installation: `npm install -g appclean`
107
+
108
+ ## ๐Ÿ“ž Need Help?
109
+
110
+ - **npm Documentation**: https://docs.npmjs.com
111
+ - **npm CLI Docs**: https://docs.npmjs.com/cli-documentation
112
+ - **GitHub Releases**: https://github.com/praveenkay/AppClean/releases
113
+
114
+ ---
115
+
116
+ **Your AppClean is ready! Just follow the 4 steps above to publish.** ๐Ÿš€
@@ -0,0 +1,249 @@
1
+ โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
2
+ โ•‘ โ•‘
3
+ โ•‘ โœจ AppClean - PROJECT COMPLETE โœจ โ•‘
4
+ โ•‘ Intelligent Application Uninstaller โ•‘
5
+ โ•‘ โ•‘
6
+ โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•
7
+
8
+ ๐Ÿ“ PROJECT LOCATION: /tmp/appclean/
9
+
10
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
11
+ ๐Ÿ“Š PROJECT STATISTICS
12
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
13
+
14
+ โœ… Source Files: 13 TypeScript files
15
+ โœ… Total Lines: 2,800+ lines of code
16
+ โœ… Configuration Files: 4 (tsconfig, package.json, jest, .gitignore)
17
+ โœ… Documentation Files: 6 comprehensive guides
18
+ โœ… GitHub Actions: 2 automated workflows
19
+ โœ… License: MIT (open-source)
20
+ โœ… Git: Initialized with initial commit
21
+
22
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
23
+ ๐Ÿ“ฆ FEATURES IMPLEMENTED
24
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
25
+
26
+ ๐Ÿ” Smart Detection:
27
+ โ€ข npm, yarn, pnpm packages
28
+ โ€ข Homebrew (macOS/Linux)
29
+ โ€ข Linux package managers (apt, yum, dnf)
30
+ โ€ข Custom binary installers
31
+ โ€ข Total: 8+ package managers
32
+
33
+ ๐ŸŽฏ Core Functionality:
34
+ โ€ข Interactive CLI menu interface
35
+ โ€ข Search & filter applications
36
+ โ€ข Deep artifact scanning (configs, caches, logs)
37
+ โ€ข Safe removal with dry-run preview
38
+ โ€ข Backup creation before deletion
39
+ โ€ข Double confirmation for safety
40
+ โ€ข Rollback from backups
41
+
42
+ โš™๏ธ Installation Methods:
43
+ โœ“ npm/yarn/pnpm โœ“ Custom scripts
44
+ โœ“ Homebrew โœ“ Bash installers
45
+ โœ“ apt โœ“ Wget/curl downloads
46
+ โœ“ yum/dnf
47
+
48
+ ๐Ÿ’ป Platform Support:
49
+ โœ“ macOS (Intel & ARM) โœ“ Linux (Ubuntu, Debian, Fedora, etc.)
50
+ โœ“ Windows 10/11 โœ“ Cross-platform code
51
+
52
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
53
+ ๐Ÿ“ PROJECT STRUCTURE
54
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
55
+
56
+ appclean/
57
+ โ”œโ”€โ”€ src/
58
+ โ”‚ โ”œโ”€โ”€ index.ts ..................... Main CLI entry point
59
+ โ”‚ โ”œโ”€โ”€ core/
60
+ โ”‚ โ”‚ โ”œโ”€โ”€ detector.ts .............. App detection engine
61
+ โ”‚ โ”‚ โ””โ”€โ”€ remover.ts ............... Safe removal engine
62
+ โ”‚ โ”œโ”€โ”€ managers/
63
+ โ”‚ โ”‚ โ”œโ”€โ”€ npmManager.ts ............ npm/yarn/pnpm support
64
+ โ”‚ โ”‚ โ”œโ”€โ”€ brewManager.ts ........... Homebrew support
65
+ โ”‚ โ”‚ โ”œโ”€โ”€ linuxManager.ts .......... apt/yum/dnf support
66
+ โ”‚ โ”‚ โ””โ”€โ”€ customManager.ts ......... Custom installers
67
+ โ”‚ โ”œโ”€โ”€ ui/
68
+ โ”‚ โ”‚ โ”œโ”€โ”€ menu.ts .................. Interactive menus
69
+ โ”‚ โ”‚ โ””โ”€โ”€ prompts.ts ............... User prompts
70
+ โ”‚ โ”œโ”€โ”€ types/
71
+ โ”‚ โ”‚ โ””โ”€โ”€ index.ts ................. TypeScript interfaces
72
+ โ”‚ โ””โ”€โ”€ utils/
73
+ โ”‚ โ”œโ”€โ”€ platform.ts .............. Platform detection
74
+ โ”‚ โ”œโ”€โ”€ filesystem.ts ............ File operations
75
+ โ”‚ โ””โ”€โ”€ logger.ts ................ Logging
76
+ โ”‚
77
+ โ”œโ”€โ”€ .github/workflows/
78
+ โ”‚ โ”œโ”€โ”€ test.yml ..................... Automated testing (CI)
79
+ โ”‚ โ””โ”€โ”€ publish.yml .................. npm publishing (CD)
80
+ โ”‚
81
+ โ”œโ”€โ”€ Configuration
82
+ โ”‚ โ”œโ”€โ”€ package.json ................. Project metadata
83
+ โ”‚ โ”œโ”€โ”€ tsconfig.json ................ TypeScript config
84
+ โ”‚ โ”œโ”€โ”€ jest.config.js ............... Test configuration
85
+ โ”‚ โ””โ”€โ”€ .gitignore ................... Git ignore rules
86
+ โ”‚
87
+ โ””โ”€โ”€ Documentation
88
+ โ”œโ”€โ”€ README.md .................... User guide
89
+ โ”œโ”€โ”€ SETUP_GITHUB.md .............. GitHub deployment
90
+ โ”œโ”€โ”€ DEPLOYMENT_GUIDE.md .......... Deployment checklist
91
+ โ”œโ”€โ”€ QUICKSTART.md ................ Quick start
92
+ โ”œโ”€โ”€ CONTRIBUTING.md .............. Dev guidelines
93
+ โ”œโ”€โ”€ CHANGELOG.md ................. Version history
94
+ โ””โ”€โ”€ LICENSE ...................... MIT License
95
+
96
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
97
+ ๐Ÿš€ QUICK START COMMANDS
98
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
99
+
100
+ # Install dependencies
101
+ cd /tmp/appclean
102
+ npm install
103
+
104
+ # Build the project
105
+ npm run build
106
+
107
+ # Run interactively
108
+ npm run dev
109
+
110
+ # List all apps
111
+ npm run dev -- list
112
+
113
+ # Search for an app
114
+ npm run dev -- search nodejs
115
+
116
+ # Remove with dry-run (preview only)
117
+ npm run dev -- remove myapp --dry-run
118
+
119
+ # Run tests
120
+ npm test
121
+
122
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
123
+ ๐Ÿ“ค DEPLOYMENT IN 3 STEPS
124
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
125
+
126
+ 1๏ธโƒฃ CREATE GITHUB REPO
127
+ โ€ข Go to https://github.com/new
128
+ โ€ข Name: appclean
129
+ โ€ข Select "Public"
130
+ โ€ข Copy the repository URL
131
+
132
+ 2๏ธโƒฃ PUSH TO GITHUB
133
+ cd /tmp/appclean
134
+ git remote add origin https://github.com/YOUR_USERNAME/appclean.git
135
+ git branch -m master main
136
+ git push -u origin main
137
+
138
+ 3๏ธโƒฃ PUBLISH TO NPM
139
+ npm login
140
+ git tag v1.0.0
141
+ git push origin v1.0.0
142
+ npm publish
143
+
144
+ ๐Ÿ‘‰ See SETUP_GITHUB.md for detailed instructions!
145
+
146
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
147
+ โœจ KEY FEATURES
148
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
149
+
150
+ ๐Ÿ” SMART DETECTION
151
+ Finds apps installed via npm, brew, apt, custom installers
152
+ Shows exact installation method and version
153
+
154
+ ๐Ÿ“Š COMPLETE ANALYSIS
155
+ Locates all related files including:
156
+ โ€ข Binaries and executables
157
+ โ€ข Configuration files
158
+ โ€ข Cache directories
159
+ โ€ข Data files and logs
160
+ โ€ข Service files (systemd, LaunchAgents)
161
+
162
+ ๐Ÿ›ก๏ธ SAFE REMOVAL
163
+ โ€ข Dry-run preview before deletion
164
+ โ€ข Double confirmation required
165
+ โ€ข Optional backup creation
166
+ โ€ข Detailed error reporting
167
+ โ€ข Rollback support
168
+
169
+ ๐ŸŽฏ USER-FRIENDLY
170
+ โ€ข Beautiful interactive menu interface
171
+ โ€ข Colored output and progress indicators
172
+ โ€ข Clear error messages
173
+ โ€ข Cross-platform support
174
+ โ€ข Works on macOS, Linux, Windows
175
+
176
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
177
+ ๐Ÿ“š DOCUMENTATION
178
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
179
+
180
+ ๐Ÿ“– README.md
181
+ User-facing documentation with examples and features
182
+
183
+ ๐Ÿš€ QUICKSTART.md
184
+ Quick start guide for developers
185
+
186
+ ๐Ÿ“ค SETUP_GITHUB.md
187
+ Step-by-step GitHub repository setup and npm publishing
188
+
189
+ โœ… DEPLOYMENT_GUIDE.md
190
+ Complete deployment checklist and verification steps
191
+
192
+ ๐Ÿ‘จโ€๐Ÿ’ป CONTRIBUTING.md
193
+ Guidelines for developers contributing to the project
194
+
195
+ ๐Ÿ“‹ CHANGELOG.md
196
+ Version history and planned features
197
+
198
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
199
+ ๐Ÿ” SECURITY & SAFETY
200
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
201
+
202
+ โœ“ Dry-run preview (shows what will be deleted)
203
+ โœ“ Double confirmation before actual removal
204
+ โœ“ Backup creation before deletion
205
+ โœ“ Rollback capability
206
+ โœ“ Permission checking
207
+ โœ“ Error handling and reporting
208
+ โœ“ Cross-platform safe paths
209
+ โœ“ No automatic operations
210
+
211
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
212
+ ๐Ÿ’พ WHAT'S INCLUDED
213
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
214
+
215
+ โœ… Production-ready TypeScript code
216
+ โœ… Interactive CLI with beautiful UI
217
+ โœ… 4 package manager integrations
218
+ โœ… Cross-platform support
219
+ โœ… Comprehensive error handling
220
+ โœ… GitHub Actions CI/CD workflows
221
+ โœ… npm publishing configuration
222
+ โœ… Complete documentation
223
+ โœ… Test setup with Jest
224
+ โœ… Git repository initialized
225
+
226
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
227
+ ๐ŸŽฏ NEXT STEPS
228
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
229
+
230
+ 1. Read QUICKSTART.md or SETUP_GITHUB.md
231
+ 2. Create GitHub repository
232
+ 3. Update package.json with your info
233
+ 4. Push code to GitHub
234
+ 5. Create npm account and token
235
+ 6. Publish to npm registry
236
+ 7. Announce to community
237
+
238
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
239
+
240
+ ๐ŸŽ‰ Your AppClean project is ready for deployment!
241
+
242
+ ๐Ÿ“– Start with: SETUP_GITHUB.md or QUICKSTART.md
243
+ ๐Ÿš€ Location: /tmp/appclean/
244
+ ๐Ÿ’ป Language: TypeScript + Node.js
245
+ ๐Ÿ“ฆ Distribution: npm registry
246
+
247
+ Good luck! ๐ŸŒŸ
248
+
249
+ โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”
package/QUICKSTART.md ADDED
@@ -0,0 +1,219 @@
1
+ # AppClean - Quick Start Guide
2
+
3
+ Your complete AppClean application is ready! Here's what to do next.
4
+
5
+ ## ๐Ÿ“‚ What You Have
6
+
7
+ A fully functional, production-ready CLI application located at `/tmp/appclean/` with:
8
+
9
+ โœ… **2,800+ lines of TypeScript code**
10
+ โœ… **25 source files** organized professionally
11
+ โœ… **Interactive CLI interface** with beautiful menus
12
+ โœ… **4 package manager integrations** (npm, Homebrew, apt, custom)
13
+ โœ… **Complete documentation** and examples
14
+ โœ… **GitHub Actions CI/CD** ready to go
15
+ โœ… **npm publishing** configured
16
+
17
+ ## ๐Ÿš€ Quick Deployment (3 Steps)
18
+
19
+ ### 1. Create GitHub Repository
20
+
21
+ ```bash
22
+ # Go to https://github.com/new
23
+ # Fill in:
24
+ # - Name: appclean
25
+ # - Description: A powerful CLI tool to intelligently find and safely uninstall applications
26
+ # - Public
27
+ # Click "Create repository"
28
+ ```
29
+
30
+ ### 2. Push Code to GitHub
31
+
32
+ ```bash
33
+ cd /tmp/appclean
34
+
35
+ # Replace YOUR_USERNAME with your GitHub username
36
+ git remote add origin https://github.com/YOUR_USERNAME/appclean.git
37
+ git branch -m master main
38
+ git push -u origin main
39
+ ```
40
+
41
+ ### 3. Publish to npm
42
+
43
+ ```bash
44
+ # Login to npm (one time)
45
+ npm login
46
+
47
+ # Create a version tag and publish
48
+ git tag v1.0.0
49
+ git push origin v1.0.0
50
+ npm publish
51
+ ```
52
+
53
+ **That's it!** Your app is now on GitHub and npm! ๐ŸŽ‰
54
+
55
+ ## ๐Ÿ“– Documentation Files
56
+
57
+ | File | Purpose |
58
+ |------|---------|
59
+ | `README.md` | User documentation & installation guide |
60
+ | `SETUP_GITHUB.md` | **Detailed GitHub deployment steps** |
61
+ | `DEPLOYMENT_GUIDE.md` | **Complete deployment checklist** |
62
+ | `CONTRIBUTING.md` | Developer contribution guidelines |
63
+ | `CHANGELOG.md` | Version history |
64
+
65
+ ## ๐Ÿ” Core Files
66
+
67
+ | File | Purpose |
68
+ |------|---------|
69
+ | `src/index.ts` | Main CLI entry point & commands |
70
+ | `src/core/detector.ts` | App detection engine |
71
+ | `src/core/remover.ts` | Safe removal engine |
72
+ | `src/managers/*.ts` | Package manager integrations |
73
+ | `src/ui/*.ts` | Interactive menu interface |
74
+
75
+ ## ๐Ÿงช Test Locally First
76
+
77
+ ```bash
78
+ cd /tmp/appclean
79
+
80
+ # Install dependencies
81
+ npm install
82
+
83
+ # Build the code
84
+ npm run build
85
+
86
+ # Run interactive mode
87
+ npm run dev
88
+
89
+ # Test commands
90
+ npm run dev -- search npm
91
+ npm run dev -- list
92
+ npm run dev -- analyze lodash
93
+ npm run dev -- remove myapp --dry-run
94
+ ```
95
+
96
+ ## ๐Ÿ“‹ Full Checklist
97
+
98
+ - [ ] Run tests locally: `npm test`
99
+ - [ ] Verify build: `npm run build`
100
+ - [ ] Update `package.json` with your info
101
+ - [ ] Create GitHub repository
102
+ - [ ] Push code to GitHub
103
+ - [ ] Setup npm account (https://npmjs.com)
104
+ - [ ] Create npm API token
105
+ - [ ] Run `npm login`
106
+ - [ ] Tag version: `git tag v1.0.0`
107
+ - [ ] Publish: `npm publish`
108
+ - [ ] Add GitHub Actions secret `NPM_TOKEN`
109
+ - [ ] Update GitHub repository topics
110
+
111
+ ## ๐Ÿ’ก CLI Commands
112
+
113
+ ```bash
114
+ # Interactive mode
115
+ appclean
116
+
117
+ # Search for apps
118
+ appclean search nodejs
119
+
120
+ # List all apps
121
+ appclean list
122
+
123
+ # View app details
124
+ appclean analyze my-app
125
+
126
+ # Remove with preview
127
+ appclean remove my-app --dry-run
128
+
129
+ # Remove with backup
130
+ appclean remove my-app --backup
131
+
132
+ # Remove without confirmations
133
+ appclean remove my-app --force
134
+ ```
135
+
136
+ ## ๐ŸŽฏ Key Features Users Will Love
137
+
138
+ โœจ **Intelligent Detection**
139
+ - Finds apps from 8+ installation methods
140
+ - Shows exactly how each app was installed
141
+
142
+ โœจ **Safe Removal**
143
+ - Preview before deleting with `--dry-run`
144
+ - Double confirmation before actual removal
145
+ - Optional backup creation
146
+
147
+ โœจ **Complete Cleanup**
148
+ - Finds all related files (configs, caches, logs)
149
+ - Removes service files and launch agents
150
+ - Cleans up hidden files too
151
+
152
+ โœจ **Beautiful Interface**
153
+ - Interactive menus (similar to Mole)
154
+ - Colored output and progress spinners
155
+ - Clear error messages
156
+
157
+ ## ๐Ÿ“ฆ Installation for Users (After Publishing)
158
+
159
+ ```bash
160
+ # Users can install from npm
161
+ npm install -g appclean
162
+
163
+ # And run immediately
164
+ appclean
165
+ ```
166
+
167
+ ## ๐Ÿ”— Resources
168
+
169
+ - **GitHub Docs**: https://docs.github.com/en/repositories/creating-and-managing-repositories
170
+ - **npm Publishing**: https://docs.npmjs.com/packages-and-modules/contributing-packages-to-the-registry
171
+ - **TypeScript**: https://www.typescriptlang.org/docs/
172
+
173
+ ## โš ๏ธ Important Notes
174
+
175
+ 1. **Read SETUP_GITHUB.md** for detailed step-by-step instructions
176
+ 2. **Update package.json** with your name and contact info
177
+ 3. **Test locally** before pushing to GitHub
178
+ 4. **Create GitHub Actions secret** for npm publishing automation
179
+ 5. **Update repository topics** for discoverability
180
+
181
+ ## ๐ŸŽฌ Workflow After Publishing
182
+
183
+ ```
184
+ Write Code โ†’ Commit โ†’ Tag Release โ†’ Push Tag
185
+ โ†“
186
+ GitHub Actions Workflow Runs
187
+ โ†“
188
+ Build & Test
189
+ โ†“
190
+ Publish to npm
191
+ โ†“
192
+ Create GitHub Release
193
+ โ†“
194
+ Users can install!
195
+ ```
196
+
197
+ ## ๐Ÿ“ž Next Steps
198
+
199
+ 1. **Read**: `SETUP_GITHUB.md` (detailed instructions)
200
+ 2. **Create**: GitHub repository
201
+ 3. **Update**: `package.json` with your info
202
+ 4. **Push**: Code to GitHub
203
+ 5. **Publish**: To npm registry
204
+ 6. **Announce**: Share with the community
205
+
206
+ ## ๐ŸŒŸ Tips for Success
207
+
208
+ - Start with `--dry-run` option for new users
209
+ - Include clear examples in README
210
+ - Respond to GitHub issues quickly
211
+ - Accept pull requests and contributions
212
+ - Release updates regularly
213
+ - Monitor npm trending page
214
+
215
+ ---
216
+
217
+ **You're all set! Follow SETUP_GITHUB.md to deploy.** ๐Ÿš€
218
+
219
+ Questions? Check the documentation files in the project root.