Skip to content

Commit 699a81e

Browse files
authored
chore(cartridge): skip formatting on auto-generated code (#267)
The code generated under [`cartridge/src/controller.rs`] may not comply with the formatting expected by [`rustfmt`]. This can trigger false positives and unnecessary diffs when running formatting checks. Instead of enforcing formatting, we exclude the file entirely since the code may be rewritten on every build, making formatting noisy. [`cartridge/src/controller.rs`]: https://github.com/dojoengine/katana/blob/c4403da82ffbda6ce0143b6f99082d79267a6131/crates/cartridge/src/controller.rs [`rustfmt`]: https://github.com/dojoengine/katana/blob/c4403da82ffbda6ce0143b6f99082d79267a6131/scripts/rust_fmt.sh#L1-L12
1 parent 90963c4 commit 699a81e

File tree

3 files changed

+18
-17
lines changed

3 files changed

+18
-17
lines changed

crates/cartridge/build.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,11 @@ fn main() {
1919

2020
let mut generated_code = String::new();
2121

22+
generated_code.push_str(
23+
"//! This file is automatically generated by build.rs script of this crate. Do not edit \
24+
manually.\n\n",
25+
);
26+
2227
// Read all .json files from the classes directory
2328
if let Ok(entries) = fs::read_dir(&classes_dir) {
2429
let mut contracts = Vec::new();
@@ -52,8 +57,7 @@ fn main() {
5257

5358
generated_code.push_str(&format!(
5459
"::katana_contracts::contract!(\n {},\n \
55-
\"{{CARGO_MANIFEST_DIR}}/controller/account_sdk/artifacts/classes/{}.json\"\n);
56-
",
60+
\"{{CARGO_MANIFEST_DIR}}/controller/account_sdk/artifacts/classes/{}.json\"\n);\n",
5761
struct_name, file_name
5862
));
5963
}

crates/cartridge/src/controller.rs

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,30 @@
1+
//! This file is automatically generated by build.rs script of this crate. Do not edit manually.
2+
13
::katana_contracts::contract!(
24
ControllerLatest,
3-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.latest.\
4-
contract_class.json"
5+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.latest.contract_class.json"
56
);
67
::katana_contracts::contract!(
78
ControllerV104,
8-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.4.\
9-
contract_class.json"
9+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.4.contract_class.json"
1010
);
1111
::katana_contracts::contract!(
1212
ControllerV105,
13-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.5.\
14-
contract_class.json"
13+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.5.contract_class.json"
1514
);
1615
::katana_contracts::contract!(
1716
ControllerV106,
18-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.6.\
19-
contract_class.json"
17+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.6.contract_class.json"
2018
);
2119
::katana_contracts::contract!(
2220
ControllerV107,
23-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.7.\
24-
contract_class.json"
21+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.7.contract_class.json"
2522
);
2623
::katana_contracts::contract!(
2724
ControllerV108,
28-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.8.\
29-
contract_class.json"
25+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.8.contract_class.json"
3026
);
3127
::katana_contracts::contract!(
3228
ControllerV109,
33-
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.9.\
34-
contract_class.json"
29+
"{CARGO_MANIFEST_DIR}/controller/account_sdk/artifacts/classes/controller.v1.0.9.contract_class.json"
3530
);

crates/cartridge/src/lib.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
pub mod client;
2-
pub mod controller;
32
pub mod vrf;
43

54
pub use client::Client;
5+
6+
#[rustfmt::skip]
7+
pub mod controller;

0 commit comments

Comments
 (0)