All Projects → shunkosa → sfdx-flowdoc-plugin

shunkosa / sfdx-flowdoc-plugin

Licence: other
A Salesforce CLI plugin that generates design document from Lightning Flow (currently Process Builder) metadata

Programming Languages

typescript
32286 projects

Projects that are alternatives of or similar to sfdx-flowdoc-plugin

sfpowerscripts
A build system for modular development in Salesforce, delivered as a sfdx plugin that can be implemented in any CI/CD system of choice
Stars: ✭ 121 (+116.07%)
Mutual labels:  salesforce, sfdx-cli, sfdx-plugin
DXB
A utility cli plugin built on top of #SFDX to facilitate devops.
Stars: ✭ 20 (-64.29%)
Mutual labels:  salesforce, sfdx-cli, sfdx-plugin
texei-sfdx-plugin
Texeï's plugin for sfdx
Stars: ✭ 99 (+76.79%)
Mutual labels:  salesforce, salesforcedx, sfdx-plugin
apex-tmLanguage
Salesforce Apex Language syntax grammar used for colorization
Stars: ✭ 27 (-51.79%)
Mutual labels:  salesforce, salesforcedx
Apex-Code-Conventions
Apex conventions and best practices for Salesforce Developers
Stars: ✭ 28 (-50%)
Mutual labels:  salesforce, salesforcedx
apex-dml-mocking
DML mocking, CRUD mocking, dependency injection framework for Salesforce.com (SFDC) using Apex
Stars: ✭ 38 (-32.14%)
Mutual labels:  salesforce, salesforcedx
apex-fp
Functional programming for Salesforce Apex
Stars: ✭ 231 (+312.5%)
Mutual labels:  salesforce, salesforcedx
DXMate
Sublime Text 3 plugin to provide integration with the Salesforce DX CLI
Stars: ✭ 14 (-75%)
Mutual labels:  salesforce, salesforcedx
sa11y
Salesforce Automated Accessibility Testing Libraries
Stars: ✭ 58 (+3.57%)
Mutual labels:  salesforce
basket
Mozilla's email newsletter subscription management API service
Stars: ✭ 12 (-78.57%)
Mutual labels:  salesforce
sfdx-git-packager
Generates a "delta" metadata package based on the difference between two git refs (branches/commits)
Stars: ✭ 93 (+66.07%)
Mutual labels:  salesforce
ApexCallouts
A lightweight Apex library for making HTTP callouts. Works with remote site settings and named credentials.
Stars: ✭ 32 (-42.86%)
Mutual labels:  salesforce
uswds-sf-lightning-community
A Salesforce Lightning Community Theme and related components built upon US Web Design System
Stars: ✭ 24 (-57.14%)
Mutual labels:  salesforce
dreaminvest-lwc
Sample application for Lightning Web Components on Salesforce Platform. Part of the sample gallery. Financial services use case. Get inspired and learn best practices.
Stars: ✭ 41 (-26.79%)
Mutual labels:  salesforce
spaghetti-cmd-loader
Salesforce Custom Metadata Type Loader, designed for Lightning Experience
Stars: ✭ 13 (-76.79%)
Mutual labels:  salesforce
timeline-component-lwc
This component enables timeline view for Salesforce Record history.
Stars: ✭ 18 (-67.86%)
Mutual labels:  salesforce
lwc-oss-oauth
Sample Code for connecting to Salesforce using OAuth Web Server flow from an LWC OSS App
Stars: ✭ 18 (-67.86%)
Mutual labels:  salesforce
FuelSDK-Node-REST
Node REST client w/ auth to access the Salesforce Marketing Cloud (formerly ExactTarget) API
Stars: ✭ 29 (-48.21%)
Mutual labels:  salesforce
aiosfstream
Salesforce Streaming API client for asyncio
Stars: ✭ 46 (-17.86%)
Mutual labels:  salesforce
R.apex
Functional utility library for Apex
Stars: ✭ 80 (+42.86%)
Mutual labels:  salesforce

Flowdoc (alpha)

A Salesforce CLI plugin that generates design document from Lightning Flow metadata. If you're not familiar with CLI, try the web app version.

Github Workflow Version Codecov Downloads/week License

Features

Supported Flow

  • Trigger based Process
  • Platform Event based Process
  • Invocable Process

Supported Actions

  • Chatter Post
  • Quick Action
  • Apex (Invocable Action)
  • Sub flow/process
  • Record Create
  • Record Update
  • Approval Process

Output Format

  • Word (.docx)
  • PDF
  • JSON

Setup

Install as plugin

sfdx plugins:install sfdx-flowdoc-plugin

Install from source

Clone this repo and run npm install. Then run,

sfdx plugins:link .

Usage

Specify an API name of your process

PDF output

sfdx flowdoc:pdf:generate Example_Process -o dest

Word output

sfdx flowdoc:docx:generate Example_Process -o dest

JSON output

sfdx flowdoc:json:generate Example_Process

You can also use the display command and redirect the output. Use --nospinner option if you don't need spinner while the command execution.

sfdx flowdoc:json:display Example_Process --nospinner > example_process.json

Locale

Add -l (--locale) ja option to export Japanese document.

sfdx flowdoc:pdf:generate Example_Process -l ja

Feedback

Feature requests, bug reports and pull requests are welcome!

Coming Soon

  • Flow Builder
  • Diagram
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].