Repository navigation
Document "rules"-option #1958
Description
Currently, the rules option is not documented, see #1170 and #1914. This makes it hard to find, but also causes VSCode to complain if you do use it:
It would be great if this option could be documented and added to the officially supported options.
I'm potentially willing to contribute this change myself, depending on time, but I'm wondering if there is a good reason this should not be done. Maybe it's not a stable feature or there are some caveats that should be ironed out first?
Activity
rchiodo commentedon Sep 19, 2025
I would imagine they aren't documented because we didn't want to commit to them being a specific way. But since they haven't changed in years, that's a moot point.
You'd actually document them in the vscode-python-debug extension (inside its package.json), not in debugpy itself. That's what defines the schema in VS code and causes that error you're seeing.
It would be nice if there was documentation on all of the config options here though. Most of them are supported on the command line (rules isn't I don't think) through the
--config valuecommand line:https://github.com/microsoft/debugpy/wiki/Command-Line-Reference#--configure-name-value
nightcityblade commentedon Aug 27, 2026
Hi, I'd like to work on this. I'll submit a focused PR to microsoft/vscode-python-debugger that adds the rules option to the supported launch schema and documents its accepted values.