Skip to content

Conversation

@williamsalexisSFDC
Copy link
Contributor

We find the need based off of multiple industries ranging from FinRa to FedRamp for the compliance category and security classification to be documented. Adding this to the output generated. Test class updated as well as the markdown example with an additional custom field and .md output.

@cesarParra
Copy link
Owner

Thanks @williamsalexisSFDC .

Changes look good but I'm thinking these need to go behind a flag since not everyone will want these to appear in their docs. I can assist with that if needed, lmk

@williamsalexisSFDC
Copy link
Contributor Author

williamsalexisSFDC commented Apr 21, 2025

Thanks @williamsalexisSFDC .

Changes look good but I'm thinking these need to go behind a flag since not everyone will want these to appear in their docs. I can assist with that if needed, lmk

@cesarParra if you could link me to file that has an example that would be great. I've looked over generate.ts, Apexdocs.ts, and source-code-file-reader.ts to try to backtrack where to start. I think I might have found what I am looking for in the types.d.ts file.

@cesarParra
Copy link
Owner

Thanks @williamsalexisSFDC .
Changes look good but I'm thinking these need to go behind a flag since not everyone will want these to appear in their docs. I can assist with that if needed, lmk

@cesarParra if you could link me to file that has an example that would be great. I've looked over generate.ts, Apexdocs.ts, and source-code-file-reader.ts to try to backtrack where to start. I think I might have found what I am looking for in the types.d.ts file.

All flags flow down through a config variable.

They can be added to the CLI here: https://github.com/cesarParra/apexdocs/blob/6ec783bcdb5d284f932f94d7f52009d2e93ff861/src/cli/commands/markdown.ts and to the type here:

export type CliConfigurableMarkdownConfig = {
, and that'll make them available in the generate-docs.ts file, which is what orchestrates everything.

They are already passed to the type-to-renderable.ts file, so in this PR they could be used to determine if the new parsed data should be displayed or not.

williamsalexisSFDC and others added 2 commits April 22, 2025 10:30
Use the includeFieldSecurityMetadata to cause the field output to show both the compliance category and security classification metadata if set to true.
Copy link
Owner

@cesarParra cesarParra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@cesarParra cesarParra merged commit fadda9a into cesarParra:master Apr 22, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants