Refactor entire codebase for separating logic from commands

[theethernaut]

Planning

Planning document, here.

Following @0x6431346e's proposal on how to separate logic from commands, we're ready to start implementing this in the code.

Preliminary tasks

• Finish merging outstanding PRs: Close low hanging fruit PRs before SDK v7 refactors begin #853
• Finish setting up branching strategy for refactors: Set up branch strategy for SDK v7 refactors #851
• Rebase Refactor token new #856 to master so that it assimilates all the outstanding PR changes
• Merge Refactor token new #856 to the new develop branch

Having completed these preliminary tasks, we're ready to start implementing the refactor, with the following considerations:

• Logic should be extracted to the lib/ folder following the token new command's example (Refactor token new #856).
• Unit tests should be added to all extracted logic, again following the example.
• We shouldn't worry about end-to-end tests for now, but do try to test commands involved with what you're changing before pushing changes.
• Extracted logic should be 100% agnostic, and at most provide updates to the commands using them via callback handlers.
• We can start picking off commands to refactor from the list below, and making independent PRs to the develop branch. Once you pick an issue, add your name next to the item in the list below, or ask one of the repo maintainers to add it for you.

Refactor based on commands

• ⬇️ ⛰️ [ Dev: @dapplion , Reviewers: ? ] start command
• apm commands
  • [ Dev: @ajsantander, Reviewers: @0xGabi ] apm info
  • [ Dev: @ajsantander, Reviewers: @0xGabi, @macor161 ] apm extract-functions
  • [ Dev: @ajsantander, Reviewers: @0xGabi, @dapplion ] apm versions
  • [ Dev: @ajsantander, Reviewers: @0xGabi, @macor161 ] apm packages
• [ Dev: @dapplion, Reviewers: @0xGabi, ] deploy command
• ⬇️ ⛰️ [ Dev: @macor161, Reviewers: ? ] devchain command
• init command (Deprecated, I'll merge a commit that remove this instead)
• middlewares
  • [ Dev: @0x6431346e, Reviewers: @macor161 ] reporter Ready to be merged: Refactor ConsoleReporter #965
  • [ Dev: @dapplion , Reviewers: ? ] manifest
  • [ Dev: @dapplion , Reviewers: ? ] module
  • [ Dev: @dapplion , Reviewers: ? ] environment
• [ Dev: @0x6431346e, Reviewers: @0xGabi , @dapplion ] ipfs command
  • ipfs start command
  • ipfs install command
  • ipfs uninstall command
  • ipfs propagate command
  • ipfs status command
  • ipfs view command
• dao commands
  • [ Dev: @macor161, Reviewers: ? ] dao new command Ready to be merged: Extract logic from "dao apps" and "dao new" #955
  • ⬇️ ⛰️ [ Dev: @macor161, Reviewers: ? ] dao act command
  • [ Dev: @macor161, Reviewers: @0xGabi ] dao apps command Ready to be merged: Extract logic from "dao apps" and "dao new" #955
  • [ Dev: @macor161, Reviewers: @0xGabi ] dao exec command
  • [ Dev: @macor161, Reviewers: @0xGabi ] dao id-assign command
  • [ Dev: @dapplion , Reviewers: ? ] dao install command
  • [ Dev: @ dapplion , Reviewers: ? ] dao upgrade command
  • [ Dev: @0x6431346e, Reviewers: mcormier, ? ] token commands
    • token new command
    • token change-controller command
  • [ Dev: @dapplion, Reviewers: @0xGabi, @macor161 ] acl commands
    • acl create command
    • acl grant command
    • acl remove-manager command
    • acl revoke command
    • acl set-manager command
    • acl view command
• [ Dev: @dapplion, Reviewers: ? ] contracts command

After refactoring the commands

• [ Dev: , Reviewers: ] apm publish
• [ Dev: , Reviewers: ? ] run command
• **[ Dev: ?, Reviewers: ? ]dao commands / utils
• Full review to see if there is still any logic within commands
• Sanitize utilities, making sure they are all bundled nicely in the lib/ folder
• Review unit test coverage in lib/
• Add test on other parts of the codebase (e.g. utils)
• Improve how we handlelistr context variables: SDK: v7 aragonone/product#222 (comment)
• Windows CI
• CI for boilerplates, tutorials
• Review linter configuration and rules (@dapplion)
• Declare yargs commands explicitly instead of with commandDir and order by priority / usage

Suggested next steps

• Create an issue for moving the lib/ folder to a new package so that it can be bootstrapped to use Typescript
• Create an issue to port this lib package to Typescript

[0xGabi]

@dapplion feel free to choose from the list and comment in this issue thread to update the list☝️

[dapplion]

@0xGabi I'll start with acl commands if it's okay.

[dapplion]

I'll take the deploy command too

[ottodevs]

I can take run and contract commands if they are not taken, and also I would be fine being added as a reviewer for any opened PR

[0xGabi]

@dapplion You want to take some of the other middleware tasks?

Note: I plan to push a PR to remove the deprecated code of the network option and init command, probably today. That will be updating a bit the environment middleware logic

[dapplion]

@0xGabi I can tackle the rest of the middleware tasks.

[dapplion]

@ajsantander @0xGabi You can mark the remaining middlewares as downhill

[0xGabi]

I consider this issue done. We tackle most of the tasks and those still not done were decided to address on #947 or move to the developer flow.