feat: some menu changes, added help for templates, created automatica…#11
Merged
feat: some menu changes, added help for templates, created automatica…#11
Conversation
…lly generated cli reference docs + test scaffolding
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces several updates to enhance the Steel CLI project, focusing on documentation, testing, and template management. The most significant changes include the addition of testing environment variables, auto-generated CLI documentation, new test scripts in
package.json, and improvements to the handling of templates in the CLI.Documentation Updates:
.env.test.example: Added a template file for testing environment variables, including placeholders for Steel, OpenAI, and Anthropic API keys. This file provides instructions on obtaining the required keys and explains their usage.docs/README.mdanddocs/cli-reference.md: Introduced auto-generated documentation for the Steel CLI, detailing commands, options, templates, and regeneration instructions. The documentation is generated using thescripts/generate-docs.jsscript. [1] [2]Testing Enhancements:
package.json: Added test scripts (test,test:unit,test:integration,test:watch) and Jest configuration for unit and integration testing. Removed the previousavaconfiguration in favor of Jest. [1] [2]Template Management Improvements:
source/components/help.tsx: Enhanced theHelpcomponent to include template-specific help forrunandforgecommands. Added support for displaying available templates using the newTemplateListcomponent. [1] [2] [3]source/components/templatelist.tsx: Created a newTemplateListcomponent to display available templates in a formatted list, including alias, label, and language information.Code Refinements:
source/commands/run.tsx: Improved readability and safety by using optional chaining (settings?.instance) and updated the command description for clarity. [1] [2]source/utils/session.ts: Added debug logging to thegetSettingsfunction for better visibility into configuration parsing.These changes collectively improve the usability, maintainability, and extensibility of the Steel CLI project.…lly generated cli reference docs + test scaffolding