Add support to parse picklist values #207
Conversation
RaviVaranasi
force-pushed
the
custom-field-pick-list-values
branch
from
f989eed to
cb2dccb
Compare
|
@cesarParra not sure if you have an integration test to verify but believe the changes are completed. Let me know |
@RaviVaranasi Yeah, the CI tests will run once I approve. |
package.json
Outdated
| { | ||
| "name": "@cparra/apexdocs", | ||
| "version": "3.4.2", | ||
| "version": "3.4.3", |
There was a problem hiding this comment.
I'll take care of the release so let's revert this. Since this Apexdocs is following semver the next one will be 3.5.0 as I consider this change to be an additional feature and not a bug fix.
| } | ||
|
|
||
| function isCustomField(customField: object): customField is CustomFieldMetadata { | ||
| return (customField as CustomFieldMetadata).type != undefined; |
There was a problem hiding this comment.
[minor] Let's use strict equality (e.g. ===, !==). Since we want to account for both null and undefined we can coerce into a boolean:
return !!(customField as CustomFieldMetadata).type;
| **Type** | ||
| *{{fieldType}}* | ||
| {{#each pickListValues}} |
There was a problem hiding this comment.
I'm thinking that instead of looping through the picklist values, we will want to make this its own section, and only render it if there are values to display (since not all fields will be picklists).
I like how Salesforce documentation does it, where they have the "Possible values are" as the heading
See my comment below in the src/core/renderables/types.d.ts file with the details about the changes that would need to be made to the type to accomplish this
RaviVaranasi
left a comment
RaviVaranasi
left a comment
There was a problem hiding this comment.
I'm wondering if this should be renamed to something like
hasType, since at this stage we already know we are dealing with custom field metadata because of the previous check (validate)
Agreed
RaviVaranasi
force-pushed
the
custom-field-pick-list-values
branch
from
abff594 to
1970145
Compare
|
@cesarParra Unsure of the last commit but should be ready for review again |
@RaviVaranasi No worries. I took the liberty of making that change. I tested the output and there was another change needed on the Handlebar template, since it was not respecting the correct heading. Here is the commit I made if you are curious: 2e58a93 The build is passing so I'll merge and let you know once I publish a new version to NPM |
cesarParra
left a comment
cesarParra
left a comment
There was a problem hiding this comment.
Looks great, thanks so much for contributing this improvement!
2 participants
When generating documentation for custom objects, include pick list values in documentation
TODO: