Skip to content

Commit 410ee58

Browse files
committed
add link instructions
1 parent 46bfb2e commit 410ee58

File tree

3 files changed

+32
-63
lines changed

3 files changed

+32
-63
lines changed

files/docs/linkingcore.md

Lines changed: 0 additions & 60 deletions
This file was deleted.

package.json

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
"stryker": "npm i -g @stryker-mutator/core @stryker-mutator/jest-runner && stryker run"
2828
},
2929
"license": "MIT",
30-
"description": "A specialized engine designed for conducting static analysis on Salesforce automation tools, with capabilities to scan and evaluate Flows, Process Builders, and Workflows.",
30+
"description": "A purpose-built engine to assess and enhance Salesforce Flow automations.",
3131
"repository": {
3232
"type": "git",
3333
"url": "git+https://github.com/Flow-Scanner/lightning-flow-scanner-core.git"
@@ -68,5 +68,19 @@
6868
},
6969
"volta": {
7070
"node": "20.13.1"
71-
}
71+
},
72+
"keywords": [
73+
"salesforce",
74+
"flow",
75+
"linter",
76+
"static-analysis",
77+
"static-code-analysis",
78+
"flow-scanner",
79+
"flow-analysis",
80+
"flow-linter",
81+
"metadata-scanner",
82+
"security-scanner",
83+
"best-practices",
84+
"salesforce-flow"
85+
]
7286
}

readme.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -189,7 +189,7 @@ Specifying exceptions allows you to exclude specific scenarios from rule enforce
189189
> curl https://get.volta.sh | bash
190190
> ```
191191
>
192-
> Once installed, Volta will automatically use the Node.js version defined in `package.json`.
192+
> Volta will automatically use the Node.js version defined in `package.json`.
193193
194194
1. Clone the repo:
195195
@@ -215,4 +215,19 @@ Specifying exceptions allows you to exclude specific scenarios from rule enforce
215215
npm run test
216216
```
217217

218+
5. Test as local dependency:
219+
To test changes to the core module in the VS Code extension or SF CLI plugin locally, run:
220+
221+
```bash
222+
npm link
223+
```
224+
225+
b) Go to the dependent project (VSX or SF CLI) and use:
226+
227+
```bash
228+
npm link lightning-flow-scanner-core
229+
```
230+
231+
Your local core will now replace the installed dependency and update automatically on rebuild.
232+
218233
Want to help improve Lightning Flow Scanner? See our [Contributing Guidelines](https://github.com/Flow-Scanner/lightning-flow-scanner-core/blob/main/CONTRIBUTING.md).

0 commit comments

Comments
 (0)