External dependency directory #236
Conversation
Any inputs in a `/_CDDL_CODEGEN_EXTERN_DEPS_DIR_/` directory at the root of the `--input` will now be treated as existing in an external crate. All types will be ignored for exporting but will still be used in the intermediate steps to determine what exists, what CBOR types they are, etc. This saves users from having to manually replace all `crate::foo::etc` and be able to directly have it use `foo::etc` when they put their `foo` folder in the aforementioned external deps folder. This is very useful e.g. for CML's multi-era crate which refers to types from `cml-chain`, etc. Before this we needed to manually edit imports, manually remove module declarations, and manually delete those files/folders corresponding to the external deps.
| @@ -23,6 +23,7 @@ enum ControlOperator { | |||
| } | |||
|
|
|||
| pub const SCOPE_MARKER: &str = "_CDDL_CODEGEN_SCOPE_MARKER_"; | |||
| pub const EXTERN_DEPS_DIR: &str = "_CDDL_CODEGEN_EXTERN_DEPS_DIR_"; | |||
There was a problem hiding this comment.
Can we not easily have a test for this one?
There was a problem hiding this comment.
I guess we could but we'd have to pull in a dependency. I guess we could have a simple crate somewhere in the tests folder and use that and add it to the Cargo.toml of the test after generation as a local dependency. I'll try doing that.
There was a problem hiding this comment.
I added a test. It was a bit more work than I expected. It ended up also testing --common-import-override necessarily so that's a plus at least. I also fixed the failing tests (was only happening on github). Turns out after running cargo from a clean install would cause cddl to update to 0.9.4 (locally it was still using 0.9.1. as specified for me still) which broke basic group support parsing, at least in one of the ways it was used in some of the tests. I made an issue for it anweiss/cddl#222 and set it to =0.9.1 to get around that.
Any inputs in a
/_CDDL_CODEGEN_EXTERN_DEPS_DIR_/directory at the root of the--inputwill now be treated as existing in an external crate.All types will be ignored for exporting but will still be used in the intermediate steps to determine what exists, what CBOR types they are, etc.
This saves users from having to manually replace all
crate::foo::etcand be able to directly have it usefoo::etcwhen they put theirfoofolder in the aforementioned external deps folder.This is very useful e.g. for CML's multi-era crate which refers to types from
cml-chain, etc. Before this we needed to manually edit imports, manually remove module declarations, and manually delete those files/folders corresponding to the external deps.A test was added which also tests
--common-import-overrideand integration with an external crate in general.Also fixes the
cddldependency to specifically=0.9.1to get around anweiss/cddl#222