Merge pull request #769 from godot-rust/feature/prepare-crates

Packaging preparations

Author: Bromeon

.github/other/update-version.sh

@@ -0,0 +1,65 @@
+#!/bin/bash
+# Copyright (c) godot-rust; Bromeon and contributors.
+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+# Small utility to run update crate versions, used by godot-rust developers.
+
+# No args specified: do everything.
+if [ "$#" -eq 0 ]; then
+    echo "Usage: update-version.sh <newVersion>"
+    exit 1
+fi
+
+# --help menu
+args=("$@")
+for arg in "${args[@]}"; do
+    if [ "$arg" == "--help" ]; then
+        echo "Usage: update-version.sh <newVersion>"
+        echo ""
+        echo "Replaces currently published version with <newVersion>".
+        echo "Does not git commit."
+        exit 0
+    fi
+done
+
+# Uncommitted changes, see https://stackoverflow.com/a/3879077.
+#if git diff --quiet --exit-code; then
+git diff-index --quiet HEAD -- || {
+    echo "Repo contains uncommitted changes; make sure working tree is clean."
+    exit 1
+}
+
+# https://stackoverflow.com/a/11114547
+scriptFile=$(realpath "$0")
+scriptPath=$(dirname "$scriptFile")
+mainCargoToml="$scriptPath/../../godot/Cargo.toml"
+
+newVersion="${args[0]}"
+oldVersion=$(grep -Po '^version = "\K[^"]*' "$mainCargoToml")
+
+publishedCrates=(
+    "godot-bindings"
+    "godot-codegen"
+    "godot-ffi"
+    "godot-cell"
+    "godot-core"
+    "godot-macros"
+    "godot"
+)
+
+for crate in "${publishedCrates[@]}"; do
+    # Don't just replace version string itself -- the following only replaces the crate's own version
+    # (with 'version = "1.2.3"') and dependencies with "=1.2.3", which makes false positives unlikely
+    sed -i "s!version = \"${oldVersion}\"!version = \"${newVersion}\"!g" "$scriptPath/../../$crate/Cargo.toml" || exit 2
+    sed -i "s!\"=${oldVersion}\"!\"=${newVersion}\"!g" "$scriptPath/../../$crate/Cargo.toml" || exit 2
+done
+
+# For `godot` itself, update the `documentation` metadata.
+sed -i "s!documentation = \"https://docs.rs/godot/$oldVersion\"!documentation = \"https://docs.rs/godot/$newVersion\"!g" "$mainCargoToml" || exit 2
+
+git commit -am "Update crate version: $oldVersion -> $newVersion" || exit 2
+git tag "$newVersion" || exit 2
+
+echo "SUCCESS: Updated version $oldVersion -> $newVersion"

.github/workflows/update-docs.yml

@@ -128,7 +128,7 @@ jobs:
           echo "DOCS_GENERATOR_TOKEN=github_pat_$token" >> $GITHUB_ENV
 
       - name: "Notify doc workflow"
-        uses: peter-evans/repository-dispatch@v2
+        uses: peter-evans/repository-dispatch@v3
         with:
           token: ${{ env.DOCS_GENERATOR_TOKEN }}
           repository: godot-rust/dispatch-forwarder

godot-bindings/Cargo.toml

@@ -6,6 +6,9 @@ rust-version = "1.78"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "ffi", "sys"]
 categories = ["game-engines", "graphics"]
+description = "Internal crate used by godot-rust"
+repository = "https://github.com/godot-rust/gdext"
+homepage = "https://godot-rust.github.io"
 
 # Since features are additive, and we want the user to user prebuilt by default, we need to have `prebuilt-godot` as the
 # default feature. However, it's not possible to _disable_ the prebuilt dependency when specifying `api-custom` (without
@@ -40,20 +43,20 @@ api-custom-extheader = []
 
 [dependencies]
 # [version-sync] [[
