dstmodders / mod-sdk

[In development] Mod SDK for the game Don't Starve Together.
https://docs.dstmodders.com/sdk/
MIT License
5 stars 1 forks source link

Add clean Bash script #3

Open victorpopkov opened 2 years ago

victorpopkov commented 2 years ago

Is your feature request related to a problem? Please describe.

I'm always frustrated when it comes to removing all unnecessary files and modules which I'm not planning to use within my mod. For example, whenever I prepare a workshop release I want to have as little code as possible, so I remove everything that I'm not using or is just part of the "junk" like different dotfiles or documentation. It would be nice to have a script that handles this for you.

Describe the solution you'd like

Add a Bash script to clean all unnecessary files based on the provided modules that are being used. It should remove everything except stuff that is essential for an SDK to work and do its job.

Describe alternatives you've considered

Bash script should cover both Linux and macOS and it's easy to implement. For Windows, an alternative should be added like a cmd or a PowerShell script that does the same thing. Right now we use Docker for development, so Bash is part of our tools. Moreover, WSL is also an option when it comes to Windows users. So for now, I think a Bash script is a good compromise between ease of writing and OS coverage.

Additional context

If applicable, add any other context or screenshots about the feature request here.

victorpopkov commented 2 years ago

Most likely, the following feature will be superseded by dstmodders/mod-cli due to cross-platforminess instead of using Bash script. However, adding SDK-related functionality is still in plans.