@terafina/tffa-sfdx-plugin

tffa-sfdx-plugin

tffa-sfdx-plugin is a SalesforceDX plugin from Terafina containing tools for scanning and extending digital applications for the financial services industry.

Setup

Before you get started, install the required software on your computer.

1. Install Java from OpenJDK Runtime Environment 18.9 (build 11.0.2+9) or via brew .Some features in Salesforce Extensions for VS Code depend upon the Java Platform.
2. Install sfdx-cli for osx using npm install -g sfdx-cli

For information about installing Salesforce CLI, see the Salesforce DX Setup Guide.

Install as a SalesforceDX Plugin

sfdx plugins:install @terafina/tffa-sfdx-plugin

You will be prompted to confirm that you want to install an unsigned plugin. Choose yes

This plugin is not digitally signed and its authenticity cannot be verified. Continue installation y/n?: y

To prevent this message from appearing, you can add this to the Allow List by adding an entry for it in $HOME/.config/sfdx/unsignedPluginAllowList.json.

CI Users: As the plugin is not signed, to install it from a Dockerfile or a script:

echo 'y' | sfdx plugins:install tffa-sfdx-plugin

Usage

$ npm install -g @terafina/tffa-sfdx-plugin $ sfdx COMMAND running command... $ sfdx (--version|-v) @terafina/tffa-sfdx-plugin/15.1.0 linux-x64 node-v18.14.0 $ sfdx --help [COMMAND] USAGE $ sfdx COMMAND ...

Commands

• sfdx help [COMMAND]
• sfdx tffa:apexdoc [-s <directory>] [-d <directory>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx tffa:lint [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx tffa:meta [-s <directory>] [-d <directory>] [-c <directory>] [-o json|csv|human] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx tffa:source:apiset [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
• sfdx version

sfdx help [COMMAND]

Display help for sfdx.

USAGE $ sfdx help [COMMAND] [-n] ARGUMENTS COMMAND Command to show help for. FLAGS -n, --nested-commands Include all nested commands in the output. DESCRIPTION Display help for sfdx.

See code: @oclif/plugin-help

sfdx tffa:apexdoc [-s <directory>] [-d <directory>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Generate Apex API Documentation

USAGE $ sfdx tffa:apexdoc [-s <directory>] [-d <directory>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] FLAGS -d, --destfolder=<value> directory to generate the api docs -s, --sourcefolder=<value> [default: .] directory containing sfdx project --json format output as json --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation DESCRIPTION Generate Apex API Documentation EXAMPLES Generate Apex API Documentation : $sfdx tffa:apexdoc

See code: src/commands/tffa/apexdoc.ts

sfdx tffa:lint [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

scan a sfdx project and provide a violations report based on defined standards

USAGE $ sfdx tffa:lint [-s <directory>] [-m <integer>] [-r <filepath>] [-e] [-f] [-j] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] FLAGS -e, --eject update local pmd ruleset -f, --level emit fatal violations only -j, --json generate json output -m, --minapi=<value> [default: 56] minimum api version to use during quality checks -r, --rulesetpath=<value> path to pmd ruleset -s, --sourcefolder=<value> [default: .] directory containing sfdx project --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation DESCRIPTION scan a sfdx project and provide a violations report based on defined standards EXAMPLES $sfdx tffa:lint

See code: src/commands/tffa/lint.ts

sfdx tffa:meta [-s <directory>] [-d <directory>] [-c <directory>] [-o json|csv|human] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

scan a sfdx project for metadata

USAGE $ sfdx tffa:meta [-s <directory>] [-d <directory>] [-c <directory>] [-o json|csv|human] [-f] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] FLAGS -c, --clientname=<value> [default: .] name of the client -d, --destpath=<value> [default: .] full path output file -f, --fields generate field output -o, --output=(json|csv|human) output format json csv human -s, --sourcefolder=<value> [default: .] directory containing sfdx project --json format output as json --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation DESCRIPTION scan a sfdx project for metadata EXAMPLES scan a sfdx project for metadata : $sfdx tffa:meta

See code: src/commands/tffa/meta.ts

sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

ping and test the plugin

USAGE $ sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] FLAGS --json format output as json --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation DESCRIPTION ping and test the plugin EXAMPLES $ sfdx tffa:ping

See code: src/commands/tffa/ping.ts

sfdx tffa:source:apiset [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

Upgrades the current project and all metadata to the latest API version

USAGE $ sfdx tffa:source:apiset [-h <help>] [-s <directory>] [-a <integer>] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL] FLAGS -a, --api=<value> [default: 56] specify the API version -h, --help Show CLI help. -s, --sourcefolder=<value> [default: .] directory containing sfdx project --json format output as json --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL) [default: warn] logging level for this command invocation DESCRIPTION Upgrades the current project and all metadata to the latest API version EXAMPLES $ sfdx tffa:source:apiset

See code: src/commands/tffa/source/apiset.ts

sfdx version

USAGE $ sfdx version [--json] [--verbose] FLAGS --verbose Show additional information about the CLI. GLOBAL FLAGS --json Format output as json. FLAG DESCRIPTIONS --verbose Show additional information about the CLI. Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version