chore(code): Namespace crates under informalsystems- prefix, add bft suffix
#696
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
…ft` suffix
Rename all crates to include a `informalsystems-` prefix and a `bft` suffix to avoid clashes with the existing `malachite` crate.
So `malachite-consensus` would become `informalsystems-malachitebft-consensus`.
It is a mouthful but that can be alleviated in code by specifying a package alias in `Cargo.toml`:
```toml
[dependencies]
malachitebft-consensus = { version = "0.1.0", package = "informalsystems-malachitebft-consensus" }
```
which allows import of the form:
```rust
use malachitebft_consensus::foobar::*
```
instead of
```rust
use informalsystems_malachitebft_consensus::foobar::*
```
romac
force-pushed
the
romac/namespace
branch
from
0782256 to
519768c
Compare
romac
added a commit
that referenced
this pull request
Dec 18, 2024
…ft` suffix (#696) * chore(code): Namespace crates under `informalsystems-` prefix, add `bft` suffix Rename all crates to include a `informalsystems-` prefix and a `bft` suffix to avoid clashes with the existing `malachite` crate. So `malachite-consensus` would become `informalsystems-malachitebft-consensus`. It is a mouthful but that can be alleviated in code by specifying a package alias in `Cargo.toml`: ```toml [dependencies] malachitebft-consensus = { version = "0.1.0", package = "informalsystems-malachitebft-consensus" } ``` which allows import of the form: ```rust use malachitebft_consensus::foobar::* ``` instead of ```rust use informalsystems_malachitebft_consensus::foobar::* ``` * Format and cleanup all Cargo.toml files * Fix CI * Remove unused `node` crate * Do not publish signing and test-cli crates * Add note in starknet crates
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: #652
Rename all crates to include a
informalsystems-prefix and abftsuffix to avoid clashes with the existingmalachitecrate.So
malachite-consensuswould becomeinformalsystems-malachitebft-consensus.It is a mouthful but that can be alleviated in code by specifying a package alias in
Cargo.toml:which allows import of the form:
instead of
We are using this internally as well to make imports more readable.
Unfortunately, integration tests (ie. tests under the
tests/directory) do not honor thepackageflag and must therefore import their own crate under its original name.PR author checklist