feat: add `nargo compile --watch` command #4464

TomAFrench · 2024-03-01T16:33:56Z

Description

Problem*

Resolves

Summary*

This PR creates the outline of a watch command to be built on in subsequent PRs.

Currently this just watches the full workspace directory and on any change to a .nr file, will recompile the workspace/package and display any errors/warnings.

Additional Context

Documentation*

Check one:

[] No documentation needed.
Documentation included in this PR.
[Exceptional Case] Documentation to be submitted in a separate PR.
Will be documented when feature is public.

PR Checklist*

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

TomAFrench · 2024-03-04T18:15:30Z

On second thoughts, we should probably move this over to be nargo compile --watch rather than creating a new command.

* master: feat: Sync from aztec-packages (#4465) feat: Add eddsa_poseidon_to_pub function to stdlib with test + docs (#4473) chore(deps): bump mio from 0.8.10 to 0.8.11 (#4478) chore: Capitalize containers section in docs (#4471)

jfecher

LGTM. Just needs some light cleanup

tooling/nargo_cli/src/cli/compile_cmd.rs

michaeljklein

LGTM

* master: (36 commits) fix: Substitute generics when checking the field count of a type (#4547) feat: optimize sha2 implementation (#4441) chore: allow setting namespace visibility on functions (#4510) feat: Visible aliases for nargo commands (#4453) feat: Sync from aztec-packages (#4494) feat: Add checks for bit size consistency on brillig gen (#4542) fix: Allow non-integer globals to reference struct methods (#4490) chore: generalise `FunctionVisibility` to `ItemVisibility` (#4495) fix: Dynamic assert messages in brillig (#4531) chore: organize the `blackbox_solver` crate (#4519) fix(acir_gen): More granular element sizes array check (#4528) chore: Release Noir(0.25.0) (#4352) chore: document big integers (#4487) fix: Add `follow_bindings` to follow `Type::Alias` links (#4521) fix: Fix brillig slowdown when assigning arrays in loops (#4472) chore: Move `check_method_signatures` to type checking phase (#4516) chore(ci): fix JS publishing workflow checking out inconsistent commits (#4493) fix(ssa): Handle mergers of slices returned from calls (#4496) chore: Add HashMap docs (#4457) chore: custom hash for eddsa (#4440) ...

* master: chore: separate tests for execution failures from compilation failures (#4559) feat: remove curly braces with fmt (#4529) fix: Make `nargo` the default binary for cargo run (#4554) fix: Evaluate operators in globals in types (#4537) chore: Add more `Hash` impls to stdlib (#4470) feat: Sync from aztec-packages (#4546) chore: Add `Instruction::DecrementRc` (#4525) feat: add `nargo compile --watch` command (#4464) fix: Substitute generics when checking the field count of a type (#4547) feat: optimize sha2 implementation (#4441)

Savio-Sou · 2024-03-24T20:37:19Z

Will be documented when feature is public.

What does the feature being "private" mean?

🤖 I have created a release *beep* *boop* --- <details><summary>0.26.0</summary> ## [0.26.0](v0.25.0...v0.26.0) (2024-03-25) ### ⚠ BREAKING CHANGES * **acir:** Program and witness stack structure (AztecProtocol/aztec-packages#5149) * automatic NoteInterface and NoteGetterOptions auto select (AztecProtocol/aztec-packages#4508) * separating out array and slice types in the AST ([#4504](#4504)) * Acir call opcode (AztecProtocol/aztec-packages#4773) * Support contracts with no constructor (AztecProtocol/aztec-packages#5175) * Remove open keyword from Noir (AztecProtocol/aztec-packages#4967) ### Features * Acir call opcode (AztecProtocol/aztec-packages#4773) ([c3c9e19](c3c9e19)) * **acir:** Program and witness stack structure (AztecProtocol/aztec-packages#5149) ([13eb71b](13eb71b)) * Add `break` and `continue` in unconstrained code ([#4569](#4569)) ([f2f827d](f2f827d)) * Add `nargo compile --watch` command ([#4464](#4464)) ([44e60b6](44e60b6)) * Add as_slice builtin function, add execution test ([#4523](#4523)) ([6a9ea35](6a9ea35)) * Add checks for bit size consistency on brillig gen ([#4542](#4542)) ([f3243b7](f3243b7)) * Add CMOV instruction to brillig and brillig gen (AztecProtocol/aztec-packages#5308) ([13eb71b](13eb71b)) * Add experimental `quote` expression to parser ([#4595](#4595)) ([4c3a30b](4c3a30b)) * Add more impls on Option ([#4549](#4549)) ([4cf700b](4cf700b)) * Add specific error for attempting `string[x] = ".."` ([#4611](#4611)) ([ff95fd9](ff95fd9)) * Allow usage of noir `#[test]` syntax in stdlib ([#4553](#4553)) ([a8b7cdb](a8b7cdb)) * Automatic NoteInterface and NoteGetterOptions auto select (AztecProtocol/aztec-packages#4508) ([13eb71b](13eb71b)) * **avm:** Brillig CONST of size > u128 (AztecProtocol/aztec-packages#5217) ([c3c9e19](c3c9e19)) * Brillig IR refactor (AztecProtocol/aztec-packages#5233) ([c3c9e19](c3c9e19)) * Check initialization arguments in constructors (AztecProtocol/aztec-packages#5144) ([d4213a0](d4213a0)) * Check initializer msg.sender matches deployer from address preimage (AztecProtocol/aztec-packages#5222) ([c3c9e19](c3c9e19)) * Initial Earthly CI (AztecProtocol/aztec-packages#5069) ([c3c9e19](c3c9e19)) * Integrated native ACVM (AztecProtocol/aztec-packages#4903) ([a6016b4](a6016b4)) * Make brillig-gen more AVM-friendly (AztecProtocol/aztec-packages#5091) ([a6016b4](a6016b4)) * New brillig field operations and refactor of binary operations (AztecProtocol/aztec-packages#5208) ([c3c9e19](c3c9e19)) * Optimize sha2 implementation ([#4441](#4441)) ([80373d6](80373d6)) * RC optimization pass ([#4560](#4560)) ([dfa5126](dfa5126)) * Remove curly braces with fmt ([#4529](#4529)) ([fe9a437](fe9a437)) * Separating out array and slice types in the AST ([#4504](#4504)) ([9a241f9](9a241f9)) * Signed integer division and modulus in brillig gen (AztecProtocol/aztec-packages#5279) ([c3c9e19](c3c9e19)) * Support contracts with no constructor (AztecProtocol/aztec-packages#5175) ([c3c9e19](c3c9e19)) * Sync from noir (AztecProtocol/aztec-packages#5234) ([c3c9e19](c3c9e19)) * Sync from noir (AztecProtocol/aztec-packages#5286) ([c3c9e19](c3c9e19)) * Visible aliases for nargo commands ([#4453](#4453)) ([773cf19](773cf19)) ### Bug Fixes * **acir_gen:** More granular element sizes array check ([#4528](#4528)) ([f93d16e](f93d16e)) * Added error messages for passing oracles and references from unconstrained to constrained functions ([#4570](#4570)) ([265bd8b](265bd8b)) * Allow non-integer globals to reference struct methods ([#4490](#4490)) ([00d6494](00d6494)) * Dynamic assert messages in brillig ([#4531](#4531)) ([e24d3fc](e24d3fc)) * Evaluate operators in globals in types ([#4537](#4537)) ([c8aa16b](c8aa16b)) * Make `nargo` the default binary for cargo run ([#4554](#4554)) ([de4986e](de4986e)) * Signed integer comparisons in brillig ([#4579](#4579)) ([938d5e8](938d5e8)) * **ssa:** Use accurate type during SSA AsSlice simplficiation ([#4610](#4610)) ([0473497](0473497)) * Substitute generics when checking the field count of a type ([#4547](#4547)) ([eeeebac](eeeebac)) ### Miscellaneous Chores * Remove open keyword from Noir (AztecProtocol/aztec-packages#4967) ([a6016b4](a6016b4)) </details> <details><summary>0.42.0</summary> ## [0.42.0](v0.41.0...v0.42.0) (2024-03-25) ### ⚠ BREAKING CHANGES * **acir:** Program and witness stack structure (AztecProtocol/aztec-packages#5149) * automatic NoteInterface and NoteGetterOptions auto select (AztecProtocol/aztec-packages#4508) * Acir call opcode (AztecProtocol/aztec-packages#4773) * Support contracts with no constructor (AztecProtocol/aztec-packages#5175) * Internal as a macro (AztecProtocol/aztec-packages#4898) * move noir out of yarn-project (AztecProtocol/aztec-packages#4479) * note type ids (AztecProtocol/aztec-packages#4500) * rename bigint_neg into bigint_sub (AztecProtocol/aztec-packages#4420) * Add expression width into acir (AztecProtocol/aztec-packages#4014) * init storage macro (AztecProtocol/aztec-packages#4200) * **acir:** Move `is_recursive` flag to be part of the circuit definition (AztecProtocol/aztec-packages#4221) * Sync commits from `aztec-packages` ([#4144](#4144)) * Breaking changes from aztec-packages ([#3955](#3955)) * Rename Arithmetic opcode to AssertZero ([#3840](#3840)) * Remove unused methods on ACIR opcodes ([#3841](#3841)) * Remove partial backend feature ([#3805](#3805)) ### Features * Acir call opcode (AztecProtocol/aztec-packages#4773) ([c3c9e19](c3c9e19)) * **acir:** Program and witness stack structure (AztecProtocol/aztec-packages#5149) ([13eb71b](13eb71b)) * Add bit size to const opcode (AztecProtocol/aztec-packages#4385) ([158c8ce](158c8ce)) * Add CMOV instruction to brillig and brillig gen (AztecProtocol/aztec-packages#5308) ([13eb71b](13eb71b)) * Add expression width into acir (AztecProtocol/aztec-packages#4014) ([158c8ce](158c8ce)) * Add instrumentation for tracking variables in debugging ([#4122](#4122)) ([c58d691](c58d691)) * Add poseidon2 opcode implementation for acvm/brillig, and Noir ([#4398](#4398)) ([10e8292](10e8292)) * Add support for overriding expression width ([#4117](#4117)) ([c8026d5](c8026d5)) * Added cast opcode and cast calldata (AztecProtocol/aztec-packages#4423) ([78ef013](78ef013)) * Allow brillig to read arrays directly from memory (AztecProtocol/aztec-packages#4460) ([158c8ce](158c8ce)) * Allow nested arrays and vectors in Brillig foreign calls (AztecProtocol/aztec-packages#4478) ([158c8ce](158c8ce)) * Allow variables and stack trace inspection in the debugger ([#4184](#4184)) ([bf263fc](bf263fc)) * Automatic NoteInterface and NoteGetterOptions auto select (AztecProtocol/aztec-packages#4508) ([13eb71b](13eb71b)) * **avm:** Back in avm context with macro - refactor context (AztecProtocol/aztec-packages#4438) ([158c8ce](158c8ce)) * **avm:** Brillig CONST of size > u128 (AztecProtocol/aztec-packages#5217) ([c3c9e19](c3c9e19)) * **aztec-nr:** Initial work for aztec public vm macro (AztecProtocol/aztec-packages#4400) ([158c8ce](158c8ce)) * Aztec-packages ([#3754](#3754)) ([c043265](c043265)) * Backpropagate constants in ACIR during optimization ([#3926](#3926)) ([aad0da0](aad0da0)) * Breaking changes from aztec-packages ([#3955](#3955)) ([5be049e](5be049e)) * Brillig IR refactor (AztecProtocol/aztec-packages#5233) ([c3c9e19](c3c9e19)) * Check initializer msg.sender matches deployer from address preimage (AztecProtocol/aztec-packages#5222) ([c3c9e19](c3c9e19)) * Evaluation of dynamic assert messages ([#4101](#4101)) ([c284e01](c284e01)) * Init storage macro (AztecProtocol/aztec-packages#4200) ([158c8ce](158c8ce)) * Initial Earthly CI (AztecProtocol/aztec-packages#5069) ([c3c9e19](c3c9e19)) * Internal as a macro (AztecProtocol/aztec-packages#4898) ([5f57ebb](5f57ebb)) * New brillig field operations and refactor of binary operations (AztecProtocol/aztec-packages#5208) ([c3c9e19](c3c9e19)) * Note type ids (AztecProtocol/aztec-packages#4500) ([78ef013](78ef013)) * Remove range constraints from witnesses which are constrained to be constants ([#3928](#3928)) ([afe9c7a](afe9c7a)) * Remove replacement of boolean range opcodes with `AssertZero` opcodes ([#4107](#4107)) ([dac0e87](dac0e87)) * Signed integer division and modulus in brillig gen (AztecProtocol/aztec-packages#5279) ([c3c9e19](c3c9e19)) * Speed up transformation of debug messages ([#3815](#3815)) ([2a8af1e](2a8af1e)) * Support contracts with no constructor (AztecProtocol/aztec-packages#5175) ([c3c9e19](c3c9e19)) * Sync `aztec-packages` ([#4011](#4011)) ([fee2452](fee2452)) * Sync commits from `aztec-packages` ([#4068](#4068)) ([7a8f3a3](7a8f3a3)) * Sync commits from `aztec-packages` ([#4144](#4144)) ([0205d3b](0205d3b)) * Sync from aztec-packages ([#4483](#4483)) ([fe8f277](fe8f277)) * Sync from noir (AztecProtocol/aztec-packages#5234) ([c3c9e19](c3c9e19)) * Sync from noir (AztecProtocol/aztec-packages#5286) ([c3c9e19](c3c9e19)) ### Bug Fixes * Deserialize odd length hex literals ([#3747](#3747)) ([4000fb2](4000fb2)) * Noir test incorrect reporting (AztecProtocol/aztec-packages#4925) ([5f57ebb](5f57ebb)) * Remove panic from `init_log_level` in `acvm_js` ([#4195](#4195)) ([2e26530](2e26530)) * Return error rather instead of panicking on invalid circuit ([#3976](#3976)) ([67201bf](67201bf)) ### Miscellaneous Chores * **acir:** Move `is_recursive` flag to be part of the circuit definition (AztecProtocol/aztec-packages#4221) ([158c8ce](158c8ce)) * Move noir out of yarn-project (AztecProtocol/aztec-packages#4479) ([78ef013](78ef013)) * Remove partial backend feature ([#3805](#3805)) ([0383100](0383100)) * Remove unused methods on ACIR opcodes ([#3841](#3841)) ([9e5d0e8](9e5d0e8)) * Rename Arithmetic opcode to AssertZero ([#3840](#3840)) ([836f171](836f171)) * Rename bigint_neg into bigint_sub (AztecProtocol/aztec-packages#4420) ([158c8ce](158c8ce)) </details> --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please).

TomAFrench added 3 commits March 1, 2024 11:09

chore: export report_errors from nargo

3c0e616

chore: make error reporting an explicit action

f1b3a8d

feat: add watch command

8397212

Base automatically changed from tf/deduplicate-error-reporting to master March 4, 2024 14:06

TomAFrench marked this pull request as ready for review March 4, 2024 18:13

TomAFrench requested a review from kevaundray March 4, 2024 18:13

Merge branch 'master' into tf/nargo-watch

6daab1e

TomAFrench added 3 commits March 5, 2024 17:51

Merge branch 'master' into tf/nargo-watch

cedee07

* master: feat: Sync from aztec-packages (#4465) feat: Add eddsa_poseidon_to_pub function to stdlib with test + docs (#4473) chore(deps): bump mio from 0.8.10 to 0.8.11 (#4478) chore: Capitalize containers section in docs (#4471)

chore: move watch command to be an option on nargo compile

f6e27b7

chore: whitelist notify

465b0bc

TomAFrench changed the title ~~feat: add nargo watch command~~ feat: add nargo compile --watch command Mar 5, 2024

TomAFrench requested a review from michaeljklein March 5, 2024 19:10

jfecher reviewed Mar 13, 2024

View reviewed changes

tooling/nargo_cli/src/cli/compile_cmd.rs Outdated Show resolved Hide resolved

tooling/nargo_cli/src/cli/compile_cmd.rs Outdated Show resolved Hide resolved

TomAFrench added 2 commits March 13, 2024 15:49

chore: fix formatter gore

4124a09

chore: remove continue

0d37803

jfecher approved these changes Mar 13, 2024

View reviewed changes

chore: remove full stop

8c17d99

michaeljklein requested changes Mar 13, 2024

View reviewed changes

tooling/nargo_cli/src/cli/compile_cmd.rs Outdated Show resolved Hide resolved

tooling/nargo_cli/src/cli/compile_cmd.rs Show resolved Hide resolved

chore: rebuild on Create and Remove events

8f8d164

michaeljklein approved these changes Mar 13, 2024

View reviewed changes

TomAFrench enabled auto-merge March 13, 2024 17:47

TomAFrench added this pull request to the merge queue Mar 13, 2024

Merged via the queue into master with commit 44e60b6 Mar 13, 2024
44 checks passed

TomAFrench deleted the tf/nargo-watch branch March 13, 2024 18:25

kevaundray mentioned this pull request Mar 13, 2024

chore: Release Noir(0.26.0) #4526

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add `nargo compile --watch` command #4464

feat: add `nargo compile --watch` command #4464

TomAFrench commented Mar 1, 2024

TomAFrench commented Mar 4, 2024

jfecher left a comment

michaeljklein left a comment

Savio-Sou commented Mar 24, 2024

feat: add nargo compile --watch command #4464

feat: add nargo compile --watch command #4464

Conversation

TomAFrench commented Mar 1, 2024

Description

Problem*

Summary*

Additional Context

Documentation*

PR Checklist*

TomAFrench commented Mar 4, 2024

jfecher left a comment

Choose a reason for hiding this comment

michaeljklein left a comment

Choose a reason for hiding this comment

Savio-Sou commented Mar 24, 2024

feat: add `nargo compile --watch` command #4464

feat: add `nargo compile --watch` command #4464