Looking for feedback and feature requests!

[codevogel]

I'm very glad to see this repository is gaining some traction.

Through this issue I'd like to gather your thoughts on Godot Doctor so far.

What would you like to see added to Godot Doctor? More standardized validations? Better editor tooling?

If your feature request is extensive, then please do not hesitate to open up a separate issue.

[akodkod]

That's a great add-on! Thank you so much for your hard work on it!

It would be so cool to use theme colors, because currently in Godot 4.6 the Modern Light theme colors look off

[akodkod]

Another idea is to have ability to run Godot Doctor via the CLI, so it can be run on CI, for example.

[codevogel]

@akodkod

That's a great add-on! Thank you so much for your hard work on it!

It would be so cool to use theme colors, because currently in Godot 4.6 the Modern Light theme colors look off

Thank you!
I'd be happy to look into this. Please open up a new issue with instructions to reproduce and an example of what's going on.

Another idea is to have ability to run Godot Doctor via the CLI, so it can be run on CI, for example.

Interesting idea. I'd imagine this'd be a tad bit more difficult to get done, but it would be a nice addition for sure. Please open up a separate new issue for this with some explanation of your expectations of how this would work.

Thanks for the ideas!

[RedDude]

Hey, I'm migrating from the unity and I'm missing my "Validators". Doctor is most similar thing that I found. Thank you so much for your hard work on it!

In Unity, I have a tool, which I write my "validators" and they print many errors, warns and infos in the custom tab. Not just errors,
there are thing that could be a oversight or by design (due dynamic code, templating, etc). no all messages are things that actually need to be fixed.. they COULD be an error, but it may not, but is nice to let the design to know. Therefore, I also have a feature there I can set to ignore some warns/messages.

Also, would be nice to filter by "category" of messages. for instance, I have a csv validator, which checks if messages in the localization files are empty or using a character name which doesn't exist in the database (basically a typo), those massages are in the "localization" category, they are not for me to fix, but to the story-writer. would be nice to just hide those messages, the same is valid for the writer, they are not interested in any error, reference type of error. a category filter really helpful

Oh, and we also have a "double click" feature, leads the user to the error. for the localization files example, double click opens the csv in the line which the error/warns lays.

Still, I see how this could be more than Doctor intended use

Again, Thank you so much for your hard work on it!

[codevogel]

Thank you so much for your hard work on it!

Thanks 🙏

Therefore, I also have a feature there I can set to ignore some warns/messages.

Good idea, it should be relatively trivial to add a severity level. I'll look into that when I get the time. Or feel free to open up a PR. Could you open a new issue for this?

a category filter really helpful

This is interesting too. I'd welcome this feature, but it'd be a little less high on my priority list. Again, feel free to open up an issue for this.

double click opens the csv in the line which the error/warns lays.

Hmm. might be a bit harder to achieve. in this case, did you want it to bring up the script that defines the validation error? that part should be relatively trivial. But most errors will have nothing to do with external files, and rather with inspector assignment.
Open up an issue with a description on how you'd want to see this realized and I will at the very least consider it.

[RedDude]

double click opens the csv in the line which the error/warns lays.

Hmm. might be a bit harder to achieve. in this case, did you want it to bring up the script that defines the validation error? that part should be relatively trivial. But most errors will have nothing to do with external files, and rather with inspector assignment. Open up an issue with a description on how you'd want to see this realized and I will at the very least consider it.

It seems that Doctor goes to individually scripts and run a function to find errors.
The validator that I use, do this too. but it actually also allow you to write a "validator". which is code which can be executed individually, so you can write one validator which find and check CSVs, for instance. it is almost a command for a console, but it as a button to execute one, or pick many to execute, this way, non-programmers can run validators without the need to write a cmd line.

My validator is based on this project
https://github.com/maxartz15/Validator
Which I did added many new features (let the double click and allow to select one or a group of "validators" individually, not every "validators" everytime)

