README.md 周りの修正 (#45)

* wip: sync.rs 更新

* docs: README.md 類を更新

* chore: バージョンアップ

* fix: dry run をする場合、バージョンを揃えられない問題があることに気付いたため、dry run を削除

* docs: todo.md 更新

Author: anotherhollow1125

.github/scripts/sync.rs

@@ -27,21 +27,28 @@ struct Readme {
     common: String,
 }
 
+#[derive(serde::Serialize)]
+struct VersionInfo {
+    version: String,
+}
+
 #[hooq(anyhow)]
 fn main() -> anyhow::Result<()> {
     let Args { check } = Args::parse();
 
-    sync_sub_crate_versions(check)?;
+    let version = sync_sub_crate_versions(check)?;
+    let version_info = VersionInfo { version };
+
     cargo_sort(check)?;
     for lang in ["", "/ja"] {
-        sync_readme(lang, check)?;
+        sync_readme(lang, check, &version_info)?;
     }
 
     Ok::<(), anyhow::Error>(())
 }
 
 #[hooq(anyhow)]
-fn sync_sub_crate_versions(check_only: bool) -> anyhow::Result<()> {
+fn sync_sub_crate_versions(check_only: bool) -> anyhow::Result<String> {
     let workspace_toml = toml::from_str::<toml::Value>(&std::fs::read_to_string("./Cargo.toml")?)?;
 
     if workspace_toml.as_table()?.get("workspace").is_none() {
@@ -105,7 +112,7 @@ fn sync_sub_crate_versions(check_only: bool) -> anyhow::Result<()> {
         )?;
     }
 
-    Ok::<(), anyhow::Error>(())
+    Ok::<String, anyhow::Error>(version.to_string())
 }
 
 // TOMLの上書きは順番がおかしくなるので、cargo-sortで整形
@@ -132,15 +139,18 @@ fn cargo_sort(check_only: bool) -> anyhow::Result<()> {
 }
 
 #[hooq(anyhow)]
-fn sync_readme(lang: &str, check_only: bool) -> anyhow::Result<()> {
-    let common_md = std::fs::read_to_string(format!("./hooq/docs{lang}/README.md"))?;
-
-    let readme = Readme { common: common_md };
+fn sync_readme(lang: &str, check_only: bool, version_info: &VersionInfo) -> anyhow::Result<()> {
+    let common_template_md =
+        std::fs::read_to_string(format!("./docs{lang}/_readme_root.md.template"))?;
 
     let mut handlebars = handlebars::Handlebars::new();
     handlebars.set_strict_mode(true);
     handlebars.register_escape_fn(handlebars::no_escape);
 
+    let common_md = handlebars.render_template(&common_template_md, &version_info)?;
+
+    let readme = Readme { common: common_md };
+
     // GitHub README.md
     let github_template_md = std::fs::read_to_string("./docs/_readme_github.md.template")?;
     let github_readme_md = handlebars.render_template(&github_template_md, &readme)?;
@@ -158,6 +168,23 @@ fn sync_readme(lang: &str, check_only: bool) -> anyhow::Result<()> {
         std::fs::write(&path, github_readme_md)?;
     }
 
+    // hooq README.md
+    // コピーするのみ
+    let hooq_readme_md = readme.common.clone();
+
+    let path = format!("./hooq/docs{lang}/README.md");
+
+    if check_only {
+        let existing_hooq_readme_md = std::fs::read_to_string(&path)?;
+        if existing_hooq_readme_md != hooq_readme_md {
+            return Err(anyhow::anyhow!(
+                "README.md is out of date. Please run the sync script to update it."
+            ));
+        }
+    } else {
+        std::fs::write(&path, hooq_readme_md)?;
+    }
+
     // hooq-macros and hooq-helpers README.md
     let sub_crates_template_md = std::fs::read_to_string("./docs/_readme_sub_crates.md.template")?;
     let sub_crates_readme_md = handlebars.render_template(&sub_crates_template_md, &readme)?;

.github/workflows/crates_io_publish_hooq_348912.yml

@@ -12,10 +12,6 @@ jobs:
       id-token: write
     steps:
     - uses: actions/checkout@v5
-    - run: |
-        cargo publish -p hooq-helpers --dry-run
-        cargo publish -p hooq-macros --dry-run
-        cargo publish -p hooq --dry-run
     - uses: rust-lang/crates-io-auth-action@v1
       id: auth
     - run: cargo publish -p hooq-helpers

.github/workflows/create_release_note.yml

@@ -10,10 +10,6 @@ jobs:
       contents: write
     steps:
       - uses: actions/checkout@v5
-      - run: |
-          cargo publish -p hooq-helpers --dry-run
-          cargo publish -p hooq-macros --dry-run
-          cargo publish -p hooq --dry-run
       - name: Obtain Included Files List
         id: included-files-list
         run: |

Cargo.lock

@@ -11,7 +11,7 @@ members = [
 ]
 
 [workspace.package]
-version = "0.1.0"
+version = "0.1.1"
 edition = "2024"
 rust-version = "1.88.0"
 authors = ["namnium <anotherhollow1125@gmail.com>"]

Cargo.toml

@@ -1,9 +1,12 @@
 # hooq
 
-A simple macro that inserts a method before the `?` operator
+A simple macro that inserts a method before `?`.
 
 The crate name comes from the acronym "HOOk for Question mark operator".
 
+> [!NOTE]
+> 日本語版ドキュメントはこちら: [docs/ja/README.md](https://github.com/anotherhollow1125/hooq/tree/main/docs/ja)
+
 ```rust
 use hooq::hooq;
 
@@ -28,7 +31,7 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 }
 ```
 
-The above expands into the following.
+The above expands to the following.
 
 ```ignore
 use hooq::hooq;
@@ -104,22 +107,20 @@ fn main() -> Result<(), Box<dyn std::error::Error>> {
 
 ## Quick Start
 
-Add the crate with `cargo add` as shown below, or
+Add it with `cargo add` as shown below, or add it to your `Cargo.toml`.
 
 ```bash
 cargo add hooq
 ```
 
-add it to your `Cargo.toml`.
-
 ```toml
 [dependencies]
-hooq = "*"
+hooq = "0.1.1"
 ```
 
-## Methods Inserted by Default
+## Method inserted by default
 
-If nothing is specifically specified for `#[hooq]`, the following method is inserted:
+If you don't specify anything for `#[hooq]`, the following method is inserted by default.
 
 ```ignore
 .inspect_err(|e| {
@@ -130,20 +131,20 @@ If nothing is specifically specified for `#[hooq]`, the following method is inse
 })
 ```
 
-You can switch the hooked method with the inert attribute `#[hooq::method(...)]`. Also, if you specify a flavor like `#[hooq(log)]` or `#[hooq(anyhow)]` (requires the `anyhow` feature) at the macro call site, the inserted method will correspond to that flavor.
+You can switch the method to hook with the inert attribute `#[hooq::method(...)]`. Also, when you specify a flavor at the call site such as `#[hooq(log)]` or `#[hooq(anyhow)]` (the `anyhow` feature is required), the inserted method will change according to that flavor!
 
-Available flavors can be found here: [hooq-macros/src/impls/flavor/presets/](../../hooq-macros/src/impls/flavor/presets/)
+You can find the available flavors here: [hooq-macros/src/impls/flavor/presets/](https://github.com/anotherhollow1125/hooq/tree/main/hooq-macros/src/impls/flavor/presets)
 
 (More to come!)
 
 ## Attributes
 
 (WIP)
 
-## Metavariables
+## Meta variables
 
 (WIP)
 
-## Flavors
+## Flavor
 
 (WIP)