Skip to content

Commit 786cbca

Browse files
authored
upgrade core to 5.9.0 (#9)
* restructuring repo * convert profile to permissionset * rm JSforce in favor of LFS_SR * update banner text * update development instructions in readme
1 parent 4bf476b commit 786cbca

21 files changed

+58
-2145
lines changed

README.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,56 @@
11
<p align="center">
22
<a href="https://github.com/Flow-Scanner">
3-
<img src="https://raw.githubusercontent.com/Flow-Scanner/lightning-flow-scanner-core/main/media/bannerslim.png" style="width: 55%;" />
3+
<img src="media/banner.png" style="width: 41%;" />
44
</a>
55
</p>
66
<p align="center">Scans for unsafe contexts, hardcoded IDs, and other issues to optimize your Flows.</p>
77

88
[![Demo](media/lfsapp.gif)](https://github.com/Lightning-Flow-Scanner)
99

10+
## Features
11+
12+
**Lightning Flow Scanner App** integrates the Lightning Flow Scanner as a UMD module within Salesforce, enabling scanning of flow metadata. The app runs predefined rules and presents detailed scan results for flows, including violation details, severity levels, and relevant flow metadata.
13+
1014
## Installation
1115

1216
<a href="https://githubsfdeploy.herokuapp.com?owner=Flow-Scanner&repo=lightning-flow-scanner-app&ref=main">
1317
<img alt="Deploy to Salesforce"
1418
src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png">
1519
</a>
1620

17-
## Using the Flow Scanner
18-
19-
1) Open the App Launcher:
20-
- Click on the App Launcher icon in the top-left corner of your Salesforce interface.
21-
- Search for "Flow Scanner" in the App Launcher search bar.
22-
- Click on the "Flow Scanner" app to open it.
21+
## Usage
2322

24-
2) Scan a Flow:
25-
- To scan a flow, click the "Scan" button next to the flow you want to analyze.
23+
1) Assign the `LFSApp` permission set, to any user that requires access to the flow scanning abilities.
24+
2) Open the App:
25+
- Click on the App Launcher icon in the top-left corner of your Salesforce interface.
26+
- Search for "Flow Scanner" in the App Launcher search bar.
27+
- Click on the "Flow Scanner" app to open it.
28+
3) To scan a flow, click the "Scan" button in the Flow Overview.
2629

2730
## Development
2831

29-
### Development Flow
30-
31-
1) Authorize Your Salesforce Org:
32-
Authorize your Salesforce org to set up a connection between your local development environment and the Salesforce org:
32+
1) Clone this repository:
3333

3434
```sh
35-
sfdx force:auth:web:login -d -a <YourOrgAlias>
35+
git clone https://github.com/Flow-Scanner/lightning-flow-scanner-app.git
3636
```
3737

38-
2) Install dependency
39-
40-
Install the Lightning Flow Scanner Component required for core functionality:
38+
2) Authorize your Salesforce org to set up a connection with your local development environment:
4139

4240
```sh
43-
sfdx force:package:install --package 04tDn0000011NpvIAE --wait 10 -u <YourOrgAlias>
41+
sf login web --set-default --alias <YourOrgAlias>
4442
```
4543

4644
3) Push Source to Your Org:
47-
Push the latest source to your og:
4845

4946
```sh
50-
sfdx force:source:push
47+
sf project:deploy:start
5148
```
5249

53-
3) Pull Source from Your Org:
50+
4) Pull Modifications from Your Org:
51+
5452
```sh
55-
sfdx force:source:pull
53+
sf project sync
5654
```
5755

58-
If you'd like to help us enhance Flow Scanner, please consider having a look at the [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).
56+
Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).

force-app/main/default/flexipages/Lightning_Flow_Scanner.flexipage-meta.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<flexiPageRegions>
44
<itemInstances>
55
<componentInstance>
6-
<componentName>lfs_component:lightningFlowScanner</componentName>
6+
<componentName>c:lightningFlowScanner</componentName>
77
</componentInstance>
88
</itemInstances>
99
<name>main</name>
Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,8 @@
6262
</table>
6363
</div>
6464
</template>
65-
6665
<div class="github-star">
67-
<p>Help us champion Best Practices in Flows by starring ⭐ us on <a href="https://github.com/Lightning-Flow-Scanner" target="_blank">GitHub</a> </p>
66+
<p>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md" target="_blank">Contributing Guidelines</a>.</p>
6867
</div>
69-
7068
</div>
7169
</template>

force-app/main/default/lwc/lightningFlowScannerApp/lightningFlowScannerApp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<c-flow-overview records={records} err={err} onscanflow={handleScanFlow}></c-flow-overview>
1414
</template>
1515
<template if:true={isTab2Active}>
16-
<lfs_component-lightning-flow-scanner name={flowName} metadata={flowMetadata}></lfs_component-lightning-flow-scanner>
16+
<c-lightning-flow-scanner name={flowName} metadata={flowMetadata}></c-lightning-flow-scanner>
1717
</template>
1818
</div>
1919
</main>

force-app/main/default/lwc/lightningFlowScannerApp/lightningFlowScannerApp.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { LightningElement, api, track } from 'lwc';
22
import { loadScript } from 'lightning/platformResourceLoader';
3-
import OrgCheckStaticRessource from "@salesforce/resourceUrl/OrgCheck_SR";
3+
import LFSStaticRessource from "@salesforce/resourceUrl/LFS_SR";
44

55
export default class lightningFlowScannerApp extends LightningElement {
66
@api accessToken;
@@ -31,7 +31,7 @@ export default class lightningFlowScannerApp extends LightningElement {
3131

3232
async connectedCallback() {
3333
try {
34-
await loadScript(this, OrgCheckStaticRessource + '/js/jsforce.js');
34+
await loadScript(this, LFSStaticRessource + '/js/jsforce.js');
3535
let SF_API_VERSION = '60.0';
3636
this.conn = new jsforce.Connection({
3737
accessToken: this.accessToken,
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<PermissionSet xmlns="http://soap.sforce.com/2006/04/metadata">
3+
<fullName>LFSApp</fullName>
4+
<label>LFSApp</label>
5+
<applicationVisibilities>
6+
<application>LFSApp</application>
7+
<visible>true</visible>
8+
</applicationVisibilities>
9+
10+
<pageAccesses>
11+
<apexPage>LFS_VF_Launcher</apexPage>
12+
<enabled>true</enabled>
13+
</pageAccesses>
14+
15+
<tabSettings>
16+
<tab>Lightning_Flow_Scanner</tab>
17+
<visibility>Visible</visibility>
18+
</tabSettings>
19+
</PermissionSet>

0 commit comments

Comments
 (0)