semagnum / blint

Blender project linter

Hello, welcome to my page!

Blender

Within Blender, I create art as well as develop tools, some of which I sell online. You can find my art at portfolio.pixelfed.social/smagnusson, but my free tools live here, including:

• Light Painter - "turns light design in Blender on its head: instead of manipulating the lights, you indicate how you want them to appear on your models by painting their influence. Very cool and innovative!" - Blender Nation
• Scene Complexity - convenience add-on that retrieves scene statistics to better understand geometry and node tree complexity.
• BLint - automate standardization and file conventions on the Blender projects.

blint's Issues

Use UI List template

• filtering based on description
• sort by severity type

Currently, the rows are dynamically made from the rules, so multiple rows can be made from one rule. So it doesn't work with the panel for the iterative rules. Need to create a separate class for the issues themselves.

More accessible creation of rules: UI-based

Need a sort of creation system for rules:

• for issue detection, could copy and paste data path(s) into rule, check for specific value.
• for the auto-fix, ideally macro-based. User starts recording, does the fix, stops recording.
• iterative rules and fixes would get more complicated - research needed

README required

Right click context menu option

I would like to hover over a field/property, and in the context menu, have the option to BLint issue with this rule. The following options would be available:

• "custom", opens up preferences with fields auto-filled
  • category icon based on area/region or property path
  • bpy.data is in property path, add it to iterable expression
• "must be this value", creates a rule where the property must be the current value

Don't force inclusion of internal config

Have internal config be default filepath. Only have one config path - internal config isn't included all the time.

Pre-render check

Add an option to throw an error/warning prior to rendering if any errors or info's exist.

Sort issues by severity

Enable/disable rules

• add a UI list in the preferences to enable/disable different rules
• must be able to persist during reloads - make a cache right before clearing. Based on description, or make a "rule id" of sorts"

GUI version of offline linter

Add a button and file/folder selection form field so users can run the offline linter without needing to open up the terminal. Use Blender's own Python executable.

• Add operator to run offline linter. Use Blender' own Python executable.
• In the preferences, add said operator as a button and a StringProperty as a file/folder field to select where to run it
• Convert operator to modal so it doesn't block/freeze UI

Issue list filters

Filter by:

• fixable
• error type

Some Index errors in the console

Doesn't seem to break anything (ie being caught), but there's some index out of bounds errors in the console for some issues. Will try to replicate it again and figure out the root cause.

Upon change of external rules filepath, reload the rules

Expected: When external rules filepath property in the preferences changes, reload rules automatically.
Current: When external rules filepath property in the preferences changes, nothing happens.

Github Pages

Especially for newcomers, there's enough learning and documentation to be more than a README.

• Installation
• Creating rules
• How to enable/disable or delete rules

Offline linter auto-fix option

When a flag is added, say, "--auto-fix", the offline linter will run the fixes and save before closing each file.

Offline linter

It'd be good to have a script that runs the linting process offline on a Blender file or directory full of Blender files.

Config settings:

• from the addon

• from an external config in Blender preferences

• from a separate config file

• Powershell

• Python

Edit existing rules within the preferences

There's currently no way to edit an existing rule. It would need to be a subpanel for editing rules (or "replaces" the new rule subpanel) - a modal would disappear as the user leaves the area. And being able to copy-and-paste from other areas of Blender is essential.

Manage verbosity of offline linter

Add a verbosity flag so info logs per-file gets pushed down to error/warning only logs.

Saving new rules to external (or internal) configs

Being able to:

• save to external config
• save to internal config
• factory reset for internal config

Requirements: #7

New default rule: texture checks

A new rule to include in the internal config: for every image texture, check that it has a valid path or it's packed into the file

Better iterable_var name replacement in issue expression and fix statements

Smaller variable names can be problematic as the current name replacement is a simple replaceAll, especially for smaller names. For example, an iterable var of s with an issue expression of:
s.cycles.use_preview_adaptive_sampling
would become:
bpy.data.scenes['Scene'].cyclebpy.data.scenes['Scene'].use_preview_adaptive_bpy.data.scenes['Scene']ampling

Can use regex with boundaries to ensure that it's a whole word and not just part of one.

Update Fix button arrangement

Currently there is a "Fix" button on each row of the issues list. To relax the UI space, I should:

• add a "Fix selected" button below the list, which will run a fix on the issue currently selected
• add a "Fix All" button below the list, which will run the fix on all issues that can be auto-fixed
• remove the "fix" button for each row, but have an icon for issues that have an auto-fix

Convert print statements to logging

In most cases, I'd say convert these print statements to actual exceptions. But in this case, there's few operators included where it makes sense to put them. So instead, any print statements not underneath an operator should be put within a logger.

Error after installing the plugin and enabling it！

Blender3.6/BLint-0.31
Traceback (most recent call last):
File "G:\Blender Program\stable\blender-3.6.0-windows-x64\3.6\scripts\modules\addon_utils.py", line 369, in enable
mod.register()
File "C:\Users\CP\AppData\Roaming\Blender Foundation\Blender\Big addons\addons\BLint_init_.py", line 64, in register
model.register()
File "G:\Blender Program\stable\blender-3.6.0-windows-x64\3.6\scripts\modules\bpy\utils_init_.py", line 744, in register
register_class(cls)
ValueError: register_class(...): already registered as a subclass 'LintIssue'