@terafina/tffa-sfdx-plugin 0.1.0 → 1.0.1

package/README.md

@@ -1,78 +1,47 @@
 # tffa-sfdx-plugin
 
-sfdx plugin from Terafina containing tools for scanning and extending digital applications for the financial services industry.
-
-[![Version](https://img.shields.io/npm/v/tffa-sfdx-plugin.svg)](https://npmjs.org/package/@terafina/tffa-sfdx-plugin)
-
-<!-- toc -->
-* [tffa-sfdx-plugin](#tffa-sfdx-plugin)
-* [Debugging your plugin](#debugging-your-plugin)
-<!-- tocstop -->
-    <!-- install -->
-    <!-- usage -->
-```sh-session
-$ npm install -g @terafina/tffa-sfdx-plugin
-$ sfdx COMMAND
-running command...
-$ sfdx (-v|--version|version)
-@terafina/tffa-sfdx-plugin/0.1.0 darwin-x64 node-v14.15.2
-$ sfdx --help [COMMAND]
-USAGE
-  $ sfdx COMMAND
-...
-```
-<!-- usagestop -->
-<!-- commands -->
-* [`sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-tffaping---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)
+tffa-sfdx-plugin is a SalesforceDX plugin from Terafina containing tools for scanning and extending digital applications for the financial services industry.
 
-## `sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`
+[![Version](https://img.shields.io/npm/v/%40terafina/tffa-sfdx-plugin.svg)](https://www.npmjs.com/package/%40terafina/tffa-sfdx-plugin)
 
-ping
+## Setup
 
-```
-ping
-
-USAGE
-  $ sfdx tffa:ping [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]
+### **Install as a SalesforceDX Plugin**
 
-OPTIONS
-  --json                                                                            format output as json
+```
+sfdx plugins:install @terafina/tffa-sfdx-plugin
+```
 
-  --loglevel=(trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL)  [default: warn] logging level for
-                                                                                    this command invocation
+You will be prompted to confirm that you want to install an unsigned plugin. Choose yes
 
-EXAMPLE
-  $ sfdx tffa:ping
+```
+This plugin is not digitally signed and its authenticity cannot be verified. Continue installation y/n?: y
 ```
 
-_See code: [src/commands/tffa/ping.ts](https://github.com/terafina/tffa-sfdx-plugin/blob/v0.1.0/src/commands/tffa/ping.ts)_
-<!-- commandsstop -->
-<!-- debugging-your-plugin -->
-
-# Debugging your plugin
+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](https://developer.salesforce.com/blogs/2017/10/salesforce-dx-cli-plugin-update.html).
 
-We recommend using the Visual Studio Code (VS Code) IDE for your plugin development. Included in the `.vscode` directory of this plugin is a `launch.json` config file, which allows you to attach a debugger to the node process when running your commands.
+CI Users: As the plugin is not signed, to install it from a Dockerfile or a script:
 
-To debug the `hello:ping` command:
+```
+    echo 'y' | sfdx plugins:install tffa-sfdx-plugin
+```
 
-1. Start the inspector
+### **Commands**
 
-If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
+**`sfdx tffa:ping`**
+gets a pong response from plugin
 
-```sh-session
-$ sfdx hello:ping  --dev-suspend
 ```
 
-Alternatively, to call your command using the `bin/run` script, set the `NODE_OPTIONS` environment variable to `--inspect-brk` when starting the debugger:
+USAGE
+  $ sfdx tffa:ping
 
-```sh-session
-$ NODE_OPTIONS=--inspect-brk bin/run hello:ping
+
+EXAMPLE
+  $ sfdx tffa:ping
 ```
 
-2. Set some breakpoints in your command code
-3. Click on the Debug icon in the Activity Bar on the side of VS Code to open up the Debug view.
-4. In the upper left hand corner of VS Code, verify that the "Attach to Remote" launch configuration has been chosen.
-5. Hit the green play button to the left of the "Attach to Remote" launch configuration window. The debugger should now be suspended on the first line of the program.
-6. Hit the green play button at the top middle of VS Code (this play button will be to the right of the play button that you clicked in step #5).
-   <br><img src=".images/vscodeScreenshot.png" width="480" height="278"><br>
-   Congrats, you are debugging!
+sfdx tffa:apexdoc
+
+sfdx force:source:convert --outputdir mdapi-source/
+sfdx tffa:scan -s . -m mdapi-source -f json >> out.json

package/assets/highlight.css

@@ -0,0 +1,68 @@
+/*
+
+Visual Studio-like style based on original C# coloring by Jason Diamond <jason@diamond.name>
+
+*/
+.hljs {
+  display: block;
+  overflow-x: auto;
+  padding: 0.5em;
+  background: white;
+  color: black;
+}
+
+.hljs-comment,
+.hljs-quote,
+.hljs-variable {
+  color: #008000;
+}
+
+.hljs-keyword,
+.hljs-selector-tag,
+.hljs-built_in,
+.hljs-name,
+.hljs-tag {
+  color: #00f;
+}
+
+.hljs-string,
+.hljs-title,
+.hljs-section,
+.hljs-attribute,
+.hljs-literal,
+.hljs-template-tag,
+.hljs-template-variable,
+.hljs-type,
+.hljs-addition {
+  color: #a31515;
+}
+
+.hljs-deletion,
+.hljs-selector-attr,
+.hljs-selector-pseudo,
+.hljs-meta {
+  color: #2b91af;
+}
+
+.hljs-doctag {
+  color: #808080;
+}
+
+.hljs-attr {
+  color: #f00;
+}
+
+.hljs-symbol,
+.hljs-bullet,
+.hljs-link {
+  color: #00b0e8;
+}
+
+
+.hljs-emphasis {
+  font-style: italic;
+}
+
+.hljs-strong {
+  font-weight: bold;
+}