Commit Graph

19 Commits

Author SHA1 Message Date
reynold
8f3b8f73b5 Simplify navigation: clean home icon on left side of command titles
- Replace ugly right-aligned navigation with simple left-side home icon
- Use format: ### [🏠](#salesforce-cli-wrapper-scripts) command-name
- Keep anchor IDs intact to ensure table of contents links work properly
- Clean, unobtrusive navigation that doesn't clutter the document
- Consistent formatting across all 12 wrapper command sections
2025-08-28 22:48:24 +08:00
reynold
41fa9c5da8 Fix navigation: move Back to Top links to right side and restore anchor functionality
- Move all 'Back to Top' links to right side using <div align="right">
- Add explicit anchor IDs to all command sections to restore table of contents navigation
- Fix broken anchor links that were caused by adding Back to Top text to headers
- Ensure table of contents links in Overview section work properly again
- Professional right-aligned navigation with functional anchor jumping
2025-08-28 22:46:25 +08:00
reynold
23c7511f90 Add navigation home links to all wrapper command sections
- Add '🏠 Back to Top' links to all 12 wrapper command section headers
- Links jump to main title for easy navigation in long README document
- Improves user experience by making it easy to return to overview/TOC
- Consistent formatting across all command documentation sections
2025-08-28 22:43:30 +08:00
reynold
c029b53ff7 Remove non-existent long-form options from README documentation
- Remove --target-org, --help, --verbose and other long-form options that don't exist in wrapper scripts
- Wrapper scripts only support two-character options (-to, -hp, -ve, etc.)
- Fix Benefits section to remove reference to 'long options' that don't exist
- Ensure documentation accurately reflects actual script functionality
- All examples now correctly show only two-character options as implemented
2025-08-28 22:40:57 +08:00
reynold
067693beb2 Fix README.md option inconsistencies to follow two-character scheme
- Change -d to -dr in development workflow example (line 622)
- Change -h to -hp in help documentation description (line 680)
- Ensure all examples consistently use two-character options throughout documentation
- Maintain single-character options only in 'traditional approach' comparison example
2025-08-28 22:38:00 +08:00
reynold
c2215d6abd Add Credits section to README.md
- Add author attribution (Reynold) to the documentation
- Include project description highlighting the innovative two-character option scheme
- Position credits section before License section for proper attribution
2025-08-28 22:34:30 +08:00
reynold
833eb9448a Enhanced README.md with improved formatting and detailed option descriptions
- Added horizontal separators (---) between each wrapper command for better visual separation
- Added comprehensive **Options:** sections for each command with detailed descriptions
- Updated all usage examples to be more concise and consistent
- Provided brief descriptions for every two-character option across all commands
- Improved readability by organizing content in a more structured format
- Made the documentation consistent with the help text format from the actual scripts
- Enhanced user experience by making it easier to find and understand each command's options

This makes the README much more readable and provides users with clear,
detailed information about each option similar to the built-in help text.
2025-08-28 22:12:23 +08:00
reynold
1ae8df8561 Enforce strict two-character option scheme across all wrapper scripts
- Removed long options from input parsing in all bash scripts
- Updated all help texts to show only two-character options
- Fixed error messages to reference short options only
- All scripts now reject long options like --help, --verbose, --target-org
- Maintained internal use of long sf CLI commands (e.g., --target-org passed to sf)
- Updated README.md documentation to reflect two-character scheme only
- Scripts affected: sf-retrieve, sf-test-run, sf-data-import, sf-data-export
- PowerShell scripts already used correct two-character parameter scheme
- All wrapper scripts now have consistent user interface

This ensures strict consistency in the two-character option scheme
while maintaining backward compatibility for the sf CLI commands themselves.
2025-08-28 22:07:34 +08:00
reynold
7aa7a7a688 Fix sf-org-info two-character options: standardize to -lm/-ls, update docs and tests 2025-08-28 21:50:44 +08:00
reynold
ca98742891 Fix macOS compatibility: Add portable timeout helper
- Add utils.sh with cross-platform timeout functions for macOS compatibility
- Fix sf-logs-tail to use portable_timeout instead of GNU timeout command
- Fix test-all-wrappers.sh to use portable_timeout_seconds for testing
- Update README.md with macOS compatibility documentation

