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

feat!: Allow specifying new package name with --name flag #2144

Merged
merged 3 commits into from
Aug 4, 2023

Conversation

TomAFrench
Copy link
Member

Description

Problem*

Resolves #2132

Summary*

package_name positional argument has been replaced by the name option. name defaults to the package directory if unspecified.

Documentation

  • This PR requires documentation updates when merged.

    • I will submit a noir-lang/docs PR.
    • I will request for and support Dev Rel's help in documenting this PR.

Arguments to nargo new and nargo init have changed.

Additional Context

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

phated
phated previously approved these changes Aug 3, 2023
Copy link
Contributor

@phated phated left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. One question about how we should represent defaults in help output

crates/nargo_cli/src/cli/init_cmd.rs Outdated Show resolved Hide resolved
@phated phated changed the title feat: Allow specifying new package name with --name flag feat!: Allow specifying new package name with --name flag Aug 3, 2023
@phated
Copy link
Contributor

phated commented Aug 3, 2023

Updated the title because this is technically breaking. Even though usage like nargo new foobar baz wouldn't work correctly, it would still run. With this change, it will be rejected due to the 2nd positional argument.

@TomAFrench
Copy link
Member Author

Updated the title because this is technically breaking.

Sure, we could add a hidden arg here just to prevent this rejection but next release is breaking anyway.

@kobyhallx kobyhallx enabled auto-merge August 4, 2023 11:43
@kobyhallx kobyhallx added this pull request to the merge queue Aug 4, 2023
Merged via the queue into master with commit e932599 Aug 4, 2023
@kobyhallx kobyhallx deleted the noir-new-package-name branch August 4, 2023 12:58
TomAFrench added a commit that referenced this pull request Aug 4, 2023
* master: (50 commits)
  chore: update stale comment on `create_circuit` (#2173)
  chore: Replace `resolve_path` function with a trait that impls normalize (#2157)
  chore: clippy fix (#2174)
  feat!: Allow specifying new package name with `--name` flag (#2144)
  chore!: remove unused flags on LSP command (#2170)
  chore: Hide the `show_ssa` and `show_brillig` flags (#2171)
  chore: bump `clap` to 4.3.19 (#2167)
  chore: Move the long line of `nargo info` to `long_about` (#2151)
  chore: Refactor `normalize_path` into an API on FileManager (#2156)
  fix: Implement slices of structs (#2150)
  chore: Refreshed ACIR artifacts (#2148)
  chore: Rebuild ACIR test artifacts (#2147)
  chore: remove short flags for `--show-ssa` and `--deny-warnings` (#2141)
  chore: replace usage of `Directive::Quotient` with brillig opcode  (#1766)
  chore: clippy fix (#2136)
  feat: Initial work on rewriting closures to regular functions with hi… (#1959)
  chore: Decouple acir blockid from ssa valueid (#2103)
  chore: Initialize copy array from previous values in `array_set` (#2106)
  chore: rename `ssa_refactor` module to `ssa` (#2129)
  chore: Use `--show-output` flag on execution rather than compilation  (#2116)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

package_name argument on nargo new is ignored
3 participants