[14/n] temporary workaround for cargo-sync-rdme bug

While we wait for gifnksm/cargo-sync-rdme#514 to be
merged upstream and make its way into a release, here is a temporary
workaround.

Reviewers: andrewjstone

Reviewed By: andrewjstone

Pull Request: #45

Author: sunshowers

.github/workflows/ci.yml

@@ -18,10 +18,17 @@ jobs:
         with:
           components: rustfmt, clippy
       - uses: Swatinem/rust-cache@23bce251a8cd2ffc3c1075eaa2367cf899916d84 # v2.7.3
-      - name: Install cargo-sync-rdme and just
+      - name: Install just and cargo-hack
         uses: taiki-e/install-action@v2
         with:
-          tool: cargo-sync-rdme,just,cargo-hack
+          tool: just,cargo-hack
+      - name: Install fork of cargo-sync-rdme
+        # This is a fork of cargo-sync-rdme with a fix for
+        # https://github.com/gifnksm/cargo-sync-rdme/pull/514 included -- remove
+        # once merged upstream.
+        run: |
+          curl -LsSf https://github.com/sunshowers/cargo-sync-rdme/releases/download/v0.4.2-b.1%2Bsunshowers/cargo-sync-rdme-v0.4.2-b.1+sunshowers-x86_64-unknown-linux-gnu.tar.gz \
+            | tar zxf - -C ${CARGO_HOME:-~/.cargo}/bin
       - name: Lint (clippy)
         run: just powerset clippy --all-targets
       - name: Lint (rustfmt)

Justfile

@@ -17,4 +17,5 @@ rustdoc *args:
 
 # Generate README.md files using `cargo-sync-rdme`.
 generate-readmes:
+    # Please install via cargo install --locked --git https://github.com/sunshowers/cargo-sync-rdme for now.
     cargo sync-rdme --toolchain nightly --workspace --all-features

daft/README.md

@@ -27,12 +27,14 @@ notion of a type for which two members can be simultaneously compared.
 use daft::{Diffable, Leaf};
 
 // Annotate your struct with `#[derive(Diffable)]`:
+#[derive(Diffable)]
 struct MyStruct {
     a: i32,
     b: String,
 }
 
 // This generates a type called MyStructDiff, which looks like:
+#[automatically_derived]
 struct MyStructDiff<'daft> {
     a: Leaf<&'daft i32>,
     b: Leaf<&'daft str>,
@@ -95,6 +97,7 @@ assert_eq!(diff.before, Some(&1));
 assert_eq!(diff.after, Some(&2));
 
 // Automatically derived enums also use Leaf:
+#[derive(Debug, PartialEq, Eq, Diffable)]
 enum MyEnum {
     A(i32),
     B(String),
@@ -261,6 +264,7 @@ Tuple-like structs produce tuple-like diff structs:
 use daft::Diffable;
 use std::collections::BTreeMap;
 
+#[derive(Diffable)]
 struct MyTuple(BTreeMap<i32, &'static str>, i32);
 
 let before = MyTuple(BTreeMap::new(), 1);
@@ -278,6 +282,8 @@ An example with `#[daft(leaf)]` on **structs**:
 ````rust
 use daft::{Diffable, Leaf};
 
+#[derive(Diffable)]
+#[daft(leaf)]
 struct MyStruct {
     a: i32,
 }
@@ -296,13 +302,16 @@ An example with `#[daft(leaf)]` on **struct fields**:
 use daft::{Diffable, Leaf};
 
 // A simple struct that implements Diffable.
+#[derive(Debug, PartialEq, Eq, Diffable)]
 struct InnerStruct {
     text: &'static str,
 }
 
 // A struct that does not implement Diffable.
+#[derive(Debug, PartialEq, Eq)]
 struct PlainStruct(usize);
 
+#[derive(Diffable)]
 struct OuterStruct {
     // Ordinarily, InnerStruct would be diffed recursively, but
     // with #[daft(leaf)], it is treated as a leaf node.
@@ -383,13 +392,15 @@ outlive it.
 ````rust
 use daft::Diffable;
 
+#[derive(Diffable)]
 struct BorrowedData<'a, 'b, T: Diffable + ?Sized> {
     a: &'a str,
     b: &'b T,
     // TODO: example with daft(leaf)
 }
 
 // This generates a struct that looks like:
+#[automatically_derived]
 struct BorrowedDataDiff<'daft, 'a: 'daft, 'b: 'daft, T: ?Sized + 'daft> {
     a: Leaf<'daft, &'a str>,
     b: T::Diff<'daft>,