desfent

SF plugin to generate documentation and code analysis

Installation

sf plugins install @entlog/desfent

Usage

If you want to create the documentation of a single file use:

sf desfent do doc -f <cls_file> -o <new_doc_folder>

If you want to analyze a full directory (and generate related documentation) use.

sf desfent do doc -d <folder> -o <new_doc_folder>

Troubleshoting

Wrong node version

If your attempt to install the plugin results in something like this:

Then you will have to upgrade your sf version. Check your version with:

% sf --version

This will show you the node version. At least a version 18 is required. In this example the version is v20:

% sf --version
@salesforce/cli/2.54.6 darwin-arm64 node-v20.16.0