diff --git a/CHANGELOG.md b/CHANGELOG.md index 3534465..4c4391f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), ## [Unreleased] +### Changed + +- Arrays in `.data.json` and `*.project.json` files are now single-line by default + ## [2.0.6] - 2024-05-08 ### Changed diff --git a/Cargo.lock b/Cargo.lock index 376e07a..0ba5407 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -340,6 +340,7 @@ dependencies = [ "glob", "globenv", "include_dir", + "json-formatter", "json2lua", "keybd_event", "lazy_static", @@ -639,6 +640,7 @@ version = "0.1.0" dependencies = [ "proc-macro2", "quote", + "serde", "syn 2.0.48", ] @@ -1522,6 +1524,13 @@ dependencies = [ "wasm-bindgen", ] +[[package]] +name = "json-formatter" +version = "0.1.0" +dependencies = [ + "serde_json", +] + [[package]] name = "json2lua" version = "0.1.2" @@ -2018,6 +2027,8 @@ name = "profiling" version = "0.1.0" dependencies = [ "profiling-procmacros 0.1.0", + "puffin", + "puffin_http", ] [[package]] @@ -2507,9 +2518,9 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.114" +version = "1.0.117" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c5f09b1bd632ef549eaa9f60a1f8de742bdbc698e6cee2095fc84dde5f549ae0" +checksum = "455182ea6142b14f93f4bc5320a2b31c1f266b66a4a5c858b013302a5d8cbfc3" dependencies = [ "indexmap", "itoa", diff --git a/Cargo.toml b/Cargo.toml index b696bdc..d3e1093 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,3 +1,4 @@ +workspace = { members = ["crates/json-formatter"] } [package] name = "argon" authors = ["Dervex"] @@ -25,6 +26,7 @@ rbx_reflection = "4.5.0" rbx_reflection_database = "0.2.10" config-derive = { version = "*", path = "crates/config-derive" } +json-formatter = { version = "*", path = "crates/json-formatter" } profiling = { version = "*", path = "crates/profiling/profiling" } serde = { version = "1.0.189", features = ["derive"] } @@ -44,7 +46,7 @@ roblox_install = "1.0.0" panic-message = "0.3.0" actix-msgpack = "0.1.1" puffin_http = "0.16.0" -serde_json = "1.0.107" +serde_json = "1.0.117" env_logger = "0.10.0" include_dir = "0.7.3" directories = "5.0.1" diff --git a/crates/json-formatter/.gitignore b/crates/json-formatter/.gitignore new file mode 100644 index 0000000..0592392 --- /dev/null +++ b/crates/json-formatter/.gitignore @@ -0,0 +1,2 @@ +/target +.DS_Store diff --git a/crates/json-formatter/Cargo.toml b/crates/json-formatter/Cargo.toml new file mode 100644 index 0000000..0806a75 --- /dev/null +++ b/crates/json-formatter/Cargo.toml @@ -0,0 +1,10 @@ +[package] +name = "json-formatter" +authors = ["Dervex"] +description = "Custom serde JSON formatter" +license = "Apache-2.0" +version = "0.1.0" +edition = "2021" + +[dependencies] +serde_json = "1.0.117" diff --git a/crates/json-formatter/LICENSE b/crates/json-formatter/LICENSE new file mode 100644 index 0000000..2332a19 --- /dev/null +++ b/crates/json-formatter/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright 2024 Dervex + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/crates/json-formatter/rustfmt.toml b/crates/json-formatter/rustfmt.toml new file mode 100644 index 0000000..218e203 --- /dev/null +++ b/crates/json-formatter/rustfmt.toml @@ -0,0 +1 @@ +hard_tabs = true diff --git a/crates/json-formatter/src/lib.rs b/crates/json-formatter/src/lib.rs new file mode 100644 index 0000000..1164dd0 --- /dev/null +++ b/crates/json-formatter/src/lib.rs @@ -0,0 +1,168 @@ +use serde_json::ser::Formatter; +use std::io; + +macro_rules! tri { + ($e:expr $(,)?) => { + match $e { + core::result::Result::Ok(val) => val, + core::result::Result::Err(err) => return core::result::Result::Err(err), + } + }; +} + +/// This structure pretty prints a JSON value to make it human readable. +#[derive(Clone, Debug)] +pub struct JsonFormatter<'a> { + current_indent: usize, + array_breaks: bool, + has_value: bool, + indent: &'a [u8], +} + +impl<'a> JsonFormatter<'a> { + /// Construct a pretty printer formatter that defaults to using two spaces for indentation. + pub fn new() -> Self { + JsonFormatter::with_indent(b" ") + } + + /// Construct a pretty printer formatter that uses the `indent` string for indentation. + pub fn with_indent(indent: &'a [u8]) -> Self { + JsonFormatter { + current_indent: 0, + array_breaks: true, + has_value: false, + indent, + } + } + + /// Construct a pretty printer formatter that optionally break arrays into multiple lines. + pub fn with_array_breaks(array_breaks: bool) -> Self { + JsonFormatter { + current_indent: 0, + array_breaks, + has_value: false, + indent: b" ", + } + } +} + +impl<'a> Default for JsonFormatter<'a> { + fn default() -> Self { + JsonFormatter::new() + } +} + +impl<'a> Formatter for JsonFormatter<'a> { + #[inline] + fn begin_array(&mut self, writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + self.current_indent += 1; + self.has_value = false; + writer.write_all(b"[") + } + + #[inline] + fn end_array(&mut self, writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + self.current_indent -= 1; + + if self.has_value && self.array_breaks { + tri!(writer.write_all(b"\n")); + tri!(indent(writer, self.current_indent, self.indent)); + } + + writer.write_all(b"]") + } + + #[inline] + fn begin_array_value(&mut self, writer: &mut W, first: bool) -> io::Result<()> + where + W: ?Sized + io::Write, + { + if !self.array_breaks { + if !first { + tri!(writer.write_all(b", ")); + } + + return Ok(()); + } + + tri!(writer.write_all(if first { b"\n" } else { b",\n" })); + indent(writer, self.current_indent, self.indent) + } + + #[inline] + fn end_array_value(&mut self, _writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + self.has_value = true; + Ok(()) + } + + #[inline] + fn begin_object(&mut self, writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + self.current_indent += 1; + self.has_value = false; + writer.write_all(b"{") + } + + #[inline] + fn end_object(&mut self, writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + self.current_indent -= 1; + + if self.has_value { + tri!(writer.write_all(b"\n")); + tri!(indent(writer, self.current_indent, self.indent)); + } + + writer.write_all(b"}") + } + + #[inline] + fn begin_object_key(&mut self, writer: &mut W, first: bool) -> io::Result<()> + where + W: ?Sized + io::Write, + { + tri!(writer.write_all(if first { b"\n" } else { b",\n" })); + indent(writer, self.current_indent, self.indent) + } + + #[inline] + fn begin_object_value(&mut self, writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + writer.write_all(b": ") + } + + #[inline] + fn end_object_value(&mut self, _writer: &mut W) -> io::Result<()> + where + W: ?Sized + io::Write, + { + self.has_value = true; + Ok(()) + } +} + +fn indent(wr: &mut W, n: usize, s: &[u8]) -> io::Result<()> +where + W: ?Sized + io::Write, +{ + for _ in 0..n { + tri!(wr.write_all(s)); + } + + Ok(()) +} diff --git a/src/middleware/data.rs b/src/middleware/data.rs index ffa7a27..c12f07e 100644 --- a/src/middleware/data.rs +++ b/src/middleware/data.rs @@ -1,4 +1,5 @@ use anyhow::Result; +use json_formatter::JsonFormatter; use log::error; use rbx_dom_weak::types::{Tags, Variant}; use serde::{Deserialize, Serialize}; @@ -161,10 +162,15 @@ pub fn write_data<'a>( return Ok(None); } - let mut vec = serde_json::to_vec_pretty(&data)?; - vec.push(b'\n'); + let formatter = JsonFormatter::with_array_breaks(false); - vfs.write(path, &vec)?; + let mut writer = Vec::new(); + let mut serializer = serde_json::Serializer::with_formatter(&mut writer, formatter); + + data.serialize(&mut serializer)?; + writer.push(b'\n'); + + vfs.write(path, &writer)?; Ok(Some(path)) } diff --git a/src/resolution.rs b/src/resolution.rs index b7f94ff..639a37d 100644 --- a/src/resolution.rs +++ b/src/resolution.rs @@ -63,16 +63,14 @@ impl UnresolvedValue { Variant::Float32(n) => AmbiguousValue::Number(n as f64), Variant::Float64(n) => AmbiguousValue::Number(n), - Variant::Int32(n) => AmbiguousValue::Number(truncate_float(n as f64)), + Variant::Int32(n) => AmbiguousValue::Number(n as f64), Variant::Int64(n) => AmbiguousValue::Number(n as f64), Variant::String(str) => AmbiguousValue::String(str), Variant::Tags(tags) => AmbiguousValue::StringArray(tags.iter().map(|s| s.to_string()).collect()), Variant::Content(content) => AmbiguousValue::String(content.into_string()), - Variant::Vector2(vector) => { - AmbiguousValue::Array2([truncate_float(vector.x as f64), truncate_float(vector.y as f64)]) - } + Variant::Vector2(vector) => AmbiguousValue::Array2([vector.x as f64, vector.y as f64]), Variant::Vector3(vector) => AmbiguousValue::Array3([vector.x as f64, vector.y as f64, vector.z as f64]), Variant::Color3(color) => AmbiguousValue::Array3([color.r as f64, color.g as f64, color.b as f64]), @@ -293,12 +291,13 @@ fn list_examples(values: &[&str]) -> String { output } -// Temporary solution to avoid saving `null` values in JSON files -fn truncate_float(float: f64) -> f64 { - if float.is_infinite() { - 999_999_999.0 * float.signum() +#[inline] +fn truncate_number(number: &f64) -> f64 { + // Temporary solution to avoid saving `null` values in JSON files + if number.is_infinite() { + 999_999_999.0 * number.signum() } else { - float + (*number * 1_000_000.0).trunc() / 1_000_000.0 } } @@ -306,7 +305,7 @@ fn serialize_number(number: &f64, serializer: S) -> Result where S: Serializer, { - let number = (*number * 1_000_000.0).trunc() / 1_000_000.0; + let number = truncate_number(number); if number.fract() == 0.0 { serializer.serialize_i64(number as i64) @@ -322,7 +321,7 @@ where let mut seq = serializer.serialize_seq(Some(array.len()))?; for number in array { - let number = (*number * 1_000_000.0).trunc() / 1_000_000.0; + let number = truncate_number(number); if number.fract() == 0.0 { seq.serialize_element(&(number as i64))?;