Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename snforge init to snforge new #2645

Closed
cptartur opened this issue Nov 5, 2024 · 2 comments · Fixed by #2770
Closed

Rename snforge init to snforge new #2645

cptartur opened this issue Nov 5, 2024 · 2 comments · Fixed by #2770
Assignees
Labels
feature New feature request/description snforge

Comments

@cptartur
Copy link
Member

cptartur commented Nov 5, 2024

snforge init behaves like snforge new - it creates a new directory instead of initializing an already existing one.

It should be renamed to snforge new.

This should be done in a non-breaking manner: Deprecated snforge init while adding new and only remove init after some time has passed since deprecation.

In the scope of this issue ensure that scarb init and scarb new works correctly when choosing the snforge test runner. Currently there is a problem with creating a new project when current working directory name is different than the provided name with the --name flag. Please see software-mansion/scarb#1759 for reference.

@cptartur cptartur converted this from a draft issue Nov 5, 2024
@github-actions github-actions bot added the new label Nov 5, 2024
@cptartur cptartur changed the title Rename snforge init to sncast new Rename snforge init to snforge new Nov 5, 2024
@akintewe
Copy link

akintewe commented Nov 5, 2024

hello @cptartur Can i please be assigned this issue

I will make the desired adjustments to rename the snforge init command as snforge new in a backwards-compatible manner. Here's how I plan to do it:

First, I will add the new snforge new command, which provides the same functionality as the current init command
To encourage users to use snforge new instead of init, the init command will be updated with a deprecation notice.

@PoulavBhowmick03
Copy link

@cptartur
Can I work on this? I would love to start contibuting to the dojo repository and this being the first issue
I have a good experience of contributing to the Starknet ecosystem OD Profile
Thank you!

@cptartur cptartur added snforge feature New feature request/description and removed new labels Nov 14, 2024
@cptartur cptartur moved this from Backlog to TODO in Starknet foundry Nov 27, 2024
@cptartur cptartur moved this from TODO to In Progress in Starknet foundry Dec 9, 2024
github-merge-queue bot pushed a commit that referenced this issue Dec 13, 2024
<!-- Reference any GitHub issues resolved by this PR -->

Closes #2645 

## Introduced changes

<!-- A brief description of the changes -->

- `snforge new` command, which allows specifying the name of the package
and the path where it should be created
- Deprecation warning to the `snforge init` command

Docs and changelog will be updated in a separate PR.

## Checklist

<!-- Make sure all of these are complete -->

- [X] Linked relevant issue
- [X] Updated relevant documentation
- [X] Added relevant tests
- [X] Performed self-review of the code
- [X] Added changes to `CHANGELOG.md`

---------

Co-authored-by: Artur Michałek <[email protected]>
@github-project-automation github-project-automation bot moved this from In Progress to Done in Starknet foundry Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature request/description snforge
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants