Feature flags of wiwi crate // Lib.rs

Cargo Features

wiwi has no features set by default.

[dependencies]
wiwi = { version = "0.7.0-testonly.2", features = ["all", "all-unstable", "auth-unstable", "bigint-unstable", "bitstream-unstable", "chainer-unstable", "clock-timer", "debounce", "h", "hex", "id-unstable", "iter-unstable", "lazy-wrap", "lsl-unstable", "path-unstable", "serialiser-unstable", "string-pool-unstable", "sudoku-unstable", "to-maybeuninit", "z85", "hashbrown", "image", "serde-json", "debounce-dyn-fn", "httparse", "url"] }

all all-unstable? = clock-timer, debounce, h, hex, lazy-wrap, to-maybeuninit, z85

Adding new unstable feature:

append -unstable to its name

document it in README (note it is unstable by putting parens after name)

make sure to add to all-unstable feature

check doc cfg_attrs at top of lib.rs

make sure to add it to "No features enabled!" thing

also check the top of the prelude module

make sure the pub mod declaration in lib.rs has the right feature attr on it

pub mod declaration should also have the docsrs cfg attr on it In total: the module addition should have 1 change in README, 2 changes in Cargo.toml, 3 changes in lib.rs, 1 change in prelude.rs, and of course the module file itself TODO: write something similar for below graduating feats out of unstable

Graduating feature out of unstable:

remove -unstable from feature name below

update its entry in README

move it from all-unstable to all

rename it in cfg_attrs at top of lib.rs

rename it in "No features enabled!" thing

also check the top of the prelude module

update its name in the feature gate / doc attr of its pub mod declaration in lib.rs

check/add/update its prelude entries

No longer necessary (but good to do anyways I guess):

check workflow files

check below docs.rs config

NOTE: this is good for the docs deploy workflow

It would be good to occasionally check the dependencies too, update them, remove ones that aren't part of any feature anymore, etc

all-unstable = all, auth-unstable, bigint-unstable, bitstream-unstable, chainer-unstable, id-unstable, iter-unstable, lsl-unstable, path-unstable, serialiser-unstable, string-pool-unstable, sudoku-unstable

auth-unstable all-unstable? = z85