docs: document feature flags

.github/workflows/ci.yml

@@ -195,7 +195,7 @@ jobs:
           docs: true
 
       - name: Run doc
-        run: RUSTDOCFLAGS='-D warnings' cargo doc --no-deps
+        run: RUSTDOCFLAGS='-D warnings' cargo doc --no-deps --all-features
 
   test:
     name: Test

Cargo.toml

@@ -88,6 +88,7 @@ typescript_tsconfig_json = { version = "0.1.4" }
 nodejs_package_json = { version = "0.2.0" }
 
 codspeed-criterion-compat = { version = "2.4.0", default-features = false, optional = true }
+document-features = { version = "0.2", optional = true }
 
 [dev-dependencies]
 vfs            = "0.12.0"                                        # for testing with in memory file system
@@ -97,7 +98,12 @@ normalize-path = { version = "0.2.1" }
 
 [features]
 default = []
-# Enable the PackageJson::raw_json API
+## Enables the [PackageJson::raw_json] API,
+## which returns the `package.json` with `serde_json::Value`.
 package_json_raw_json_api = []
 # For codspeed benchmark
 codspeed = ["codspeed-criterion-compat"]
+
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docsrs"]

justfile

@@ -50,6 +50,10 @@ test:
 lint:
   cargo clippy -- --deny warnings
 
+# Generate doc
+doc:
+  RUSTDOCFLAGS='-D warnings' cargo doc --no-deps --all-features
+
 # Get code coverage
 codecov:
   cargo codecov --html

src/lib.rs

@@ -35,6 +35,9 @@
 //! [cjs]: https://nodejs.org/api/modules.html
 //! [esm]: https://nodejs.org/api/esm.html
 //!
+//! ## Feature flags
+#![doc = document_features::document_features!()]
+//!
 //! ## Example
 //!
 //! ```rust,ignore