0ad/source/tools/entity
Dunedan ea647067f0
Enable ruff rules to check for ambiguous code
This enables some ruff rules to check for ambiguous and dead Python
code, which might cause unintended side-effects.

The enabled rules are:

- a bunch of rules related to shadowing of builtin structures (A)
- a bunch of rules checking for unused arguments (ARG)
- a rule checking for useless expressions (B018)
- a rule checking for unbound loop variables (B023)
- a rule checking redefined function parameters (PLR1704)
2024-08-27 19:28:11 +02:00
..
scriptlib Enable additional ruff rules 2024-08-25 06:29:39 +02:00
checkrefs.py Enable ruff rules to check for ambiguous code 2024-08-27 19:28:11 +02:00
creationgraph.pl Improve and fix checkrefs.pl, add a readme for usage, add mod support, add command line arguments. 2019-02-24 21:19:20 +00:00
creationgraph.py Enable additional ruff rules 2024-08-25 06:29:39 +02:00
entvalidate.pl Improve and fix checkrefs.pl, add a readme for usage, add mod support, add command line arguments. 2019-02-24 21:19:20 +00:00
entvalidate.py Enable ruff rules to check for ambiguous code 2024-08-27 19:28:11 +02:00
readme.md Add a markdownlint pre-commit hook 2024-08-27 10:06:31 +02:00

Checkrefs.py

Description

This script checks the game files for missing dependencies, unused files, and for file integrity. If mods are specified, all their dependencies are also checked recursively. This script is particularly useful to detect broken actors or templates.

Requirements

  • Python 3.6+ interpreter installed
  • lxml for the -a option.

Usage

  • cd in source/tools/entity and run the script.
usage: checkrefs.py [-h] [-u] [-x] [-a] [-t] [-m MOD [MOD ...]]

Checks the game files for missing dependencies, unused files, and for file integrity.

options:
  -h, --help            show this help message and exit
  -u, --check-unused    check for all the unused files in the given mods and their dependencies.
                        Implies --check-map-xml. Currently yields a lot of false positives.
  -x, --check-map-xml   check maps for missing actor and templates.
  -a, --validate-actors
                        run the validator.py script to check if the actors files have extra or
                        missing textures.
  -t, --validate-templates
                        run the validator.py script to check if the xml files match their (.rng)
                        grammar file.
  -m MOD [MOD ...], --mods MOD [MOD ...]
                        specify which mods to check. Default to public.