Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hobofan/cargo-nono
Check your crate for (possible) no_std compatibility
https://github.com/hobofan/cargo-nono
Last synced: 3 days ago
JSON representation
Check your crate for (possible) no_std compatibility
- Host: GitHub
- URL: https://github.com/hobofan/cargo-nono
- Owner: hobofan
- License: apache-2.0
- Created: 2018-11-11T17:54:02.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-04-11T11:19:00.000Z (almost 2 years ago)
- Last Synced: 2025-01-11T09:10:02.309Z (10 days ago)
- Language: Rust
- Homepage:
- Size: 99.6 KB
- Stars: 212
- Watchers: 7
- Forks: 12
- Open Issues: 24
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
## cargo nono - Detect (possible) no_std compatibility of your crate and dependencies
## Motivation
From embedded programming, over smart contracts in Rust, to general cross-platform portable crates, `#![no_std]` crates are becoming more and more widespread.
However it is currently a very cumbersome process to find out if and why (not) a crate is compatible with `no_std` usage, and often requires a lengthy trial and error process, and digging through the source of all your dependencies.
**cargo nono** tries to aid you in navigating the current minefield that is `no_std` usage, and it's biggest "no no"s.
## Installation
### Prebuilt binaries
`cargo-nono` also comes as prebuilt binaries (useful for CI):
```bash
curl -LSfs https://japaric.github.io/trust/install.sh | \
sh -s -- --git hobofan/cargo-nono
```
### From crates.io
```bash
cargo install cargo-nono
# For warnings with more informative messages install like this
RUSTFLAGS="--cfg procmacro2_semver_exempt" cargo install cargo-nono
```
## Demo
[](https://asciinema.org/a/212278)
## Usage
Run in the crate directory you want to check:
```
cargo nono check
```
The `cargo nono check` subcommand also understands the `--no-default-features` and `--features ` flags to help in conditional `no_std` setups.
## Features
- Tries to infer `no_std` compatibility in dependencies by looking for a `#![no_std]` attribute or the often used conditional `#![cfg_attr(not(feature = "std"), no_std)]`
- Helps in pinpointing which dependencies and feature flags activate `std` feature flags
- Warn of `use std::` statements in code
### Planned features
- Warn of `[build-dependencies]` features bleeding over: [cargo#5730](https://github.com/rust-lang/cargo/issues/5730)
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.