@flow-scanner/lightning-flow-scanner-core 6.6.1 → 6.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/CONTRIBUTING.md +2 -2
  2. package/README.md +35 -20
  3. package/SECURITY.md +10 -0
  4. package/package.json +1 -1
package/CONTRIBUTING.md CHANGED
@@ -2,7 +2,7 @@
2
2
 
3
3
  Since 20201, the _Lightning Flow Scanner_ has grown from its roots as VS Code tool to empower Salesforce Developers across six free and open-source platforms—from developer tools to native Salesforce App—delivering a unified experience for robust static analysis of Flows. Our dedicated community has shared their expertise to deepen understanding of Flow optimization. Your support can amplify our impact. Here’s how you can contribute to the [Flow Scanner](https://github.com/Flow-Scanner) project:
4
4
 
5
- - ⭐ Star your favorite repositories.
5
+ - ⭐ Star or follow the project.
6
6
  - 📢 Share our work with your network.
7
7
  - 💬 Share feedback to help us improve.
8
8
  - 💻 Contribute code by submitting pull requests.
@@ -24,7 +24,7 @@ If it's more specific like a bug or a new feature—use [GitHub Issues](https://
24
24
 
25
25
  - [CLI Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner/issues)
26
26
  - [Copado Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado/issues)
27
- - [GitHub Action](https://github.com/Flow-Scanner/lightning-flow-scanner-action/issues)
27
+ - [GitHub Action](https://github.com/Flow-Scanner/lightning-flow-scanner/issues)
28
28
  - [Salesforce App](https://github.com/Flow-Scanner/lightning-flow-scanner-app/issues)
29
29
  - [VS Code/Code Builder](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx/issues)
30
30
 
package/README.md CHANGED
@@ -29,14 +29,14 @@
29
29
 
30
30
  ## Distributions
31
31
 
32
- | Distribution | Best for | Repository | Install / Use |
33
- |-------------------------------------|-----------------------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------|
34
- | **Salesforce CLI Plugin** | Local development, scratch orgs, CI/CD | [Flow-Scanner/lightning-flow-scanner](https://github.com/Flow-Scanner/lightning-flow-scanner) | `sf plugins install lightning-flow-scanner` |
35
- | **VS Code Extension** | Real-time scanning inside VS Code | [Flow-Scanner/lightning-flow-scanner-vsx](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx) | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx` |
36
- | **Salesforce App** | Run scans directly inside any Salesforce org | [Flow-Scanner/lightning-flow-scanner-app](https://github.com/Flow-Scanner/lightning-flow-scanner-app) | <a href="https://login.salesforce.com/packaging/installPackage.apexp?p0=04tgK0000007M73QAE"><img alt="Install Managed Package" src="https://raw.githubusercontent.com/afawcett/githubsfdeploy/master/deploy.png"></a> |
37
- | **GitHub Action** | Native PR checks | [Flow-Scanner/lightning-flow-scanner-action](https://github.com/Flow-Scanner/lightning-flow-scanner-action) | [GitHub Marketplace](https://github.com/marketplace/actions/run-flow-scanner) |
38
- | **Copado Plugin** | Copado CI/CD pipelines | [Flow-Scanner/lightning-flow-scanner-copado](https://github.com/Flow-Scanner/lightning-flow-scanner-copado) | [Copado Marketplace](https://success.copado.com/s/listing-detail?language=en_US&recordId=a54P7000003G3gBIAS) |
39
- | **Core Library** (Node.js + Browser)| Custom tools, scripts, extensions, web apps | [Flow-Scanner/lightning-flow-scanner](https://github.com/Flow-Scanner/lightning-flow-scanner) | `npm install @flow-scanner/lightning-flow-scanner-core` |
32
+ | Distribution | Best for | Install / Use |
33
+ |----------------------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------------|
34
+ | **[Salesforce CLI Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/cli/README.md)** | Local development, scratch orgs, CI/CD | `sf plugins install lightning-flow-scanner` |
35
+ | **[VS Code Extension](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx)** | Real-time scanning inside VS Code | `code --install-extension ForceConfigControl.lightning-flow-scanner-vsx` |
36
+ | **[Salesforce App (Managed Package)](https://github.com/Flow-Scanner/lightning-flow-scanner-app)** | Run scans directly inside a Salesforce org | `sf package install --package 04tgK0000007M73QAE` |
37
+ | **[GitHub Action](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/packages/action/README.md)** | Native PR checks | [GitHub Marketplace](https://github.com/marketplace/actions/run-flow-scanner) |
38
+ | **[Copado Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado)** | Copado CI/CD pipelines | [Copado Marketplace](https://success.copado.com/s/listing-detail?language=en_US&recordId=a54P7000003G3gBIAS) |
39
+ | **[Core Library](https://github.com/Flow-Scanner/lightning-flow-scanner/tree/main/packages/core)** (Node.js + Browser) | Custom tools, scripts, extensions, web apps | `npm install @flow-scanner/lightning-flow-scanner-core` |
40
40
 
41
41
  **Privacy:** Zero user data collected. All processing is client-side. → See our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner?tab=security-ov-file).
42
42
 
@@ -317,7 +317,20 @@ Ready-to-use CI/CD templates and a **native GitHub Action**.
317
317
  | Azure DevOps | Full Project Scan | [`azure-pipelines-flow-FullScan.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/azure-devops/azure-pipelines-flow-FullScan.yml) |
318
318
  | Azure DevOps | Change-Based Scan | [`azure-pipelines-flow-changedFiles.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/azure-devops/azure-pipelines-flow-changedFiles.yml) |
319
319
  | Copado DevOps | Full & Change-Based Scans | [CI/CD Plugin](https://github.com/Flow-Scanner/lightning-flow-scanner-copado) |
320
- | GitHub | Full & Change-Based Scans | [`scan-flows.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/github-action/scan-flows.yml) |
320
+
321
+ GitHub Action Snippet:
322
+ ```yaml
323
+ - name: Lightning Flow Scan
324
+ id: flowscanner
325
+ uses: Flow-Scanner/lightning-flow-scanner@main
326
+
327
+ - name: Upload SARIF to Code Scanning
328
+ uses: github/codeql-action/upload-sarif@v3
329
+ with:
330
+ sarif_file: ${{ steps.flowscanner.outputs.sarifPath }}
331
+ ```
332
+
333
+ To see the full example, see [`scan-flows.yml`](https://github.com/Flow-Scanner/lightning-flow-scanner/blob/main/docs/examples/github-action/scan-flows.yml).
321
334
 
322
335
  ## Quick Start
323
336
 
@@ -348,14 +361,15 @@ parse("flows/*.xml").then(scan).then(exportSarif);
348
361
 
349
362
  > This project optionally uses [Volta](https://volta.sh) to guarantee the exact same Node.js and tool versions for every contributor. Install Volta with:
350
363
  >
364
+ > MacOs/Linux:
351
365
  > ```sh
352
366
  > curl https://get.volta.sh | bash
353
367
  > ```
354
- >
368
+ > Windows:
355
369
  > ```sh
356
370
  > winget install Volta.Volta
357
371
  > ```
358
- > Volta will automatically lock the exact versions of **Node.js**, **pnpm**, and all tools defined in `package.json`.
372
+ > Volta will automatically install and lock the tool versions defined in `package.json`.
359
373
 
360
374
  1. Clone the repository
361
375
 
@@ -386,10 +400,10 @@ parse("flows/*.xml").then(scan).then(exportSarif);
386
400
  pnpm test
387
401
  ```
388
402
 
389
- Or to test a new version of the core:
390
- ```bash
391
- pnpm test:core
392
- ```
403
+ Or to test a new version of the core:
404
+ ```bash
405
+ pnpm test:core
406
+ ```
393
407
 
394
408
  5. Linking the core module locally(Optional):
395
409
 
@@ -405,11 +419,11 @@ parse("flows/*.xml").then(scan).then(exportSarif);
405
419
  node -i -e "import('@flow-scanner/lightning-flow-scanner-core').then(m => { Object.assign(global, m.default ? m.default : m); console.log('✅ Core loaded! Try: await parse(...), scan(...), etc.'); })"
406
420
  ```
407
421
 
408
- Or test in a dependent project:
422
+ Or test in a dependent project:
409
423
 
410
- ```bash
411
- npm link @flow-scanner/lightning-flow-scanner-core
412
- ```
424
+ ```bash
425
+ npm link @flow-scanner/lightning-flow-scanner-core
426
+ ```
413
427
 
414
428
  6. Deploy Demo Flows (Optional):
415
429
 
@@ -422,7 +436,8 @@ parse("flows/*.xml").then(scan).then(exportSarif);
422
436
  7. Create a standalone UMD Module(Optional):
423
437
 
424
438
  ```bash
425
- pnpm dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
439
+ pnpm dist
426
440
  ```
441
+ This creates UMD at `dist/lightning-flow-scanner-core.umd.js`.
427
442
 
428
443
  <p><strong>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner?tab=contributing-ov-file">Contributing Guidelines</a></strong></p>
package/SECURITY.md CHANGED
@@ -35,3 +35,13 @@ We actively track and maintain an up-to-date inventory of all third-party depend
35
35
  | `cosmiconfig` | [MIT](https://github.com/davidtheclark/cosmiconfig/blob/main/LICENSE) | Config file loader for JavaScript/Node |
36
36
  | `glob` | [MIT](https://github.com/isaacs/node-glob/blob/master/LICENSE) | File pattern matching |
37
37
  | `lightning-flow-scanner-core` | [MIT](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/LICENSE.md) | Salesforce Flow scanning utilities |
38
+
39
+ ### Action
40
+
41
+ | Package | License | Purpose |
42
+ | ------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------- |
43
+ | `@actions/core` | [MIT](https://github.com/actions/toolkit/blob/main/packages/core/LICENSE) | Toolkit for developing GitHub Actions |
44
+ | `@actions/github` | [MIT](https://github.com/actions/toolkit/blob/main/packages/github/LICENSE) | Interact with the GitHub API in Actions |
45
+ | `@vercel/ncc` | [MIT](https://github.com/vercel/ncc/blob/main/LICENSE) | Compile Node.js projects into a single file |
46
+ | `lightning-flow-scanner-core` | [MIT](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/LICENSE.md) | Core library for scanning Salesforce flows |
47
+ | `cosmiconfig` | [MIT](https://github.com/davidtheclark/cosmiconfig/blob/main/LICENSE) | Config file loader for JavaScript/Node |
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@flow-scanner/lightning-flow-scanner-core",
3
3
  "description": "A lightweight engine for Flow metadata in Node.js, and browser environments. Assess and enhance Salesforce Flow automations for best practices, security, governor limits, and performance issues.",
4
- "version": "6.6.1",
4
+ "version": "6.6.2",
5
5
  "main": "index.js",
6
6
  "types": "index.d.ts",
7
7
  "exports": {