Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rock3r/deep-clean
When Gradle or the IDE let you down, just --nuke all them caches
https://github.com/rock3r/deep-clean
android androidstudio gradle idea kotlin kotlin-script script
Last synced: 2 days ago
JSON representation
When Gradle or the IDE let you down, just --nuke all them caches
- Host: GitHub
- URL: https://github.com/rock3r/deep-clean
- Owner: rock3r
- License: apache-2.0
- Created: 2018-06-06T12:06:34.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-09-30T15:06:52.000Z (about 2 years ago)
- Last Synced: 2024-12-06T17:27:58.848Z (7 days ago)
- Topics: android, androidstudio, gradle, idea, kotlin, kotlin-script, script
- Language: Kotlin
- Homepage:
- Size: 70.3 KB
- Stars: 933
- Watchers: 11
- Forks: 42
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-kotlin - deep-clean - When Gradle or the IDE let you down, just --nuke all them caches (Libraries)
README
# deep-clean
A Kotlin script that nukes all build caches from Gradle/Android projects.
Useful when Gradle or the IDE let you down 💔
🎩 h/t to [@Takhion](https://github.com/Takhion) for the original idea, and to
[@holgerbrandl](https://github.com/holgerbrandl) for KScript.
The script has been tested on macOS 🍎, but it is completely untested on
Linux 🐧 and Windows 🖥️. KScript may not work at all on Windows!
⚠️There may be [major issues](https://github.com/rock3r/deep-clean/issues/4) on Windows/Linux when using `-n`,
please let me know if you encounter any such issue!
**USE AT YOUR OWN RISK IN ANY CASE!**
## Running the script
`deep-clean` requires three components to be on your `PATH`:
* [`kotlinc`](https://kotlinlang.org/docs/tutorials/command-line.html)
* [`kscript`](https://github.com/holgerbrandl/kscript)
* [`mvn`](https://maven.apache.org/)
If you **have all three commands** on your `PATH`, then you can simply download
and execute the script:
```bash
$ cd /your/project/root.folder
$ [kscript] deep-clean.kts [options]
```
>Note: on macOS and Linux the script does not need `kscript` to be invoked, because
>it has a [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)). On Windows, you
>will need to explicitly specify you want to use `kscript` to run it.
Where the options are:
```
-b --backup Renames files and folders instead of deleting them. Implies
--verbose.
-d --dry-run Don't delete anything. Useful for testing. Implies --verbose.
-i --ide-files This also deletes IDEA/Android Studio project files (*.iml).
If used in conjunction with --nuke it will also delete the
.idea folder in the current directory.
-p --ide-preferences ⚠️ THIS IS DANGEROUS SHIT ⚠️ Will wipe your IDE settings!
This deletes the GLOBAL IDEA/Android Studio preferences.
This option requires the --nuke option to be active too, since
it touches global system state.
--not-recursive Don't recursively search sub-folders of this folder for matches.
The default behaviour is to look for matches in sub-directories,
since things like 'build' folders and '.iml' files are not all
found at the top level of a project directory structure. This
flag is useful if you know you have matches you want to keep,
e.g., if your code contains a package with a name like 'build'.
This option severely limits the effectiveness of the deep clean.
-n --nuke ⚠️ THIS IS DANGEROUS SHIT ⚠️ Super-deep clean
This includes clearing out global folders, including:
* the global Gradle cache
* the global Maven artefacts
* the wrapper-downloaded Gradle distros
* the Gradle daemon data (logs, locks, etc.)
* the Android build cache
Nukes the entire thing from orbit — it's the only way to be sure.
-v --verbose Print detailed information about all commands.
```
For this script to work, you need to have `kotlin`, `kscript` and `maven` on your `PATH`.
If you **DON'T have all three commands** on your `PATH`, then read on to the next
section to install them.
## Installing the script dependencies
To make the script run, we'll first need to install all the required dependencies.
All dependencies are available on [SDKMan!](https://sdkman.io/) (Windows, Linux, macOS).
**Note that KScript support for Windows is not officially available yet**.
```bash
$ sdk install kotlin
$ sdk install maven
$ sdk install kscript
```
## Licence
```
Copyright 2022 Sebastiano Poggi
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
For more information please refer to the [`LICENSE`](LICENSE) file.