feat: add a way to get the library version (#652)

Author: zxch3n

.changeset/README.md

@@ -14,3 +14,30 @@
 - Commit the changed files
 - Run `pnpm changeset publish` to publish the packages to npm
 - `git push && git push --tags`
+
+# Release Rust Crates
+
+- Run `pnpm release-rust <target-version>` to get the command that can update the version of the rust crates.
+
+```
+cargo release version -x --workspace 1.4.1 --exclude loro-rle --exclude loro-delta --exclude loro_fractional_index        
+```
+
+- Commit the changes
+- Replace the `version` command with `publish`
+
+```
+cargo release publish -x --workspace --exclude loro-rle --exclude loro-delta --exclude loro_fractional_index        
+```
+
+- Add git tags by replacing `publish` with `tag`
+
+```
+cargo release tag -x --workspace --exclude loro-rle --exclude loro-delta --exclude loro_fractional_index        
+```
+
+- Push the changes
+
+```
+git push && git push --tags
+```

crates/loro-ffi/src/lib.rs

@@ -6,7 +6,7 @@ pub use loro::{
     CounterSpan, EventTriggerKind, ExpandType, FractionalIndex, IdLp, IdSpan, JsonChange,
     JsonFutureOp, JsonFutureOpWrapper, JsonListOp, JsonMapOp, JsonMovableListOp, JsonOp,
     JsonOpContent, JsonPathError, JsonSchema, JsonTextOp, JsonTreeOp, Lamport, LoroEncodeError,
-    LoroError, PeerID, StyleConfig, TreeID, UpdateOptions, UpdateTimeoutError, ID,
+    LoroError, PeerID, StyleConfig, TreeID, UpdateOptions, UpdateTimeoutError, ID, LORO_VERSION,
 };
 pub use std::cmp::Ordering;
 use std::sync::Arc;

crates/loro-internal/VERSION

@@ -0,0 +1 @@
+1.4.2

crates/loro-internal/src/lib.rs

@@ -143,3 +143,6 @@ pub struct LoroDocInner {
     local_update_subs: SubscriberSetWithQueue<(), LocalUpdateCallback, Vec<u8>>,
     peer_id_change_subs: SubscriberSetWithQueue<(), PeerIdUpdateCallback, ID>,
 }
+
+/// The version of the loro crate
+pub const LORO_VERSION: &str = include_str!("../VERSION");

crates/loro-wasm/src/lib.rs

@@ -47,6 +47,12 @@ pub use awareness::AwarenessWasm;
 
 mod convert;
 
+/// Get the version of Loro
+#[wasm_bindgen]
+pub fn LORO_VERSION() -> String {
+    loro_internal::LORO_VERSION.to_string()
+}
+
 #[wasm_bindgen(start)]
 fn run() {
     console_error_panic_hook::set_once();

crates/loro/src/lib.rs

@@ -36,6 +36,7 @@ pub use loro_internal::diff::diff_impl::UpdateTimeoutError;
 pub use loro_internal::subscription::LocalUpdateCallback;
 pub use loro_internal::subscription::PeerIdUpdateCallback;
 pub use loro_internal::ChangeMeta;
+pub use loro_internal::LORO_VERSION;
 pub mod event;
 pub use loro_internal::awareness;
 pub use loro_internal::change::Timestamp;

package.json

@@ -11,11 +11,12 @@
     "test-all": "pnpm test && pnpm test-wasm",
     "test-wasm": "cd crates/loro-wasm && pnpm i && pnpm build-dev",
     "coverage": "mkdir -p coverage && cargo llvm-cov nextest --features test_utils,jsonpath --lcov > coverage/lcov-nextest.info && cargo llvm-cov report",
-    "release-wasm": "cd crates/loro-wasm && pnpm i && pnpm build-release",
+    "release-wasm": "deno run -A ./scripts/sync-loro-version.ts && cd crates/loro-wasm && pnpm i && pnpm build-release",
     "check": "cargo clippy --all-features -- -Dwarnings",
     "run-fuzz-corpus": "cd crates/fuzz && cargo +nightly fuzz run all -- -max_total_time=1",
     "fix": "cargo clippy --fix --features=test_utils",
-    "vet": "cargo vet"
+    "vet": "cargo vet",
+    "release-rust": "deno run -A ./scripts/cargo-release.ts"
   },
   "keywords": [],
   "author": "",

scripts/bump-rust-crates.ts

@@ -1,6 +1,7 @@
 #!/usr/bin/env -S deno run --allow-run
 
 import { defineCommand, runMain } from "npm:citty";
+import { runSyncLoroVersion } from "./sync-loro-version.ts";
 
 async function runCargoRelease(version: string): Promise<string> {
   const process = new Deno.Command("cargo", {
@@ -62,6 +63,7 @@ const main = defineCommand({
       throw new Error("Version must be in format x.y.z (e.g., 1.2.3)");
     }
 
+    runSyncLoroVersion(version);
     const output = await runCargoRelease(version);
     console.log("Original output:");
     console.log(output);

scripts/cargo-release.ts

@@ -0,0 +1,65 @@
+import { compare as semverCompare, parse as semverParse } from "npm:semver";
+import { readFileSync, writeFileSync } from "node:fs";
+
+/**
+ * Syncs the version between package.json and a version file,
+ * using the higher version number
+ */
+export function syncLoroVersion(
+  packageJsonPath: string,
+  versionFilePath: string,
+  checkVersion: string = "",
+) {
+  // Read package.json
+  const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8"));
+  const packageVersion = packageJson.version;
+
+  // Read version file
+  const versionFileContent = readFileSync(versionFilePath, "utf-8");
+  const versionFileVersion = versionFileContent.trim();
+
+  // Parse and compare versions
+  const parsedPackageVersion = semverParse(packageVersion);
+  const parsedFileVersion = semverParse(versionFileVersion);
+
+  if (!parsedPackageVersion || !parsedFileVersion) {
+    throw new Error("Invalid version format found");
+  }
+
+  // Compare versions
+  const comparison = semverCompare(packageVersion, versionFileVersion);
+
+  if (comparison > 0) {
+    // package.json version is higher
+    writeFileSync(versionFilePath, packageVersion);
+    console.log(`Updated version file to ${packageVersion}`);
+    if (checkVersion && checkVersion !== packageVersion) {
+      throw new Error(`Version mismatch: Expected version ${checkVersion} but found ${packageVersion} in package.json and ${versionFileVersion} in VERSION file`)
+    }
+  } else if (comparison < 0) {
+    // version file version is higher
+    packageJson.version = versionFileVersion;
+    writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + "\n");
+    console.log(`Updated package.json to ${versionFileVersion}`);
+    if (checkVersion && checkVersion !== versionFileVersion) {
+      throw new Error(`Version mismatch: Expected version ${checkVersion} but found ${packageVersion} in package.json and ${versionFileVersion} in VERSION file`)
+    }
+  } else {
+    console.log("Versions are already in sync");
+    if (checkVersion && checkVersion !== versionFileVersion) {
+      throw new Error(`Version mismatch: Expected version ${checkVersion} but found ${packageVersion} in package.json and ${versionFileVersion} in VERSION file`)
+    }
+  }
+}
+
+export function runSyncLoroVersion(checkVersion: string = "") {
+  syncLoroVersion(
+    "./crates/loro-wasm/package.json",
+    "./crates/loro-internal/VERSION",
+    checkVersion
+  );
+}
+
+if (import.meta.main) {
+  runSyncLoroVersion();
+}