Skip to content

Simplify config documentation and clarify default iteration behavior#8

Merged
khnumdev merged 4 commits intomainfrom
copilot/simplify-config-iteration
Jan 7, 2026
Merged

Simplify config documentation and clarify default iteration behavior#8
khnumdev merged 4 commits intomainfrom
copilot/simplify-config-iteration

Conversation

Copy link
Contributor

Copilot AI commented Jan 7, 2026

The config documentation was verbose and obscured the key fact that commands iterate over all namespaces and kinds by default. Users needed explicit guidance on when filtering is necessary versus optional.

Changes

Documentation

  • Reduced README config example from 25 lines to 9 lines showing minimal setup
  • Added explicit statement: "By default, all commands iterate over all namespaces and all kinds"
  • Removed duplicate configuration section
  • Updated CLI examples to demonstrate both default (no filters) and filtered usage

Code cleanup

  • Removed redundant is None checks in config normalization (already handled by _as_list())
  • Simplified namespace iteration logic in analyze_entity_fields.py by removing unreachable branches
  • Fixed unused imports and modernized type hints to PEP 604 syntax (str | None)

Tests

  • Added test verifying empty config lists trigger "iterate all" behavior

Example

Before (confusing):

namespaces: [""]  # [""] means include default namespace and allow discovery of others
kinds: []         # Empty/omit means discover all kinds per namespace

After (clear):

# Omit to process all namespaces and kinds (default behavior)
namespaces: ["custom-ns"]  # List specific namespaces
kinds: ["MyKind"]          # List specific kinds
Original prompt

This section details on the original issue you should resolve

<issue_title>Config simplification</issue_title>
<issue_description>- It should iterate over all namespaces and all entities by default

  • Only in case specific, through config file or by argument to lsu it should focus on a specific namespace and/or specific kind to check
  • Simplify config, dropping not used stuff
  • Update README.md, simplyfing it and removing old/not updated content

Update tests, docs.

After that, run tests and ensure all commands are working without issues.</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits January 7, 2026 10:31
Co-authored-by: khnumdev <13968776+khnumdev@users.noreply.github.com>
Co-authored-by: khnumdev <13968776+khnumdev@users.noreply.github.com>
Co-authored-by: khnumdev <13968776+khnumdev@users.noreply.github.com>
Copilot AI changed the title [WIP] Simplify configuration and update documentation Simplify config documentation and clarify default iteration behavior Jan 7, 2026
Copilot AI requested a review from khnumdev January 7, 2026 10:41
@khnumdev khnumdev marked this pull request as ready for review January 7, 2026 12:50
@khnumdev khnumdev merged commit c9f2f2a into main Jan 7, 2026
17 checks passed
@khnumdev khnumdev deleted the copilot/simplify-config-iteration branch January 7, 2026 13:06
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.

Config simplification

2 participants