Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/berardo/dxflow

A Salesforce DX CLI (sfdx) plugin to manage git branching workflows. Use Gitflow, Oneflow, or any customised workflow and speeds things up with sfdx flow:* commands
https://github.com/berardo/dxflow

salesforce salesforcedx sfdx-cli sfdx-plugin typescript

Last synced: about 2 months ago
JSON representation

A Salesforce DX CLI (sfdx) plugin to manage git branching workflows. Use Gitflow, Oneflow, or any customised workflow and speeds things up with sfdx flow:* commands

Awesome Lists containing this project

README

        

DXFlow
======

Git Branching Workflow and deployment management with SFDX CLI

[![Version](https://img.shields.io/npm/v/DXFlow.svg)](https://npmjs.org/package/DXFlow)
[![CircleCI](https://circleci.com/gh/Especializa/DXFlow/tree/master.svg?style=shield)](https://circleci.com/gh/Especializa/DXFlow/tree/master)
[![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/Especializa/DXFlow?branch=master&svg=true)](https://ci.appveyor.com/project/heroku/DXFlow/branch/master)
[![Codecov](https://codecov.io/gh/Especializa/DXFlow/branch/master/graph/badge.svg)](https://codecov.io/gh/Especializa/DXFlow)
[![Greenkeeper](https://badges.greenkeeper.io/Especializa/DXFlow.svg)](https://greenkeeper.io/)
[![Known Vulnerabilities](https://snyk.io/test/github/Especializa/DXFlow/badge.svg)](https://snyk.io/test/github/Especializa/DXFlow)
[![Downloads/week](https://img.shields.io/npm/dw/DXFlow.svg)](https://npmjs.org/package/DXFlow)
[![License](https://img.shields.io/npm/l/DXFlow.svg)](https://github.com/Especializa/DXFlow/blob/master/package.json)

* [Debugging your plugin](#debugging-your-plugin)

```sh-session
$ npm install -g DXFlow
$ sfdx COMMAND
running command...
$ sfdx (-v|--version|version)
DXFlow/0.0.1 darwin-x64 node-v12.8.1
$ sfdx --help [COMMAND]
USAGE
$ sfdx COMMAND
...
```

* [`sfdx hello:org [-n ] [-f] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`](#sfdx-helloorg--n-string--f--v-string--u-string---apiversion-string---json---loglevel-tracedebuginfowarnerrorfataltracedebuginfowarnerrorfatal)

## `sfdx hello:org [-n ] [-f] [-v ] [-u ] [--apiversion ] [--json] [--loglevel trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]`

print a greeting and your org IDs

```
USAGE
$ sfdx hello:org [-n ] [-f] [-v ] [-u ] [--apiversion ] [--json] [--loglevel
trace|debug|info|warn|error|fatal|TRACE|DEBUG|INFO|WARN|ERROR|FATAL]

OPTIONS
-f, --force example boolean flag
-n, --name=name name to print

-u, --targetusername=targetusername username or alias for the target
org; overrides default target org

-v, --targetdevhubusername=targetdevhubusername username or alias for the dev hub
org; overrides default dev hub org

--apiversion=apiversion override the api version used for
api requests made by this command

--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

EXAMPLES
$ sfdx hello:org --targetusername [email protected] --targetdevhubusername [email protected]
Hello world! This is org: MyOrg and I will be around until Tue Mar 20 2018!
My hub org id is: 00Dxx000000001234

$ sfdx hello:org --name myname --targetusername [email protected]
Hello myname! This is org: MyOrg and I will be around until Tue Mar 20 2018!
```

# Debugging your plugin
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.

To debug the `hello:org` command:
1. Start the inspector

If you linked your plugin to the sfdx cli, call your command with the `dev-suspend` switch:
```sh-session
$ sfdx hello:org -u [email protected] --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:
```sh-session
$ NODE_OPTIONS=--inspect-brk bin/run hello:org -u [email protected]
```

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).



Congrats, you are debugging!