The syntax file located under help should be integrated

## Metadata - **Commit Message**: `feat(help): integrate syntax.rb definitions into the help system` - **Branch**: `feature/m3-integrate-syntax` ## Background and Context The file `lib/aethyr/core/help/syntax.rb` contains command syntax definitions, but these are not integrated into the help system that players access via the `help` command. The syntax information should be available when a player requests help on a command, showing them the correct syntax and usage patterns. ## Expected Behavior When a player types `help <command>`, the help output includes the command's syntax definition from `syntax.rb` in addition to the descriptive help text from the `.help` file. The syntax is displayed in a clear, formatted section. ## Acceptance Criteria - [ ] `help <command>` displays syntax information when available - [ ] Syntax is formatted distinctly from the description (e.g., indented or labeled) - [ ] Commands without syntax definitions still display their help text normally - [ ] All existing syntax definitions are accessible through the help system ## Subtasks - [ ] Code: Modify `HelpLibrary` to load and index syntax definitions from `syntax.rb` - [ ] Code: Update the help display formatting to include a "Syntax:" section when syntax data is available - [ ] Code: Ensure syntax definitions are matched to help entries by command name - [ ] Docs: Update YARD comments on `HelpLibrary` and the help rendering code - [ ] Tests (Cucumber): Add `tests/unit/help_syntax.feature` covering: help with syntax, help without syntax, syntax formatting - [ ] Tests (Cucumber Integration): Add integration feature verifying help command shows syntax in a live session. - [ ] Tests (Profiling): Run `bundle exec rake unit_profile` and verify no performance regressions. - [ ] Quality: Verify coverage >=97% via `bundle exec rake unit`. If coverage is <97% then review the current unit test coverage report at `build/tests/unit/coverage/` and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun `bundle exec rake unit` to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%. - [ ] Quality: Run `bundle exec rake` (default task: unit tests with coverage) and `bundle exec rake integration`, fix any errors if needed ensuring both pass across **entire** code base, do not ignore any failure even if it seems unrelated to this commit, fix it. ## Definition of Done This issue is complete when: - All subtasks above are completed and checked off. - A Git commit is created where the **first line** of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation. - The commit is pushed to the remote on the branch matching the **Branch** in Metadata exactly. - The commit is submitted as a **pull request** to `master`, reviewed, and **merged** before this issue is marked done.

freemo commented

2019-04-17 10:04:35 +00:00

(Migrated from git.qoto.org)

Metadata

Commit Message: feat(help): integrate syntax.rb definitions into the help system
Branch: feature/m3-integrate-syntax

Background and Context

The file lib/aethyr/core/help/syntax.rb contains command syntax definitions, but these are not integrated into the help system that players access via the help command. The syntax information should be available when a player requests help on a command, showing them the correct syntax and usage patterns.

Expected Behavior

When a player types help <command>, the help output includes the command's syntax definition from syntax.rb in addition to the descriptive help text from the .help file. The syntax is displayed in a clear, formatted section.

Acceptance Criteria

help <command> displays syntax information when available
Syntax is formatted distinctly from the description (e.g., indented or labeled)
Commands without syntax definitions still display their help text normally
All existing syntax definitions are accessible through the help system

Subtasks

Code: Modify HelpLibrary to load and index syntax definitions from syntax.rb
Code: Update the help display formatting to include a "Syntax:" section when syntax data is available
Code: Ensure syntax definitions are matched to help entries by command name
Docs: Update YARD comments on HelpLibrary and the help rendering code
Tests (Cucumber): Add tests/unit/help_syntax.feature covering: help with syntax, help without syntax, syntax formatting
Tests (Cucumber Integration): Add integration feature verifying help command shows syntax in a live session.
Tests (Profiling): Run bundle exec rake unit_profile and verify no performance regressions.
Quality: Verify coverage >=97% via bundle exec rake unit. If coverage is <97% then review the current unit test coverage report at build/tests/unit/coverage/ and use it to write new Cucumber based unit tests to improve code coverage. Specifically, write Cucumber/Gherkin style unit tests that are descriptively named and specifically improve coverage on whichever file has the most uncovered lines by writing tests that will target the uncovered lines in the report. Once that is done rerun bundle exec rake unit to verify all tests pass and coverage is above >=97%. Only mark this as complete once coverage is >=97%, if not repeat this task as many times as is needed until coverage reaches >=97%.
Quality: Run bundle exec rake (default task: unit tests with coverage) and bundle exec rake integration, fix any errors if needed ensuring both pass across entire code base, do not ignore any failure even if it seems unrelated to this commit, fix it.

Definition of Done

This issue is complete when:

All subtasks above are completed and checked off.
A Git commit is created where the first line of the commit message matches the Commit Message in Metadata exactly, followed by a blank line, then additional lines providing relevant details about the implementation.
The commit is pushed to the remote on the branch matching the Branch in Metadata exactly.
The commit is submitted as a pull request to master, reviewed, and merged before this issue is marked done.