Custom rule files
Where your rule files live, how PPROLint loads them, and how to share and override rules with files.
Your own rules live in the rules folder of the PPROLint panel. Every *.rule.json file in it is loaded next to the built-in rules, without reinstalling anything. Rules made in the rule editor are saved there too.
Add a rule file
- Open rules folder, in the Rules settings, shows the folder in Finder or Explorer. Save a file there with any text editor, then click Reload rules.
- New rule > Import rules… copies rule files you pick into the folder and reloads the rules. A
.jsonfile is renamed.rule.json; a file never overwrites another one, a number is added to its name instead.
PPROLint reads the folder when the panel starts and when you click Reload rules. It does not watch the folder: after editing a file by hand, reload. See The Rules settings.
Override a built-in rule
A file with the id of a built-in rule replaces that rule. The Rules settings mark it Modified built-in rule; deleting the file brings the built-in rule back.
Every built-in rule page shows the complete file of the rule. Copying it into the rules folder under the same name and editing it is the same as changing the rule in the editor.
If two of your files use the same id, the first one by file name is kept.
Share rules
A rule depends on nothing but its file. To give your team the same checks, share the files: everyone imports them with Import rules… or drops them in their rules folder. A shared folder under version control works too.
A rule file may have English texts only; the other languages fall back to them. To translate a rule, see Messages or Translations in the editor.
When a file has problems
A file that fails to load is listed above the rules with its problems, and it does not run at all. The other rules still run. Each problem names the file and the JSON path of the faulty value. See Troubleshooting.