@flow-scanner/lightning-flow-scanner-core 6.2.1 → 6.3.1
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.
- package/CONTRIBUTING.md +3 -2
- package/README.md +8 -4
- package/SECURITY.md +2 -6
- package/package.json +10 -9
package/CONTRIBUTING.md
CHANGED
|
@@ -6,18 +6,19 @@ Since 2021, the _Lightning Flow Scanner_ has grown from its roots as VS Code too
|
|
|
6
6
|
- 📢 Sharing our work with your network
|
|
7
7
|
- 💬 Sharing feedback to help us improve
|
|
8
8
|
- 💻 Contributing code to drive innovation
|
|
9
|
+
- 🤝 [Become a member](https://register.lightningflowscanner.org/) to stay connected.
|
|
9
10
|
|
|
10
11
|
### I have a Question/Feedback
|
|
11
12
|
|
|
12
13
|
For general questions, ideas, or seeking input on topics that might (or might not) turn into issues, we recommend to use our [Discussions](https://github.com/orgs/Flow-Scanner/discussions) forum. This is best for open-ended conversations, brainstorming, and gathering community input before creating a feature request.
|
|
13
14
|
|
|
14
|
-
If it's more specific like a bug or a new feature—use [GitHub Issues](https://github.com/features/issues) instead. Before creating a new issue, please take a moment to search the existing [Issues](/issues) to prevent duplicates. If you find something relevant, adding an upvote helps us understand demand and prioritize better. We've prepared a few templates to guide you through the process of issue reporting:
|
|
15
|
+
If it's more specific like a bug or a new feature—use [GitHub Issues](https://github.com/features/issues) instead. Before creating a new issue, please take a moment to search the existing [Issues](https://github.com/Flow-Scanner/lightning-flow-scanner-core/issues) to prevent duplicates. If you find something relevant, adding an upvote helps us understand demand and prioritize better. We've prepared a few templates to guide you through the process of issue reporting:
|
|
15
16
|
|
|
16
17
|
###### Core Engine - For issues or requests related to the core functionality of the scanner, use the following links to submit your request:
|
|
17
18
|
|
|
18
19
|
- [Report Issue](https://github.com/Flow-Scanner/lightning-flow-scanner-core/issues/new?template=bug_report.md): Report a bug or issue.
|
|
19
20
|
- [Rule Request](https://github.com/Flow-Scanner/lightning-flow-scanner-core/issues/new?template=rule-request.md): Submit a request for a new rule.
|
|
20
|
-
- [Features/Other](https://github.com/Flow-Scanner/lightning-flow-scanner-core/issues/new): Suggest a new feature.
|
|
21
|
+
- [Features/Other](https://github.com/Flow-Scanner/lightning-flow-scanner-core/issues/new): Suggest a new feature or enhancement.
|
|
21
22
|
|
|
22
23
|
###### Platforms - For issues or requests related to specific platforms, use the appropriate link below:
|
|
23
24
|
|
package/README.md
CHANGED
|
@@ -259,6 +259,8 @@ const results = scan(
|
|
|
259
259
|
);
|
|
260
260
|
```
|
|
261
261
|
|
|
262
|
+
**Privacy:** Zero user data collected. All processing is client-side. → See our [Security Policy](https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=security-ov-file).
|
|
263
|
+
|
|
262
264
|
### Functions
|
|
263
265
|
|
|
264
266
|
#### [`getRules(ruleNames?: string[]): IRuleDefinition[]`](https://github.com/Flow-Scanner/lightning-flow-scanner-core/tree/main/src/main/libs/GetRuleDefinitions.ts)
|
|
@@ -289,9 +291,11 @@ _Get SARIF output including exact line numbers of violations._
|
|
|
289
291
|
|
|
290
292
|
## Installation
|
|
291
293
|
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
[](https://img.shields.io/github/stars/Flow-Scanner/lightning-flow-scanner-core)
|
|
295
|
+
[](https://gitHub.com/Flow-Scanner/lightning-flow-scanner-core/graphs/contributors/)
|
|
296
|
+
[](https://github.com/Flow-Scanner/lightning-flow-scanner-core/raw/main/LICENSE.md)
|
|
297
|
+
[](https://www.npmjs.com/package/lightning-flow-scanner)
|
|
298
|
+
[](https://snyk.io/test/github/Flow-Scanner/lightning-flow-scanner-core)
|
|
295
299
|
|
|
296
300
|
**To install with npm:**
|
|
297
301
|
|
|
@@ -356,4 +360,4 @@ npm install @flow-scanner/lightning-flow-scanner-core
|
|
|
356
360
|
npm run vite:dist // creates UMD at`dist/lightning-flow-scanner-core.umd.js`.
|
|
357
361
|
```
|
|
358
362
|
|
|
359
|
-
|
|
363
|
+
<p><strong>Want to help improve Lightning Flow Scanner? See our <a href="https://github.com/Flow-Scanner/lightning-flow-scanner-core?tab=contributing-ov-file">Contributing Guidelines</a></strong></p>
|
package/SECURITY.md
CHANGED
|
@@ -3,15 +3,11 @@
|
|
|
3
3
|
## Security Practices
|
|
4
4
|
|
|
5
5
|
- Code is open-source and peer-reviewed by the community.
|
|
6
|
-
- Vulnerabilities can be reported privately via [GitHub
|
|
7
|
-
- All changes are
|
|
6
|
+
- Vulnerabilities can be reported privately via [GitHub vulnerability reporting](https://github.com/Flow-Scanner/lightning-flow-scanner-core/security).
|
|
7
|
+
- All changes are scanned with [Snyk](https://github.com/snyk/cli) prior to publication.
|
|
8
8
|
- Releases are published to npm using **GitHub Actions Trusted Publishing (OIDC)**.
|
|
9
9
|
- Tags (`v*`) trigger automated `npm publish`, providing a full audit trail.
|
|
10
10
|
|
|
11
|
-
## Reporting a Vulnerability
|
|
12
|
-
|
|
13
|
-
If you discover a security vulnerability, please report it using [GitHub vulnerability reporting](https://github.com/Flow-Scanner/lightning-flow-scanner-core/security).
|
|
14
|
-
|
|
15
11
|
## Data Handling
|
|
16
12
|
|
|
17
13
|
This tool collects zero user data. No credentials, PII, payment info, health data, or user content is ever stored, transmitted, or shared. All analysis runs 100% client-side with no network calls to external services.
|
package/package.json
CHANGED
|
@@ -1,22 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@flow-scanner/lightning-flow-scanner-core",
|
|
3
|
-
"description": "A lightweight
|
|
4
|
-
"version": "6.
|
|
3
|
+
"description": "A lightweight and purpose-built 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.3.1",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
7
7
|
"engines": {
|
|
8
8
|
"node": "^18 || ^20 || ^22 || ^23"
|
|
9
9
|
},
|
|
10
10
|
"scripts": {
|
|
11
|
-
"clean": "
|
|
11
|
+
"clean": "rimraf out",
|
|
12
12
|
"build:js": "swc src --out-dir out --copy-files --strip-leading-paths --config-file .swcrc",
|
|
13
13
|
"build:types": "tsc -p tsconfig.types.json --declaration --emitDeclarationOnly --outDir out",
|
|
14
|
-
"copy:
|
|
15
|
-
"copy:
|
|
16
|
-
"copy:root-files:
|
|
17
|
-
"copy:root-files:dist": "cp LICENSE.md dist/ || true",
|
|
14
|
+
"copy:media": "node -e \"require('fs').cpSync('assets/media','out/assets/media',{recursive:true,force:true}) || require('fs').mkdirSync('out/assets/media',{recursive:true})\"",
|
|
15
|
+
"copy:root-files:out": "node -e \"['README.md','LICENSE.md','SECURITY.md','CONTRIBUTING.md','package.json'].forEach(f=>require('fs').copyFileSync(f,'out/'+f))\"",
|
|
16
|
+
"copy:root-files:dist": "node -e \"require('fs').copyFileSync('LICENSE.md','dist/LICENSE.md')\"",
|
|
18
17
|
"____main____": "__DEVELOPER COMMANDS__",
|
|
19
|
-
"build": "npm run clean && npm run build:js && npm run build:types && npm run copy:
|
|
18
|
+
"build": "npm run clean && npm run build:js && npm run build:types && npm run copy:media && npm run copy:root-files:out",
|
|
20
19
|
"test": "jest",
|
|
21
20
|
"lint": "eslint src tests",
|
|
22
21
|
"link": "npm run build && npm link ./out",
|
|
@@ -46,6 +45,7 @@
|
|
|
46
45
|
"@types/jest": "29.5.14",
|
|
47
46
|
"@types/node": "22.15.30",
|
|
48
47
|
"@types/semantic-release": "20.0.6",
|
|
48
|
+
"cross-env": "^10.1.0",
|
|
49
49
|
"eslint": "9.30.0",
|
|
50
50
|
"eslint-plugin-de-morgan": "1.3.0",
|
|
51
51
|
"eslint-plugin-github": "6.0.0",
|
|
@@ -56,6 +56,7 @@
|
|
|
56
56
|
"jest": "30.0.3",
|
|
57
57
|
"lint-staged": "^16.1.2",
|
|
58
58
|
"prettier": "3.6.2",
|
|
59
|
+
"rimraf": "^6.1.0",
|
|
59
60
|
"ts-node": "10.9.2",
|
|
60
61
|
"typescript": "5.8.3",
|
|
61
62
|
"typescript-eslint": "8.35.0",
|
|
@@ -63,7 +64,7 @@
|
|
|
63
64
|
"vite-plugin-node-polyfills": "0.23.0",
|
|
64
65
|
"vitest": "3.2.4"
|
|
65
66
|
},
|
|
66
|
-
"homepage": "https://
|
|
67
|
+
"homepage": "https://dev.lightningflowscanner.org",
|
|
67
68
|
"author": {
|
|
68
69
|
"name": "Ruben Halman",
|
|
69
70
|
"url": "https://github.com/RubenHalman"
|