feat: WIP

serde_luacats/Cargo.toml

@@ -0,0 +1,8 @@
+[package]
+name = "serde_luacats"
+version = "0.1.0"
+edition = "2024"
+
+[dependencies]
+insta = "1.43.2"
+serde = { workspace = true }

serde_luacats/src/.ser.rs.pending-snap

@@ -0,0 +1,4 @@
+{"run_id":"1757770490-872092575","line":386,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":386,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field other ---@class Other\n---@field cool bool"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}
+{"run_id":"1757770536-381047902","line":386,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":386,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field test nil"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}
+{"run_id":"1757770547-700188086","line":386,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":386,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field test bool"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}
+{"run_id":"1757770652-863230562","line":389,"new":{"module_name":"serde_luacats__ser","snapshot_name":"test","metadata":{"source":"serde_luacats/src/ser.rs","assertion_line":389,"expression":"to_string(&test).unwrap()"},"snapshot":"---@class Test\n---@field int integer\n---@field text string\n---@field test bool|nil"},"old":{"module_name":"serde_luacats__ser","metadata":{},"snapshot":"---@class Test\n---@field int integer\n---@field text string"}}

serde_luacats/src/error.rs

@@ -0,0 +1,26 @@
+use std::fmt::{self, Display};
+
+use serde::ser;
+
+pub type Result<T> = std::result::Result<T, Error>;
+
+#[derive(Debug)]
+pub enum Error {
+    Message(String),
+}
+
+impl ser::Error for Error {
+    fn custom<T: Display>(msg: T) -> Self {
+        Self::Message(msg.to_string())
+    }
+}
+
+impl Display for Error {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        match self {
+            Error::Message(msg) => f.write_str(msg),
+        }
+    }
+}
+
+impl std::error::Error for Error {}

serde_luacats/src/lib.rs

@@ -0,0 +1,5 @@
+mod error;
+mod ser;
+
+pub use error::{Error, Result};
+// pub use ser::{Serializer, to_string};

serde_luacats/src/ser.rs

@@ -0,0 +1,394 @@
+use serde::{Serialize, ser};
+
+use crate::error::{Error, Result};
+
+pub struct Serializer {
+    output: String,
+}
+
+pub fn to_string<T: Serialize>(value: &T) -> Result<String> {
+    let mut serializer = Serializer {
+        output: String::new(),
+    };
+
+    value.serialize(&mut serializer)?;
+
+    Ok(serializer.output)
+}
+
+impl<'a> ser::Serializer for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    type SerializeSeq = Self;
+    type SerializeTuple = Self;
+    type SerializeTupleStruct = Self;
+    type SerializeTupleVariant = Self;
+    type SerializeMap = Self;
+    type SerializeStruct = Self;
+    type SerializeStructVariant = Self;
+
+    fn serialize_bool(self, v: bool) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "bool";
+
+        Ok(())
+    }
+
+    fn serialize_i8(self, v: i8) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_i16(self, v: i16) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_i32(self, v: i32) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_i64(self, v: i64) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u8(self, v: u8) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u16(self, v: u16) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u32(self, v: u32) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_u64(self, v: u64) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "integer";
+
+        Ok(())
+    }
+
+    fn serialize_f32(self, v: f32) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "number";
+
+        Ok(())
+    }
+
+    fn serialize_f64(self, v: f64) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "number";
+
+        Ok(())
+    }
+
+    fn serialize_char(self, v: char) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_str(self, v: &str) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "string";
+
+        Ok(())
+    }
+
+    fn serialize_bytes(self, v: &[u8]) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_none(self) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "nil";
+
+        Ok(())
+    }
+
+    fn serialize_some<T>(self, value: &T) -> std::result::Result<Self::Ok, Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        value.serialize(&mut *self)?;
+        self.output += "|nil";
+
+        Ok(())
+    }
+
+    fn serialize_unit(self) -> std::result::Result<Self::Ok, Self::Error> {
+        self.output += "nil";
+
+        Ok(())
+    }
+
+    fn serialize_unit_struct(
+        self,
+        name: &'static str,
+    ) -> std::result::Result<Self::Ok, Self::Error> {
+        self.serialize_unit()
+    }
+
+    fn serialize_unit_variant(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+    ) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_newtype_struct<T>(
+        self,
+        name: &'static str,
+        value: &T,
+    ) -> std::result::Result<Self::Ok, Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn serialize_newtype_variant<T>(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+        value: &T,
+    ) -> std::result::Result<Self::Ok, Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn serialize_seq(
+        self,
+        len: Option<usize>,
+    ) -> std::result::Result<Self::SerializeSeq, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_tuple(self, len: usize) -> std::result::Result<Self::SerializeTuple, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_tuple_struct(
+        self,
+        name: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeTupleStruct, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_tuple_variant(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeTupleVariant, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_map(
+        self,
+        len: Option<usize>,
+    ) -> std::result::Result<Self::SerializeMap, Self::Error> {
+        todo!()
+    }
+
+    fn serialize_struct(
+        self,
+        name: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeStruct, Self::Error> {
+        self.output += &format!("---@class {name}\n");
+
+        Ok(self)
+    }
+
+    fn serialize_struct_variant(
+        self,
+        name: &'static str,
+        variant_index: u32,
+        variant: &'static str,
+        len: usize,
+    ) -> std::result::Result<Self::SerializeStructVariant, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeSeq for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_element<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeTuple for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_element<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeTupleStruct for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeTupleVariant for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeMap for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_key<T>(&mut self, key: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn serialize_value<T>(&mut self, value: &T) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+impl<'a> ser::SerializeStruct for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(
+        &mut self,
+        key: &'static str,
+        value: &T,
+    ) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        self.output += &format!("---@field {key} ");
+        value.serialize(&mut **self)?;
+        self.output += "\n";
+
+        Ok(())
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        Ok(())
+    }
+}
+
+impl<'a> ser::SerializeStructVariant for &'a mut Serializer {
+    type Ok = ();
+
+    type Error = Error;
+
+    fn serialize_field<T>(
+        &mut self,
+        key: &'static str,
+        value: &T,
+    ) -> std::result::Result<(), Self::Error>
+    where
+        T: ?Sized + Serialize,
+    {
+        todo!()
+    }
+
+    fn end(self) -> std::result::Result<Self::Ok, Self::Error> {
+        todo!()
+    }
+}
+
+#[test]
+fn test() {
+    #[derive(Serialize)]
+    struct Other {
+        cool: bool,
+    }
+
+    #[derive(Serialize)]
+    struct Test {
+        int: u32,
+        text: String,
+        test: Option<bool>, // other: Other,
+    }
+
+    let test = Test {
+        int: 1,
+        text: "Hello, World".into(),
+        test: Some(true), // other: Other { cool: true },
+    };
+
+    insta::assert_snapshot!(to_string(&test).unwrap(), @r"
+    ---@class Test
+    ---@field int integer
+    ---@field text string
+    ");
+}