Allow building payjoin crate with no default features #964
Conversation
This file contains hidden or 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
Collaborator
Pull Request Test Coverage Report for Build 17022142774Details
💛 - Coveralls |
Previously, the payjoin crate would fail to build if none of the features 'v1', 'v2', or 'directory' were enabled, due to an explicit compile_error! macro. This prevented the use of tools like cargo-all-features for comprehensive CI and dead code detection. This change removes the compile_error! and replaces it with a doc-only module that is included when no features are enabled, making the crate a no-op in that configuration. The documentation and Cargo.toml are updated to clarify that at least one of the main features must be enabled for any functionality. This enables better CI, linting, and future modularity, while preserving clear guidance for users and contributors. Closes payjoin#921
Johnosezele
force-pushed
the
enable-no-default-features-build
branch
from
96067bc to
0275928
Compare
Collaborator
|
In the dev call we discussed this, but i forgot to follow up here, I think we should hold off until after 1.0 because using cargo all features is not currently practical (too many features means it takes a long time) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Previously, the payjoin crate would fail to build if none of the features 'v1', 'v2', or 'directory' were enabled, due to an explicit compile_error! macro. This prevented the use of tools like cargo-all-features for comprehensive CI and dead code detection.
This change removes the compile_error! and replaces it with a doc-only module that is included when no features are enabled, making the crate a no-op in that configuration. The documentation and Cargo.toml are updated to clarify that at least one of the main features must be enabled for any functionality.
This enables better CI, linting, and future modularity, while preserving clear guidance for users and contributors.
Closes #921