✨ Assistive scripts for contributors

raxhvl commented 7 months ago

Description

Closes #11. Introduces an optional scripts to help migrate Solady content to Soledge. Offers previews and requires user confirmation before updating. Includes a reminder to double-check before committing. No external dependency.

Usage

npm run powerup

Screenshot from 2024-02-02 18-37-44

npm run rebrand

Screenshot from 2024-02-02 18-33-41

Updates

Following files added to scripts:

utils
├─ config.js — "All script configuration, prime one being the latest supported solidity version."
├─ io.js — "Util script for I/O operations"
├─ powerup.js - "An assistive file to quickly update solidity version"
└─ rebrand.js - "An assistive file for rebranding from solady to soledge"

atarpara commented 7 months ago

@raxhvl Thanks for the PR. I have some suggestions regarding the scripts. Please consolidate all scripts into a single file and make it compatible with the command-line interface (CLI) for easier execution by developers. This way, we only need to maintain one file for automating tasks.

raxhvl commented 7 months ago

make it compatible with the command-line interface (CLI) for easier execution by developers

Could you please elaborate what interface are you looking for? Currently these are CLI compatible via npm scripts :

npm run powerup

npm run rebrand

Do you mean standalone script via node <script.js> <command>? Please spec out the interface and I'll modify the code.

Vectorized commented 7 months ago

Looks good to me.

Let me marinate for a few days first.

Vectorized / soledge