-#  [line] prebuilt-$kebabVersion = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "$dotVersion" }
-prebuilt-4-0 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0" }
-prebuilt-4-0-1 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.1" }
-prebuilt-4-0-2 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.2" }
-prebuilt-4-0-3 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.3" }
-prebuilt-4-0-4 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.4" }
-prebuilt-4-1 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1" }
-prebuilt-4-1-1 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.1" }
-prebuilt-4-1-2 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.2" }
-prebuilt-4-1-3 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.3" }
-prebuilt-4-1-4 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.4" }
-prebuilt-4-2 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.2" }
-prebuilt-4-2-1 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.2.1" }
-prebuilt-4-2-2 = { optional = true, package = "godot4-prebuilt", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.2.2" }
+#  [line] prebuilt-$kebabVersion = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "$dotVersion" }
+prebuilt-4-0 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0" }
+prebuilt-4-0-1 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.1" }
+prebuilt-4-0-2 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.2" }
+prebuilt-4-0-3 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.3" }
+prebuilt-4-0-4 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.0.4" }
+prebuilt-4-1 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1" }
+prebuilt-4-1-1 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.1" }
+prebuilt-4-1-2 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.2" }
+prebuilt-4-1-3 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.3" }
+prebuilt-4-1-4 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.1.4" }
+prebuilt-4-2 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.2" }
+prebuilt-4-2-1 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.2.1" }
+prebuilt-4-2-2 = { optional = true, package = "gdextension-api", git = "https://github.com/godot-rust/godot4-prebuilt", branch = "4.2.2" }
 # ]]
 
 # Do not use bindgen 0.69, it contains regression that forces recompilation of code.

godot-bindings/src/lib.rs

@@ -5,6 +5,11 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
+//!
+//! Do not depend on this crate directly, instead use the `godot` crate.
+//! No SemVer or other guarantees are provided.
+
 pub(crate) mod watch;
 
 use std::path::Path;
@@ -97,9 +102,12 @@ mod depend_on_prebuilt {
     }
 
     pub(crate) fn get_godot_version() -> GodotVersion {
-        let version: Vec<&str> = prebuilt::GODOT_VERSION.split('.').collect::<Vec<_>>();
+        let version: Vec<&str> = prebuilt::GODOT_VERSION_STRING
+            .split('.')
+            .collect::<Vec<_>>();
+
         GodotVersion {
-            full_string: prebuilt::GODOT_VERSION.into(),
+            full_string: prebuilt::GODOT_VERSION_STRING.to_string(),
             major: version[0].parse().unwrap(),
             minor: version[1].parse().unwrap(),
             patch: version

godot-cell/Cargo.toml

@@ -6,6 +6,9 @@ rust-version = "1.78"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "ffi"]
 categories = ["game-engines", "graphics"]
+description = "Internal crate used by godot-rust"
+repository = "https://github.com/godot-rust/gdext"
+homepage = "https://godot-rust.github.io"
 
 [features]
 proptest = ["dep:proptest"]

godot-cell/src/lib.rs

@@ -5,6 +5,13 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
+//!
+//! Do not depend on this crate directly, instead use the `godot` crate.
+//! No SemVer or other guarantees are provided.
+//!
+//! # Contributor docs
+//!
 //! A re-entrant cell implementation which allows for `&mut` references to be reborrowed even while `&mut`
 //! references still exist.
 //!

godot-codegen/Cargo.toml

@@ -6,18 +6,21 @@ rust-version = "1.78"
 license = "MPL-2.0"
 keywords = ["gamedev", "godot", "engine", "codegen"]
 categories = ["game-engines", "graphics"]
+description = "Internal crate used by godot-rust"
+repository = "https://github.com/godot-rust/gdext"
+homepage = "https://godot-rust.github.io"
 
 [features]
-default = ["codegen-fmt"]
-codegen-fmt = []
+default = []
 codegen-full = []
 codegen-lazy-fptrs = []
+codegen-rustfmt = []
 double-precision = []
 api-custom = ["godot-bindings/api-custom"]
 experimental-godot-api = []
 
 [dependencies]
-godot-bindings = { path = "../godot-bindings" }
+godot-bindings = { path = "../godot-bindings", version = "=0.1.0" }
 
 heck = "0.4"
 nanoserde = "0.1.35"
@@ -31,7 +34,7 @@ quote = "1.0.29"
 regex = { version = "1.5.5", default-features = false, features = ["std", "unicode-bool", "unicode-gencat"] }
 
 [build-dependencies]
-godot-bindings = { path = "../godot-bindings" } # emit_godot_version_cfg
+godot-bindings = { path = "../godot-bindings", version = "=0.1.0" } # emit_godot_version_cfg
 
 # https://docs.rs/about/metadata
 [package.metadata.docs.rs]

godot-codegen/src/formatter/mod.rs

@@ -5,7 +5,7 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
-#![cfg(feature = "codegen-fmt")]
+#![cfg(not(feature = "codegen-rustfmt"))]
 
 use proc_macro2::{Delimiter, Spacing, TokenStream, TokenTree};
 
@@ -37,7 +37,7 @@ use proc_macro2::{Delimiter, Spacing, TokenStream, TokenTree};
 /// - anonymous function literals are a bit weird because the `|` don't have
 ///   joint spacing when they come out of a `TokenStream` and identifiers don't
 ///   have any spacing information attached, so it looks like `| arg |`.
-///   Also to know whether it's a chained bitwise or a closure would need more
+///   Also, to know whether it's a chained bitwise or, a closure would need more
 ///   information. `move | arg | x`
 /// - Because we don't keep track of what's a type and what's an expression,
 ///   generic parameters look a bit spaced out. `T < A, B >`

godot-codegen/src/generator/enums.rs

@@ -354,6 +354,7 @@ pub(crate) fn make_deprecated_enumerators(enum_: &Enum) -> TokenStream {
 
         let decl = quote! {
             #[deprecated = #msg]
+            #[doc(hidden)] // No longer advertise in API docs.
             pub const #pascal_name: #enum_name = Self::#name;
         };
 

godot-codegen/src/lib.rs

@@ -5,6 +5,11 @@
  * file, You can obtain one at https://mozilla.org/MPL/2.0/.
  */
 
+//! # Internal crate of [**godot-rust**](https://godot-rust.github.io)
+//!
+//! Do not depend on this crate directly, instead use the `godot` crate.
+//! No SemVer or other guarantees are provided.
+
 // Codegen has no FFI and thus no reason to use unsafe code.
 #![forbid(unsafe_code)]
 
@@ -46,16 +51,47 @@ fn write_file(path: &Path, contents: String) {
         .unwrap_or_else(|e| panic!("failed to write code file to {};\n\t{}", path.display(), e));
 }
 
-#[cfg(feature = "codegen-fmt")]
+#[cfg(not(feature = "codegen-rustfmt"))]
 fn submit_fn(path: PathBuf, tokens: TokenStream) {
     write_file(&path, formatter::format_tokens(tokens));
 }
 
-#[cfg(not(feature = "codegen-fmt"))]
-fn submit_fn(path: PathBuf, tokens: TokenStream) {
-    write_file(&path, tokens.to_string());
+#[cfg(feature = "codegen-rustfmt")]
+mod rustfmt {
+    use super::*;
+    use std::process::Command;
+    use std::sync::Mutex;
+
+    pub fn submit_fn(path: PathBuf, tokens: TokenStream) {
+        write_file(&path, tokens.to_string());
+        FILES_TO_RUSTFMT.lock().unwrap().push(path);
+    }
+
+    pub fn rustfmt_files() {
+        let out_files = FILES_TO_RUSTFMT.lock().unwrap();
+        println!("Format {} generated files...", out_files.len());
+
+        for files in out_files.chunks(20) {
+            let mut command = Command::new("rustfmt");
+            for file in files {
+                command.arg(file);
+            }
+
+            let status = command.status().expect("failed to invoke rustfmt");
+            if !status.success() {
+                panic!("rustfmt failed on {:?}", command);
+            }
+        }
+
+        println!("Rustfmt completed successfully");
+    }
+
+    static FILES_TO_RUSTFMT: Mutex<Vec<PathBuf>> = Mutex::new(Vec::new());
 }
 
+#[cfg(feature = "codegen-rustfmt")]
+pub(crate) use rustfmt::*;
+
 pub fn generate_sys_files(
     sys_gen_path: &Path,
     h_path: &Path,
@@ -94,6 +130,12 @@ pub fn generate_sys_files(
 
     generate_sys_module_file(sys_gen_path, &mut submit_fn);
     watch.record("generate_module_file");
+
+    #[cfg(feature = "codegen-rustfmt")]
+    {
+        rustfmt_files();
+        watch.record("rustfmt");
+    }
 }
 
 pub fn generate_core_files(core_gen_path: &Path) {
@@ -146,5 +188,11 @@ pub fn generate_core_files(core_gen_path: &Path) {
     );
     watch.record("generate_native_structures_files");
 
+    #[cfg(feature = "codegen-rustfmt")]
+    {
+        rustfmt_files();
+        watch.record("rustfmt");
+    }
+
     watch.write_stats_to(&core_gen_path.join("codegen-stats.txt"));
 }