refactor!: rename feature for serde (#19)

* refactor: rename feature for tests

* chore: add makefile, update readme

* docs: fix readme typo

* ci: update test script format

.github/workflows/build-caches.yml

@@ -29,4 +29,4 @@ jobs:
           shared-key: 'cache'
 
       - name: Test (to build cache)
-        run: cargo test --features tests
+        run: cargo test --all-features

.github/workflows/test.yml

@@ -27,4 +27,4 @@ jobs:
           shared-key: 'cache'
 
       - name: Test
-        run: cargo test --features tests
+        run: cargo test --all-features

Cargo.toml

@@ -12,7 +12,19 @@ categories = ["mathematics", "graphics"]
 [dependencies]
 num-traits = "0.2"
 serde = { version = "1.0", features = ["derive"], optional = true }
-serde_json = { version = "1.0", optional = true }
+
+[dev-dependencies]
+serde_json = "1.0"
 
 [features]
-tests = ["dep:serde", "dep:serde_json"]
+serde = ["dep:serde"]
+
+[[test]]
+name = "integration"
+path = "tests/integration.rs"
+required-features = ["serde"]
+
+[[bench]]
+name = "bench"
+path = "benches/bench.rs"
+required-features = ["serde"]

Makefile.toml

@@ -0,0 +1,7 @@
+[tasks.test]
+command = "cargo"
+args = ["test", "--all-features"]
+
+[tasks.bench]
+command = "cargo"
+args = ["+nightly", "bench", "--all-features"]

README.md

@@ -30,6 +30,10 @@ fn main() {
 }
 ```
 
+## Features
+
+- `serde`, optional, defaults to off. Allows serializing/deserializing points.
+
 ## Performance
 
 Measurements taken with an AMD Ryzen 7 5800x, in Pop!\_OS 22.04.
@@ -47,14 +51,26 @@ Measurements taken with an AMD Ryzen 7 5800x, in Pop!\_OS 22.04.
 
 ## Contributing
 
-Running tests:
+### Tests
+
+```shell
+$ cargo test --all-features
+```
+
+or
+
+```shell
+$ cargo make test
+```
+
+### Benchmarks
 
 ```shell
-$ cargo test --features tests
+$ cargo +nightly bench --all-features
 ```
 
-Running benchmarks:
+or
 
 ```shell
-$ cargo +nightly bench --features tests
+$ cargo make bench
 ```

src/lib.rs

@@ -1,10 +1,9 @@
 #![warn(missing_docs)]
-#![warn(rustdoc::missing_doc_code_examples)]
 #![doc = include_str!("../README.md")]
 
 pub use traits::ExtendedNumOps;
 
-#[cfg(feature = "tests")]
+#[cfg(feature = "serde")]
 use serde::{Deserialize, Serialize};
 
 mod traits;
@@ -19,7 +18,7 @@ mod traits;
 /// let point = Point { x: 1.0, y: 1.0 };
 /// ```
 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
-#[cfg_attr(feature = "tests", derive(Serialize, Deserialize))]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
 pub struct Point<T: ExtendedNumOps> {
     /// The x coordinate value.
     pub x: T,