feat: remove CLI command stuttering and enhance documentation #30
Conversation
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
- Change CLI command from 'openapi openapi' to 'openapi spec' - Add comprehensive documentation for all 6 OpenAPI commands - Add table of contents to all README files for better navigation - Update all examples and help text throughout codebase - Improve CLI user experience by removing redundant command naming
TristanSpeakEasy
added
documentation
Contributor
📊 Test Coverage ReportCurrent Coverage: Coverage Change: ✅ No change Coverage by Package
Generated by GitHub Actions |
simplesagar
approved these changes
Aug 22, 2025
Major improvements: - Fix join command path resolution to use relative paths from main document directory - Enhance inline command to preserve security schemes referenced by global security requirements - Add comprehensive CLI integration test suite (mise-tasks/test-cli) - Update mise CI pipeline to include CLI integration tests - Optimize GitHub Actions workflow with parallel execution for builds and CLI tests Technical changes: - openapi/cmd/join.go: Fix path resolution using filepath.Rel() for proper relative paths - openapi/inline.go: Enhanced removeUnusedComponents() to preserve security schemes - openapi/testdata/: Updated test data to reflect proper path handling and security schemes - mise-tasks/ci: Added CLI integration testing step - .github/workflows/ci.yaml: Parallelized build jobs and CLI tests for faster CI execution All changes maintain backward compatibility and improve overall CLI reliability.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
🎯 Overview
This PR removes CLI command stuttering by changing from
openapi openapi validatetoopenapi spec validateand includes comprehensive enhancements to CLI functionality, bug fixes, and CI pipeline optimization.🚀 Major Changes
✅ CLI Restructuring
openapi openapi validatetoopenapi spec validatecmd/openapi/main.goto use "spec" as the command name🔧 Bug Fixes and Enhancements
filepath.Rel()for consistent relative paths🧪 Testing Infrastructure
mise-tasks/test-cliscript tests all CLI commands⚡ CI Pipeline Optimization
lint: Fast linting and format checks (runs first)test: Unit tests with coverage (Ubuntu + Windows matrix)cli-tests: CLI integration tests (Linux-only, parallel)build-ubuntu: Ubuntu build (parallel)build-windows: Windows build (parallel)📋 Updated Commands
🔍 Technical Details
Path Resolution Fix
openapi/cmd/join.goto usefilepath.Rel()for proper relative path calculationSecurity Scheme Preservation
removeUnusedComponents()inopenapi/inline.goto preserve referenced security schemesTest Data Updates
✅ Quality Assurance
🎯 Benefits
📊 Files Changed
cmd/openapi/main.go: CLI command structure updateopenapi/cmd/join.go: Path resolution fixopenapi/inline.go: Security scheme preservation enhancementopenapi/testdata/: Updated test data and expectationsmise-tasks/ci: Added CLI integration testingmise-tasks/test-cli: New comprehensive CLI test suite.github/workflows/ci.yaml: Parallelized workflow optimizationAll changes maintain backward compatibility while significantly improving CLI functionality and reliability.