But yeah, the double click usually would be to open or the script file or the resource file with the problem. (if a inventory items is missing important data, you don't want to open the script, but the resource with the problem)
The double click is actually easy, you just need to allow the "register error message" function to have a parameter for a callback function for the double click, the coder will do the rest, you don't need to worry about handle external things. I still fairly a newbie in gdscript, but if it allow a callback for double click it should be possible.

[codevogel]

@RedDude

I implemented severity levels. Will probably draft a new release soon.

Category filters should be a separate issue.

Custom validators for things such as CSV are a bit out of scope for me right now, but feel free to open up a PR if you want to add support for them.

I see double-clicking an error to jump into the related code as a non-critical feature, so I'm going to sit on that for now. You can already click to open up the inspector to the relevant node, you shouldn't really be going into the code to address your validations, as Godot Doctor is a tool designed to resolve problems with inspector-level assignments.

So yeah, I see it as a nice to have, but again, feel free to open up an issue related to that specifically, (and of course, feel free to open a PR for that too).

[Leshy-YA]

The plugin is fire! Thank you for making it.

I think what would be useful is to have way to run validations in headless mode and spit out results to an XML file. This would allow to plug this into a CI system, on top of some Unit/Integration test suite.

You mentioned this is currently out of scope. So I forked the repo and will be slowly trying add this in and make PR when it's sufficiently ready.

[codevogel]

Awesome @Leshy-YA ! Let me know if you need any pointers to make it happen; Feel free to ping me in an issue on the fork.

[codevogel]

Another idea is to have ability to run Godot Doctor via the CLI, so it can be run on CI, for example.

@akodkod You may want to check out the discussion in #8 and the draft PR in #10

CLI support for CI/CD is well on it's way!
You could be of help by testing the work in #10 out. It's mostly done now, so looking for some testing so we can iron out the bugs before merging. The PR still needs some work on documentation, but it should be functional now.

Also, regarding

It would be so cool to use theme colors, because currently in Godot 4.6 the Modern Light theme colors look off

If you can open up an issue with a description of how I can reproduce it, and some screenshots on what's amiss, I can look into shipping this along with the CLI release.

[DamonFernandez]

Thank you so much for this addon it is so insanely useful!

[rmvermeulen]

Hi fellow patients!

I have some use-cases ideas that are closely related, essentially boiling down to 3 scenarios:

• to use all the default validations (default)
• to use some of the default validations (or modify them)
• to not use the default validations at all

This can be achieved in any number of ways, so I don't have an exact 'feature request', more a discussion topic.

example cases

I would like to not see the error for missing a specific argument if the scene being validated is the currently edited scene.

A pattern I commonly use is to have a scene that takes an important argument, and then somewhere else instantiate that scene with different arguments. This is often unassigned while editing the actual scene.

I would like disable or modify the validation conditions only if the scene being validated has a specific parent

A related pattern is to have some kind of "controller" node that manages a child node, in which case the validation conditions for that child node may be different.

Now:

• find the settings resource, add the script to the ignore list
• re-implement default validation conditions
• add logic to conditionally include or remove specific validation conditions

Some options that would make this easier:

1. there is an accessible method to get the default validations anyway even if the script is excluded (which may already exist)
2. there is a in-line way to disable the default validations e.g. const _USE_DOCTOR_DEFAULT := true/false
3. there is a dynamic way to disable to the validations e.g. func _use_default_validation_conditions() -> bool or static func _use_default_validation_conditions() -> bool
4. a callback func _update_default_validation_conditions(Array[ValidationCondition]) -> Array[ValidationCondition], and then have an opportunity to remove, (add?), or change items
5. a callback func _exclude_validation_conditions() -> Array[<name or type>] or similar to remove default items
6. ...

If I were doing this just for me I'd go with 1 and 3; Whenever I notice one of these unwanted warnings I would then be able to easily open the script, which is often what I'm looking at anyway, and use e.g. _use_default_validation_conditions() and GodotDoctor.get_default_validation_conditions(self) to adjust the validations a bit.

And that would also mean that the ignore list in settings is used to exclude scripts that you might not want to modify, like addons. Which makes sense to me semantically: I want to ignore other code, but I do not want to ignore my scripts, just tweak the output.

I'm of course interested in alternative approaches that I didn't think of. Cheers 😃

[codevogel]

Opened up a discussion thread for this in #51