darklua_core/rules/
make_assignment_local.rs

1use crate::nodes::{AssignmentKind, Block, FunctionAssignment, VariableAssignment};
2use crate::process::{DefaultVisitor, NodeProcessor, NodeVisitor};
3use crate::rules::{
4    Context, FlawlessRule, RuleConfiguration, RuleConfigurationError, RuleMetadata, RuleProperties,
5};
6
7use serde::ser::{Serialize, Serializer};
8
9use super::verify_no_rule_properties;
10
11#[derive(Debug, Default)]
12struct Processor;
13
14impl NodeProcessor for Processor {
15    fn process_local_assign_statement(&mut self, assign: &mut VariableAssignment) {
16        assign.set_assignment_kind(AssignmentKind::Local);
17    }
18
19    fn process_local_function_statement(&mut self, function: &mut FunctionAssignment) {
20        function.set_assignment_kind(AssignmentKind::Local);
21    }
22}
23
24pub const MAKE_ASSIGNMENT_LOCAL_RULE_NAME: &str = "make_assignment_local";
25
26/// A rule that converts Luau `const` assignments into `local` assignments.
27#[derive(Debug, Default, PartialEq, Eq)]
28pub struct MakeAssignmentLocal {
29    metadata: RuleMetadata,
30}
31
32impl FlawlessRule for MakeAssignmentLocal {
33    fn flawless_process(&self, block: &mut Block, _: &Context) {
34        let mut processor = Processor;
35        DefaultVisitor::visit_block(block, &mut processor);
36    }
37}
38
39impl RuleConfiguration for MakeAssignmentLocal {
40    fn configure(&mut self, properties: RuleProperties) -> Result<(), RuleConfigurationError> {
41        verify_no_rule_properties(&properties)?;
42
43        Ok(())
44    }
45
46    fn get_name(&self) -> &'static str {
47        MAKE_ASSIGNMENT_LOCAL_RULE_NAME
48    }
49
50    fn serialize_to_properties(&self) -> RuleProperties {
51        RuleProperties::new()
52    }
53
54    fn set_metadata(&mut self, metadata: RuleMetadata) {
55        self.metadata = metadata;
56    }
57
58    fn metadata(&self) -> &RuleMetadata {
59        &self.metadata
60    }
61}
62
63impl Serialize for MakeAssignmentLocal {
64    fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error> {
65        serializer.serialize_str(MAKE_ASSIGNMENT_LOCAL_RULE_NAME)
66    }
67}
68
69#[cfg(test)]
70mod test {
71    use super::*;
72
73    use crate::rules::Rule;
74
75    use insta::assert_json_snapshot;
76
77    fn new_rule() -> MakeAssignmentLocal {
78        MakeAssignmentLocal::default()
79    }
80
81    #[test]
82    fn serialize_default_rule() {
83        assert_json_snapshot!(new_rule(), @r###""make_assignment_local""###);
84    }
85
86    #[test]
87    fn configure_with_extra_field_error() {
88        let result = json5::from_str::<Box<dyn Rule>>(
89            r#"{
90            rule: 'make_assignment_local',
91            prop: "something",
92        }"#,
93        );
94        insta::assert_snapshot!(result.unwrap_err().to_string(), @"unexpected field 'prop' at line 1 column 1")
95    }
96}
darklua_core/rules/make_assignment_local.rs

darklua_core/rules/
make_assignment_local.rs
