ahamilton/eris
1
0
Fork 0
Code Releases Activity

tools: Document tools.toml

Browse source 
- So that it can be understood in isolation by ai.
This commit is contained in:
Andrew Hamilton 2025-06-09 22:39:07 +10:00
parent 2b5b7f7fe9
commit a78f53740a
1 changed files with 13 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

14
eris/tools.toml
View file

@ -1,5 +1,6 @@
# tools_for_extensions is a mapping that defines which tools are run on files of
# certain types. The tools are defined below.
tools_for_extensions = [
[["py"], ["python_syntax", "python_unittests", "pytest", "pydoc", "mypy",
"python_coverage", "pycodestyle", "pyflakes",
@ -43,6 +44,17 @@ tools_for_extensions = [
[["iso"], ["isoinfo"]],
]
# Now define all the tools.
#
# Each section defines a tool by these attributes:
# dependencies: A list of debian packages that need to be installed for the tool to run.
# url: Where the tool is documented.
# command: The shell command to run the tool. All tools must produce a text report given a
# file in the codebase. The file's path is added to the end of the command.
# All reports are ideally in color. All tools should return an error code of 0 iff
# there are no issues with the file.
# has_color: Is true if the command's output is in color.
# timeout: Some commands have a timeout if they can't be trusted to finish in a reasonable time.
[python_syntax]
dependencies = []