The timeout command is not available by default on macOS, causing
sf-logs-tail and test scripts to fail. The new utils.sh provides
fallback timeout functionality that works on Linux, macOS with/without
GNU coreutils, maintaining exit code 124 compatibility.
2025-08-28 21:08:58 +08:00
Reynold Lariza
159ede3794 Standardize verbose parameter from -vb to -ve across all scripts
- Update all Bash scripts (sf-check, sf-org-info, sf-data-export, sf-data-import, sf-logs-tail) to use -ve instead of -vb
- Update all PowerShell scripts (sf-org-info.ps1, sf-apex-run.ps1, sf-check.ps1, sf-data-export.ps1, sf-data-import.ps1) to use -ve instead of -vb
- Fix PowerShell parameter conflicts with built-in -Verbose parameter
- Update README.md, TESTING.md, and OPTION_CONSISTENCY.md documentation to reflect -ve parameter
- Update test scripts (test-wrapper-suite.sh, test-wrapper-suite.ps1, test-all-wrappers.sh) to use -ve
- Maintain cross-platform consistency with two-character option scheme
- Fix Unicode display issues in PowerShell output with UTF-8 encoding
2025-08-28 20:47:46 +08:00
reynold
312727a905 Complete PowerShell test suite implementation with comprehensive documentation
🎯 PowerShell Testing Suite Completed:

 Cross-Platform Test Scripts:
  - quick-test.ps1: PowerShell equivalent of essential validation
  - test-wrapper-suite.ps1: Full comprehensive testing suite
  - 100% feature parity with Bash versions
  - PowerShell-native colored output and logging
  - Cross-platform compatibility (Windows, macOS, Linux)

🧪 Test Features:
  - Identical test coverage to Bash versions
  - Same test structure and validation logic
  - PowerShell-native error handling and object pipeline
  - Compatible with PowerShell 5.1+ and PowerShell Core 6+
  - Same output structure for compatibility

📚 Complete Documentation Updates:
  - TESTING.md: Comprehensive PowerShell testing instructions
  - README.md: Added testing section with both Bash and PowerShell examples
  - Platform testing matrix and troubleshooting guides
  - Cross-platform execution examples and prerequisites

🚀 Production Ready Features:
  - Full cross-platform test validation
  - Consistent two-character option scheme
  - Professional documentation and user guidance
  - Ready for Windows, macOS, and Linux environments

The SF CLI wrapper toolkit now offers complete cross-platform testing capabilities with equivalent Bash and PowerShell test suites, ensuring robust validation across all supported platforms.
2025-08-28 18:56:28 +08:00
reynold
11f3b5bd86 Fix README to use two-character options consistently throughout
MAJOR CLEANUP: Fixed all inconsistencies in README documentation

Fixed sections:
- sf-deploy: -o,-s,-d,-t → -to,-sr,-dr,-ts
- sf-dry-run: Updated to match sf-deploy options
- sf-web-open: -o,-p,-U → -to,-pt,-ur
- sf-check: -v,-h → -vb,-hp
- sf-logs-tail: -o → -to
- All example command lines in workflows section
- Automatic Environment Verification examples
- Common Workflows examples

The README now consistently uses two-character options throughout:
 Help sections show proper option syntax (-to, -sr, -dr, etc.)
 All examples use the new two-character scheme
 Error message examples updated
 Workflow examples updated
 No more confusing mix of old/new option styles

Documentation is now fully aligned with the updated wrapper scripts.
2025-08-28 18:34:12 +08:00
reynold
3e24d62fb2 Remove outdated Windows PowerShell examples section from README
- Removed Windows PowerShell Examples section that contained old command patterns
- Replaced with concise Quick Start Examples using current two-character options
- All examples now reflect the modern command structure and syntax
- Maintains consistency with updated wrapper script functionality
2025-08-28 18:21:49 +08:00
reynold
628fe95b50 Implement innovative two-character option scheme
- Replace single-character options with memorable two-character alternatives
- Based on syllable mapping: -to (target-org), -qy (query), -fm (format), etc.
- Updated all bash and PowerShell scripts with consistent options
- Added comprehensive documentation and examples to README.md
- Maintains backward compatibility with long options
- More intuitive and self-documenting than traditional CLI options
2025-08-28 18:11:08 +08:00
reynold
d919e5cfb8 updated README 2025-08-28 16:42:15 +08:00
reynold
747aa90d26 added addl wrappers 2025-08-28 16:34:16 +08:00
reynold
a385484a69 updated scripts 2025-08-28 15:51:17 +08:00
reynold
0b2e2f619f first commit 2025-08-28 15:14:17 +08:00