phanalist

Adding new rule

E0000 Example Rule can be used as a base for any new rules. Please follow the next steps to add a new rule:

Pickup available code for a new rule, lets say it is E1234.
Create a new rule module:
```
 cp src/rules/e0.rs src/rules/e1234.rs
```

Update CODE and DESCRIPTION variables in the new src/rules/e1234.rs:

 ...
 static CODE: &str = "E1234";
 static DESCRIPTION: &str = "Your rule description";
 ...

Create PHP examples for the new rule:

 cp -r src/rules/examples/e0 src/rules/examples/e1234

Implement the validate function in src/rules/e1234.rs, returning a Violation for each problem found. Build the message with Message::new(id, template). The id is a stable slug (used as a key, e.g. by the baseline), so keep it fixed even if you reword the text. Put dynamic values in {placeholder} args rather than formatting them into the id or template text:
```
 use crate::results::{Message, Violation};

 let message = Message::new(
     "E1234:short-slug",
     "Explain the problem with {name}.",
 )
 .arg("name", name.to_string());
 violations.push(self.new_violation(file, message, span));
```
Cover it with tests in mod tests, asserting on violation.message.render().

Enable the new rule in src/rules/mod.rs:

 ...
 pub mod e1234;
 ...
 pub fn all_rules() -> HashMap<String, Box<dyn Rule>> {
     ...
     add_rule(&mut rules, Box::default() as Box<e1234::Rule>);
     ...
 }

Update README.md with new rule details.
Done! Submit a new PR with new rule.

This site is open source. Improve this page.