Enhance salesforce converter UX - #286
Open
MonkeyCanCode wants to merge 3 commits into
Open
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The printed usage advertises a direction (toOSI) that the CLI does not accept, which will mislead users into an immediate error path.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR improves the Salesforce converter CLI user experience by adding basic, user-facing error/usage output and by correcting the README’s architecture ASCII diagram formatting.
Changes:
- Print a usage message when insufficient CLI arguments are provided.
- Print exception messages to stderr for
InvalidInputExceptionandConversionExceptionbefore exiting with the existing error codes. - Adjust the README architecture diagram layout.
File summaries
| File | Description |
|---|---|
| converters/salesforce/src/main/java/org/apache/ossie/app/OssieSalesforceConverter.java | Adds usage output and prints error messages for exceptions. |
| converters/salesforce/README.md | Tweaks the architecture ASCII diagram formatting. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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
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.
Summary
Related Issues
The current salesforce converter CLI only provide error codes (1-3) to end-user and not telling user what is wrong with the command. This PR addresses this gap by adding basic error message when exception got trigger.
Here is the current behavior:
Here is the new behavior:
This PR also fixes the broken ASCII arts for architecture diagram.
Checklist
Specification
core-spec/and follow the existing structureOntology
ontology/are consistent with spec changesConverters
converters/is updated to reflect spec or ontology changesValidation
validation/are updated if the spec changedDocumentation
docs/is updated to reflect any user-facing changesCONTRIBUTING.mdis updated if the contribution process changedExamples
examples/are added or updated for any new spec constructs or converter supportTests
pytest/ CI green)Compliance