will-smith11 / sks

Submodules Kill Solidity

sks (Submodules Kill Solidity)

Lets face it.. Foundry submodules are terrible. This is a simple cli that acts as a basic package manager to avoid this issue

NOTE

This currently only works for Foundry repos. The way we store modules is still very inefficent and we don't do versioning. use at own risk

Installation

Clone the repo then run our install script

git clone https://github.com/Will-Smith11/sks.git
cd sks
sudo chmod +x sks_install
./sks_install

Usage

Simply create a sks.toml file in the root directory the file layout is as such

name = "EpicTest"

[deps]
uniswap_v2_core = "https://github.com/Uniswap/v2-core.git"

to install simply run sks install to clean out the directory run sks clean the name of the deps are what the remapping names will be in foundry when you import them

sks's Issues

`sks clean` does not remove items from the `foundry.toml` remappings

fix: allow projects who use sks as a dep to be used as a dep

currently if we have a project that is using sks. we can't have a project dep that also uses sks. we should fix this

feat: drop foundry dep

currently we're lazy and use a foundry dep to load config and deal with remappings. we can drop this and it will allow us to post this to crates rs

feat: making fetching parallelized

feat: add versioning

lets add the ability to lock to a release tag.

feat: don't reinstall installed deps

currently we reinstall deps that we already have. this makes the install process slow. we should try to avoid this

bug: `foundry.toml` behaves unexpectedly

Problem

• When I use sks install with my sks.toml set like so:

name = "contracts/"

[deps]
uniswap_v2_core = "https://github.com/Uniswap/v2-core.git"

I get a lot of extra additions to my foundry.toml. Are each one of these intended? I was expecting to have the remappings populated, but there is a bunch more.

• #5

---

Questions

• Which parts above are intended?
• Should the name field of the sks.toml be named directory or something instead? It wasn't clear to me this was for that until I ran sks install!