Skip to content

Conversation

@httpdss
Copy link
Owner

@httpdss httpdss commented Aug 2, 2025

Add autocomplete support for structure names in generate command.

  • Added StructuresCompleter class
  • Integrated with generate command positional argument
  • Added tests and documentation
  • All 44 existing tests pass

- Add StructuresCompleter class that dynamically discovers available structure names
- Support custom structure paths via --structures-path argument
- Integrate completer with generate command's structure_definition positional argument
- Add comprehensive tests for completion functionality
- Include setup documentation for enabling autocomplete in shell
- All 44 existing tests continue to pass

This enables tab completion for structure names when using 'struct generate',
making the tool more user-friendly by showing all 47+ available structures
from both built-in contribs and custom paths.
@codecov-commenter
Copy link

codecov-commenter commented Aug 2, 2025

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 95.55556% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 69.55%. Comparing base (af57889) to head (5b366ac).

Files with missing lines Patch % Lines
struct_module/completers.py 92.30% 1 Missing and 1 partial ⚠️
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #83      +/-   ##
==========================================
+ Coverage   68.74%   69.55%   +0.81%     
==========================================
  Files          23       23              
  Lines        1331     1373      +42     
  Branches      181      188       +7     
==========================================
+ Hits          915      955      +40     
- Misses        374      375       +1     
- Partials       42       43       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

- Enhanced docs/completion.md with detailed structure name completion info
- Added completion setup hints to installation guide
- Updated quickstart guide with structure discovery section
- Added completion usage tips to usage guide
- Removed standalone AUTOCOMPLETE_SETUP.md (integrated into docs/)
- Added references to completion throughout documentation
@httpdss
Copy link
Owner Author

httpdss commented Aug 2, 2025

📚 Documentation Update

Enhanced the documentation with comprehensive completion setup and usage information:

  • Updated docs/completion.md with detailed structure name completion examples
  • Added completion hints to installation guide for better onboarding
  • Enhanced quickstart guide with structure discovery section
  • Updated usage guide with completion tips
  • Integrated completion references throughout the documentation
  • Removed standalone setup file - everything is now properly integrated with MkDocs

The completion documentation is now properly integrated with the existing docs structure and provides clear setup instructions for users.

Content has been integrated into docs/completion.md and properly
referenced throughout the documentation structure.
@httpdss httpdss added minor enhancement New feature or request labels Aug 2, 2025
@httpdss httpdss self-assigned this Aug 2, 2025
@httpdss httpdss merged commit ac4009a into main Aug 2, 2025
3 checks passed
@httpdss httpdss deleted the feature/add-autocomplete-for-structure-names branch August 2, 2025 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request feature minor

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants