Add --output-directory to forc build and related commands
#796
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
466d2c9 to
05bfc82
Compare
This is a start at addressing #765. Users can now specify a directory in which all compiler output artifacts will be placed by `forc` upon `forc build`. When unspecified, `--output-directory` defaults to `<project>/out/`. More specifically, artifacts are placed in `<project>/out/<profile>` where the `profile` subdirectory is in anticipation of support for multiple different build profiles. Currently "debug" is assumed.
This refactors the bodies of the `compile_to_asm` and `compile_to_bytecode` functions into `ast_to_asm` and `asm_to_bytecode` respectively. This allows `forc` to compile the AST (for producing the ABI JSON) and then re-use the compiled AST to complete the rest of compilation to bytecode in the same pass.
This updates `forc build` and related commands to compile the JSON ABI and write it to a `<project-name>-abi.json` file in the output directory.
We may want to consider removing the dedicated `forc json-abi` command altogether in favour of a `--print-json-abi` flag to `forc build` to make it clear that the output comes directly from `forc build`.
05bfc82 to
1c10587
Compare
This ensures the project can build before attempting to run tests. This may also make it easier to assume a location for the contract JSON ABI in tests.
Now that `cargo test` does `cargo build` first, it's safer to assume the contract JSON ABI is located in the `out` directory.
This ensures that forc and cargo's output artifact directories are discluded from git tracking by default.
Removes the default forc compiler output directory (`<project>/out`). Also runs `cargo clean` to remove the `target` directory that gets created when running `cargo test` via `forc test`.
|
OK I think this is about ready to go! See the commit messages for details about new additions since PR was opened. |
otrho
previously approved these changes
Feb 15, 2022
| @@ -53,7 +53,7 @@ pub(crate) fn default_program() -> String { | |||
| r#"script; | |||
|
|
|||
| fn main() { | |||
|
|
|||
| } | |||
There was a problem hiding this comment.
Heh, this whitespace has annoyed me for yonks.
There was a problem hiding this comment.
Omg I did it again #766 (comment)
I'm honestly not intending to do this, my editor is just accidentally "fixing" this and I keep missing it lol (I'm gonna leave it unless someone requests otherwise)
Human-friendly formatting by default, useful for checking/debugging contract/library ABIs. This is applied to both the `forc build` JSON of the output directory, as well as the `forc json-abi` output. A `--minimize-json-abi` option is added in order to allow for achieving the original behaviour.
adlerjohn
reviewed
Feb 15, 2022
otrho
approved these changes
Feb 16, 2022
sezna
approved these changes
Feb 16, 2022
|
Thanks all! |
mitchmindtree
added a commit
that referenced
this pull request
Mar 4, 2022
mitchmindtree
added a commit
that referenced
this pull request
Mar 4, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #764, #765.
Users can now specify a directory in which all compiler output artifacts
will be placed by
forcuponforc build.When unspecified,
--output-directorydefaults to<project>/out/.More specifically, artifacts are placed in
<project>/out/<profile>where the
profilesubdirectory is in anticipation of support formultiple different build profiles. Currently "debug" is assumed.
TODO
--output-directoryflag toforc buildand related commands.forc buildwrite compiled output binary to<project>/out/<profile>/<project-name>.binoutto sway repo.gitignore.forc buildwrite contract ABI JSON to<project>/out/<profile>/<project-name>-abi.json. Generate ABI json file when running forc build #764.forc testto firstforc buildto make it easier to ensure necessary contract ABI files are available.forc init, create.gitignorewithoutandtarget.forc cleanthat removesoutandtarget.