Skip to content

fix: improve ignored_paths YAML guidance#1575

Open
zerone0x wants to merge 1 commit into
oraios:mainfrom
zerone0x:fix/ignored-paths-yaml-hint-1561
Open

fix: improve ignored_paths YAML guidance#1575
zerone0x wants to merge 1 commit into
oraios:mainfrom
zerone0x:fix/ignored-paths-yaml-hint-1561

Conversation

@zerone0x

Copy link
Copy Markdown
Contributor

Fixes #1561.

This makes unquoted *-prefixed ignored_paths globs fail with a clear hint instead of a raw YAML alias error, and adds quoted examples to the project/global config docs and templates.

Tested with:

  • uv run --extra dev ruff format --check src/serena/util/yaml.py test/serena/config/test_serena_config.py
  • uv run --extra dev ruff check src/serena/util/yaml.py test/serena/config/test_serena_config.py
  • uv run --extra dev pytest test/serena/config/test_serena_config.py -vv
  • uv run --with codespell codespell docs/02-usage/040_workflow.md src/serena/resources/project.template.yml src/serena/resources/serena_config.template.yml

Fixes oraios#1561

Co-Authored-By: Claude <noreply@anthropic.com>
(which, by default, is ignored by git).
Any keys defined therein will override the respective key in `project.yml`.

For large C# / Roslyn repositories, `ignored_paths` is often the easiest way to keep nested examples,

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is too specific for this top-level doc. Instead, we could add an entry notes_on_ignore_settings to 03-special guides and link to it here, mentioning that it's particularly relevant for certain language servers or in certain situations. Does the C# LS not respect .gitignore?

@MischaPanch MischaPanch force-pushed the main branch 6 times, most recently from ee32c5e to ebe7646 Compare June 28, 2026 20:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve ignored_paths docs and validation for large C# repos

2 participants