https://github.com/folkengine/unwrapped
Seeing if my linting catched the cloudflare upwrap issue
https://github.com/folkengine/unwrapped
Last synced: 5 months ago
JSON representation
Seeing if my linting catched the cloudflare upwrap issue
- Host: GitHub
- URL: https://github.com/folkengine/unwrapped
- Owner: folkengine
- License: apache-2.0
- Created: 2025-11-21T01:40:06.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-11-21T02:02:18.000Z (7 months ago)
- Last Synced: 2025-12-31T06:52:20.627Z (6 months ago)
- Language: Dockerfile
- Size: 25.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://github.com/folkengine/unwrapped/actions/workflows/CI.yaml)
[](https://www.gnu.org/licenses/gpl-3.0.en.html)
---
# Rust Blank
Starting Point for Rust projects. Feel free to adapt as needed.
One will notice the lack of any Rust code in this template. That is intentional.
This is why the CI badge up above is red.
This is a collection of supporting files that I find useful beyond what is
provided by [cargo init](https://doc.rust-lang.org/cargo/commands/cargo-init.html).
Rather than try to replace what it does, I just wanted a way to add the things
that I find useful.
This template is designed to be
[cruel to be kind in the right measure](https://www.youtube.com/watch?v=b0l3QWUXVho).
You can see an example of it in use at [devplaybooks/rust_blank_example](https://github.com/devplaybooks/rust_blank_example).
## How to use it
* Use the template. (**Note that your first build will fail because there is no code yet.**)
* Check out your new repo locally.
* Navigate into the repo
* Run [cargo init](https://doc.rust-lang.org/cargo/commands/cargo-init.html)
* If you want a library instead of an executable, run `cargo init --lib`
## What's in the box?
* Choice of licenses
* .rustfmt.toml file
* GitHub CI Actions
* GitHub [VSCode Dev Container](https://code.visualstudio.com/docs/devcontainers/containers) that also acts as an online GitHub Codespace courtesy of [codespaces-examples](https://github.com/codespaces-examples/rust)
### Licenses
I've added all the licenses I generally use for maximum flexibility.
* [Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0)
* [GPL 3.0 License](https://www.gnu.org/licenses/gpl-3.0.en.html)
* [MIT License](https://opensource.org/license/mit/)
### My version of Robbepop's [.rustfmt.toml file](https://gist.github.com/Robbepop/f88d896f859712384039813fab939172)
It allows you to customize how the [rstfmt cargo command](https://github.com/rust-lang/rustfmt)
does its job. In my case, that means changing the max width of a file from 80
characters to 100:
```toml
# Ideal width of each line.
# Default: 80
max_width = 100
```
### David Tolnay's [Rust Toolchain GitHub Action](https://github.com/dtolnay/rust-toolchain)
I've been a big fan of [svartalf's](https://github.com/svartalf) [actions-rs libraries](https://github.com/actions-rs),
but it doesn't seem to be maintained, and I'm getting [warnings](https://github.blog/changelog/2022-09-22-github-actions-all-actions-will-begin-running-on-node16-instead-of-node12/)
now from GitHub, so I'm switching. It's surprisingly simple and flexible.
This workflow contains a cron schedule to run [every 1st day of the month](https://crontab.guru/#40_1_1_*_*).
Note that [GitHub says](https://docs.github.com/en/actions/managing-workflow-runs/disabling-and-enabling-a-workflow#article-contents)
that it will disable scheduled workflows on forked repos or if there has been no
activity in 60 days.
If you're not familiar with [GitHub Actions](https://github.com/features/actions),
I recommend that you check them out.
[.github/workflows/CI.yaml](/.github/workflows/CI.yaml) contains the following jobs:
#### test
Tests the code against Rust's [stable](https://github.com/rust-lang/rust/blob/master/RELEASES.md), beta, and nightly [channels](https://rust-lang.github.io/rustup/concepts/channels.html),
as well as the 1.72.1 release of Rust.
#### clippy
I like my [Clippy lints](https://doc.rust-lang.org/clippy/) to be [dialed up to 11](https://www.youtube.com/watch?v=F7IZZXQ89Oc),
so it's configured at the pedantic level. Feel free to dial it down as you see fit.
Note that if you don't add `#![warn(clippy::pedantic)]` at the beginning of your
crate, Clippy will pass locally, but fail when you push. For example:
```rust
#![warn(clippy::pedantic)]
fn main() {
println!("Hello, world!");
}
```
#### fmt
Fails the build if the developer didn't run
[rustfmt](https://github.com/rust-lang/rustfmt) against the build.
#### doc
Runs [`cargo doc`](https://doc.rust-lang.org/cargo/commands/cargo-doc.html)
on the repo and fails if there are any warnings.
#### miri
I had never heard of [Miri](https://github.com/rust-lang/miri) before I saw it
in [this example](https://github.com/dtolnay/thiserror/blob/master/.github/workflows/ci.yml),
but it looks interesting, so why not?
Miri is a heavy test, so it may be wise to remove it.
#### ~~outdated~~
~~Runs the [outdated cargo subcommand](https://github.com/kbknapp/cargo-outdated)
against the repo. Fails the build if you have any outdated dependencies in your
project. If you keep the cron schedule, it will check every month to see if any
of your dependencies are outdated.~~
Outdated isn't compatible with the Rust 2024 edition. There's an
[open issue](https://github.com/kbknapp/cargo-outdated/issues/419) for it.
### Dev Container
The Docker image used is based on Microsoft's
[Rust Dev Container image](https://github.com/devcontainers/images/tree/main/src/rust). It includes:
- [Evcxr Rust REPL](https://github.com/evcxr/evcxr/blob/main/evcxr_repl/README.md)
- [Rustup wasm32-unknown-unknown target](https://doc.rust-lang.org/nightly/rustc/platform-support/wasm32-unknown-unknown.html)
## Rust Resources
* [Rust Programming Language](https://doc.rust-lang.org/book/README.html)
* [rustup.rs](https://github.com/rust-lang-nursery/rustup.rs)
* [Cargo Guide](http://doc.crates.io/guide.html)
* [Rust Cookbook](https://rust-lang-nursery.github.io/rust-cookbook/) ([git](https://github.com/rust-lang-nursery/rust-cookbook))
* [Asynchronous Programming in Rust](https://rust-lang.github.io/async-book/index.html)
* [The Little Book of Rust Books](https://lborb.github.io/book/)