Skip to content

Commit 3ab4590

Browse files
authored
documentation patch (#11)
* implement volta and rm vscode-ext-gen * add security md * update rollup config * update lightning-flow-scanner-core
1 parent ff8d6d8 commit 3ab4590

File tree

5 files changed

+54
-41
lines changed

5 files changed

+54
-41
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,14 @@ Use our side bar or the **Command Palette** and type `Flow Scanner` to see the l
2828

2929
## Development
3030

31+
> This project optionally uses [Volta](https://volta.sh) to manage Node.js versions. Install Volta with:
32+
>
33+
> ```sh
34+
> curl https://get.volta.sh | bash
35+
> ```
36+
>
37+
> Volta will automatically use the Node.js version defined in `package.json`.
38+
3139
1. Clone the repo:
3240
3341
```bash

SECURITY.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Security Policy for Lightning Flow Scanner
2+
3+
## Security Practices
4+
5+
- Code is open-source and peer-reviewed by the community.
6+
- Vulnerabilities can be reported privately via GitHub security features.
7+
- Changes to the repository are scanned and reviewed before merging.
8+
9+
## Reporting a Vulnerability
10+
11+
If you discover a security vulnerability, please report it using [GitHub vulnerability reporting](https://github.com/Flow-Scanner/lightning-flow-scanner-vsx/security).
12+
13+
## Data Handling
14+
15+
This project collects zero user data. No credentials, PII, payment info, or health data is ever stored, transmitted, or shared. All analysis runs 100% client-side with no network calls to any external services.
16+
17+
## Dependencies
18+
19+
We actively track and maintain an up-to-date inventory of all third-party dependencies to ensure security and compatibility. Our dependencies include:
20+
21+
| Package | License | Purpose` |
22+
| ------------------------------- | ------------------------------------------------------------------------------------ | ---------------------------------------------- |
23+
| `convert-array-to-csv` | [MIT](https://github.com/zemirco/convert-array-to-csv/blob/master/LICENSE) | Converts JavaScript arrays into CSV format |
24+
| `lightning-flow-scanner-core` | [MIT](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/LICENSE.md) | Salesforce Flow scanning utilities |
25+
| `tabulator-tables` | [MIT](https://github.com/olifolkerd/tabulator/blob/master/LICENSE) | Interactive tables and data grids for web apps |
26+
| `uuid` | [MIT](https://github.com/uuidjs/uuid/blob/main/LICENSE.md) | Generates RFC-compliant UUIDs |
27+
| `xml2js` | [MIT](https://github.com/Leonidas-from-XIV/node-xml2js/blob/master/LICENSE) | XML-to-JavaScript object converter |
28+
| `yaml` | [ISC](https://github.com/eemeli/yaml/blob/main/LICENSE) | YAML parser and stringifier for JavaScript |

package-lock.json

Lines changed: 7 additions & 25 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
},
1010
"icon": "media/lightningflow.png",
1111
"description": "A VS Code Extension for analysis and optimization of Salesforce Flows. Scans metadata for 20+ issues such as hardcoded IDs, unsafe contexts, inefficient SOQL/DML operations, recursion risks, and missing fault handling. Supports auto-fixes, rule configurations, and tests integration.",
12-
"version": "1.8.2",
12+
"version": "1.8.3",
1313
"engines": {
1414
"vscode": "^1.99.1"
1515
},
@@ -90,10 +90,10 @@
9090
"scripts": {
9191
"vscode:prepublish": "npm run package",
9292
"compile": "webpack --config ./build/node-extension.webpack.config.js",
93-
"watch": "npm run v:update && concurrently \"rollup -c -w\" \"webpack --watch --config ./build/node-extension.webpack.config.js\"",
93+
"watch": "concurrently \"rollup -c -w\" \"webpack --watch --config ./build/node-extension.webpack.config.js\"",
9494
"build-webapp": "rollup -c",
95-
"build": "npm run v:update && rollup -c && vsce package",
96-
"build:beta": "npm run v:update && rollup -c && vsce package --pre-release",
95+
"build": "rollup -c && vsce package",
96+
"build:beta": "rollup -c && vsce package --pre-release",
9797
"package": "webpack --mode production --devtool hidden-source-map --config ./build/node-extension.webpack.config.js",
9898
"test-compile": "tsc -p ./",
9999
"test-watch": "tsc -watch -p ./",
@@ -105,15 +105,14 @@
105105
"________": "scripts for reactive-vscode",
106106
"v:dev": "run-p v:dev:*",
107107
"v:build:reactive": "tsup --env.NODE_ENV production --treeshake",
108-
"v:build:vite": "npm run v:update && vue-tsc --noEmit -p beta-vscode.tsconfig.json && vite build",
108+
"v:build:vite": "vue-tsc --noEmit -p beta-vscode.tsconfig.json && vite build",
109109
"v:dev:reactive": "tsup --watch ./src --env.NODE_ENV development",
110110
"v:dev:vite": "vite",
111111
"v:vite:preview": "vite preview",
112112
"v:typecheck:reactive": "tsc --noEmit -p reactive-vscode.tsconfig.json",
113113
"v:vscode:prepublish:reactive": "pnpm run build",
114114
"v:test:reactive": "jest",
115-
"v:test": "vitest",
116-
"v:update": "vscode-ext-gen --output src/generated/meta.ts"
115+
"v:test": "vitest"
117116
},
118117
"devDependencies": {
119118
"@rollup/plugin-commonjs": "^28.0.2",
@@ -166,7 +165,6 @@
166165
"vite": "^6.3.5",
167166
"vite-plugin-vue-devtools": "^7.7.6",
168167
"vitest": "^3.1.3",
169-
"vscode-ext-gen": "^1.0.2",
170168
"vue": "3.5.14",
171169
"vue-tsc": "2.2.10",
172170
"wdio-vscode-service": "^6.1.2",
@@ -175,7 +173,7 @@
175173
},
176174
"dependencies": {
177175
"convert-array-to-csv": "^2.0.0",
178-
"lightning-flow-scanner-core": "^5.9.4",
176+
"lightning-flow-scanner-core": "^5.9.7",
179177
"tabulator-tables": "^6.3.1",
180178
"uuid": "^11.0.5",
181179
"xml2js": "^0.6.2",
@@ -192,5 +190,8 @@
192190
"best practices",
193191
"code quality",
194192
"salesforce automation"
195-
]
193+
],
194+
"volta": {
195+
"node": "20.13.1"
196+
}
196197
}

rollup.config.mjs

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,6 @@ export default fs
3434
file: "out/compiled/" + name + ".js",
3535
assetFileNames: name + '.css',
3636
},
37-
onwarn: function (message) {
38-
if (message.code !== 'EVAL'){
39-
console.log(JSON.stringify(message));
40-
throw new Error(message);
41-
}
42-
},
4337
plugins: [
4438
svelte({
4539
compilerOptions: {

0 commit comments

Comments
 (0)