This is a WIP SFDX wrapper for the WIP rumble CLI
Apex Rumble is an abstraction between Salesforce's object schema and your Apex code.
List the models you want in config/rumble.json, eg:
{
"models": ["Exception__c", "Occurrence__c", "Vote"]
}Run sfdx rumble:models:pull to bring pull down the schema description for the models you have listed. Then run sfdx rumble:models:build to generate your rumble models and get coding.
For more info on the rumble API, see the rumble docs
You must have Ruby installed. Install apex-rumble
Run npm install sfdx-rumble NB: As of this commit I actually haven't published anything on NPM so if you're an early bird you should clone the repo
Using this plugin is as simple as:
- Configuring via
config/rumble.json - Running rumble:pull, then rumble:build
- Deploying Learning the fairly straightforward apex code that is generated.
Proposed structure: (Not all features implemented)
{
"api_prefix": "Rumble", // Defaults
"model_prefix": "M", // Defaults
"models": [ // Objects to create models for
"Account",
"Contact",
"Lead",
"Opportunity",
{
"sobject": "Exception__c",
"model_name": "Error", // Should some reserved keyword issue occur, or for other reasons, you can map the object -> model name.
"field_whitelist": [
"Id",
"Name",
"UniqueName__c"
],
"field_mappings": {
"UniqueName__c": "veryUniqueName" // field name mappings can occur independently of the whitelist.
}
},
"Occurrence__c"
]
}Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apex_rumble. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
The gem is available as open source under the terms of the MIT License.