Idea: polkadot-dev CLI

[ggwpez]

(Some ideas around a polkadot developer CLI from @shawntabrizi and me)

Currently we use psvm and zepter to help devs get stuff done. Would be nice to have some general CLI that helps devs and bundles the following:

• polkadot-dev format (format everything with the correct nightly rust version)
• polkadot-dev lint features (runs zepter)
• polkadot-dev lint (runs format, zepter and checks that the versions are coherent with psvm)
• polkadot-dev version (command to control the version via psvm)
• polkadot-dev prdoc (generate prdoc with default filled in for all modified crates)
• polkadot-dev help contribute (doc only command to print a checklist on how to contribute)

It could also have functionality to lint FRAME pallets for common mistakes / bugs.

[shawntabrizi]

• Link to zepter: https://github.com/ggwpez/zepter
• Link to psvm: https://github.com/paritytech/psvm
• Link to prdoc: https://github.com/paritytech/prdoc
  • more docs on prdoc: https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/prdoc.md

[shawntabrizi]

polkadot-dev format is intended to run cargo fmt with the correct compiler version. At the time of writing this is cargo +nightly-2024-04-14 fmt.

The CLI will need to sync the right version based on what polkadot-sdk ci/cd expects.

[programskillforverification]

I want to try this one. Please assign to me.

[shawntabrizi]

@programskillforverification Done.

Please keep us updated with your progress and thinking so we can help direct you and give feedback.

[xlc]

sounds like a useful thing, but can we do it elsewhere? i.e. keep the size of this repo manageable
I see no reason to have such tool included in this repo.

[shawntabrizi]

@xlc sure, I think it need not be in this repo. I think this is just a place to track the issue.

[programskillforverification]

@xlc sure, I think it need not be in this repo. I think this is just a place to track the issue.

I am not sure when the new repo is created. Could I open new pr in this repo temporarily? Once new repo created, just migrate files

[xlc]

it doesn't make sense to PR here. just make your own repo and we can see what do to about it later.
if you don't want to put it under your own github account for whatever reason, I can make a repo at https://github.com/open-web3-stack

[YashBit]

@shawntabrizi

Hi, I am new to the polkadot ecosystem.

Just wanted to inquire if there are grants to solve issues. Could we get in touch on discord?

[tmpolaczyk]

If this script will be as simple as a makefile, why not use something standard? I know make sounds pretty bad for a Rust project, but there are many modern rewrites such as just that work pretty well.

https://github.com/casey/just

[shawntabrizi]

We should also add a command which installs the dependencies required to do polkadot-sdk development:

• https://docs.substrate.io/install/

Perhaps polkadot-dev install

[ggwpez]

We should also add a command which installs the dependencies required to do polkadot-sdk development:

Yea we recently added this script: https://github.com/paritytech/polkadot-sdk/blob/master/scripts/getting-started.sh

If this script will be as simple as a makefile, why not use something standard? I know make sounds pretty bad for a Rust project, but there are many modern rewrites such as just that work pretty well.

It should also work outside of the SDK (eg the runtimes repo).

[shawntabrizi]

I imagine the CLI could simply activate:

curl --proto '=https' --tlsv1.2 https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/scripts/getting-started.sh -sSf | sh

Or probably even do a better experience for not currently supported OS like windows.

EDIT: I am not a fan that this script downloads and compiles a minimal template. It doesn't make it just a script for installing dependencies.