Skip to content

Conversation

@jessebraham
Copy link
Member

@jessebraham jessebraham commented Feb 17, 2025

This will be the first of a handful of refactoring PRs. The goal is to minimize our API surface and only export what needs to be exported. Hopefully none of these changes are too controversial, I think it should be quite straight-forward.

Starting with some modules: the command and elf modules contain implementation details which are used internally, and don't need to be exposed to users. Additionally, the error modules only contains one type which needs to be public, Error, which is now exported at the root of the package.

In addition to these changes, I have done some general cleanup and removed some unused code.

I have also decided that we do not need to document the modules/types gated behind the cli feature. This is all intended for use only for the cargo-espflash and espflash binaries, it's really of no concern to people using espflash as a library.

Copy link
Member

@SergioGasquez SergioGasquez left a comment

Choose a reason for hiding this comment

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

LGTM! 2 nitpicks that can be ignored

@jessebraham jessebraham added this pull request to the merge queue Feb 17, 2025
Merged via the queue into esp-rs:main with commit be1ff81 Feb 17, 2025
24 checks passed
@jessebraham jessebraham deleted the fixes/refactor branch February 17, 2025 11:40
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.

2 participants