├── .circleci └── config.yml ├── .editorconfig ├── .eslintignore ├── .eslintrc.json ├── .github ├── dependabot.yml └── workflows │ ├── deploy-BETA.yml │ ├── deploy-RELEASE.yml │ ├── generate-RELEASE.yml │ └── test.yml ├── .gitignore ├── .idea ├── .gitignore ├── flowhealthcheck-cli.iml ├── inspectionProfiles │ └── Project_Default.xml ├── misc.xml ├── modules.xml └── vcs.xml ├── .mocharc.json ├── .vscode └── launch.json ├── .yarnrc.yml ├── CHANGELOG.md ├── LICENSE.md ├── README.md ├── appveyor.yml ├── bin ├── run └── run.cmd ├── docs └── images │ ├── banner.png │ ├── demo.png │ ├── flow-scan-example.jpg │ └── sfdxgif.gif ├── messages ├── command.json └── fix-command.json ├── package-lock.json ├── package.json ├── release.config.mjs ├── src ├── commands │ └── flow │ │ ├── fix.ts │ │ └── scan.ts ├── index.ts ├── libs │ ├── CoreFixService.ts │ ├── FindFlows.ts │ ├── FindIgnoreFile.ts │ └── ScannerConfig.ts └── models │ ├── ScanResult.ts │ └── Violation.ts ├── test ├── commands │ └── flow │ │ ├── fix.test.ts │ │ └── scan.test.ts └── tsconfig.json └── tsconfig.json /.circleci/config.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 2 3 | jobs: 4 | node-latest: &test 5 | docker: 6 | - image: node:latest 7 | working_directory: ~/cli 8 | steps: 9 | - checkout 10 | - restore_cache: &restore_cache 11 | keys: 12 | - v1-npm-{{checksum ".circleci/config.yml"}}-{{checksum "yarn.lock"}} 13 | - v1-npm-{{checksum ".circleci/config.yml"}} 14 | - run: 15 | name: Install dependencies 16 | command: yarn 17 | - run: 18 | name: Build plugin 19 | command: yarn prepack 20 | - run: 21 | name: Testing 22 | command: yarn test 23 | - run: 24 | name: Submitting code coverage to codecov 25 | command: | 26 | ./node_modules/.bin/nyc report --reporter text-lcov > coverage.lcov 27 | curl -s https://codecov.io/bash | bash 28 | node-8: 29 | <<: *test 30 | docker: 31 | - image: node:8 32 | node-10: 33 | <<: *test 34 | docker: 35 | - image: node:10 36 | cache: 37 | <<: *test 38 | steps: 39 | - checkout 40 | - run: 41 | name: Install dependencies 42 | command: yarn 43 | - save_cache: 44 | key: v1-npm-{{checksum ".circleci/config.yml"}}-{{checksum "yarn.lock"}} 45 | paths: 46 | - ~/cli/node_modules 47 | - /usr/local/share/.cache/yarn 48 | - /usr/local/share/.config/yarn 49 | 50 | workflows: 51 | version: 2 52 | "lightning-flow-scannner-cli": 53 | jobs: 54 | - node-latest 55 | - node-8 56 | - node-10 57 | - cache: 58 | filters: 59 | tags: 60 | only: /^v.*/ 61 | branches: 62 | ignore: /.*/ 63 | -------------------------------------------------------------------------------- /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = space 5 | indent_size = 2 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.md] 11 | trim_trailing_whitespace = false 12 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /nyc_output 2 | /bin 3 | /lib -------------------------------------------------------------------------------- /.eslintrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "root": true, 3 | "env": { 4 | "es6": true, 5 | "node": true 6 | }, 7 | "parser": "@typescript-eslint/parser", 8 | "plugins": ["@typescript-eslint"], 9 | "extends": [ 10 | "eslint:recommended", 11 | "plugin:@typescript-eslint/recommended", 12 | "prettier" 13 | ] 14 | } 15 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: 'npm' 4 | directory: '/' 5 | schedule: 6 | interval: 'monthly' 7 | day: 'monday' 8 | versioning-strategy: 'increase' 9 | pull-request-branch-name: 10 | separator: '-' 11 | commit-message: 12 | prefix: fix(deps) 13 | -------------------------------------------------------------------------------- /.github/workflows/deploy-BETA.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # 3 | # Documentation: 4 | # https://help.github.com/en/articles/workflow-syntax-for-github-actions 5 | # 6 | 7 | ####################################### 8 | # Start the job on all push to master # 9 | ####################################### 10 | name: "Build & Deploy - Beta" 11 | on: 12 | push: 13 | branches: 14 | - master 15 | 16 | permissions: read-all 17 | 18 | concurrency: 19 | group: ${{ github.ref_name }}-${{ github.workflow }} 20 | cancel-in-progress: true 21 | 22 | ############### 23 | # Set the Job # 24 | ############### 25 | jobs: 26 | # Deploy to NPM 27 | deploy_to_npm: 28 | name: Deploy to NPM (beta) 29 | runs-on: ubuntu-latest 30 | permissions: 31 | contents: write # to be able to publish a GitHub release 32 | issues: write # to be able to comment on released issues 33 | pull-requests: write # to be able to comment on released pull requests 34 | id-token: write 35 | environment: 36 | name: beta 37 | steps: 38 | - uses: actions/checkout@v4 39 | with: 40 | fetch-depth: 0 41 | persist-credentials: false 42 | - uses: actions/setup-node@v4.0.2 43 | with: 44 | node-version: 22.x 45 | registry-url: https://registry.npmjs.org 46 | scope: rubenhalman 47 | - name: Semantic Release Dependency 48 | run: npm install -g @semantic-release/changelog @semantic-release/commit-analyzer @semantic-release/git @semantic-release/npm conventional-changelog-conventionalcommits semantic-release 49 | - name: Install Dependencies 50 | run: npm ci 51 | - name: Publish Beta 52 | env: 53 | GITHUB_TOKEN: ${{ secrets.TOKENX }} 54 | NPM_TOKEN: ${{ secrets.NPM_TOKENX }} 55 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKENX }} 56 | run: semantic-release 57 | -------------------------------------------------------------------------------- /.github/workflows/deploy-RELEASE.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # 3 | # Documentation: 4 | # https://help.github.com/en/articles/workflow-syntax-for-github-actions 5 | # 6 | 7 | ####################################### 8 | # Start the job on all push to master # 9 | ####################################### 10 | name: "Build & Deploy - RELEASE" 11 | on: 12 | release: 13 | # Want to run the automation when a release is created 14 | types: ["created"] 15 | 16 | permissions: read-all 17 | 18 | concurrency: 19 | group: ${{ github.ref_name }}-${{ github.workflow }} 20 | cancel-in-progress: true 21 | 22 | ############### 23 | # Set the Job # 24 | ############### 25 | jobs: 26 | deploy: 27 | runs-on: ubuntu-latest 28 | permissions: read-all 29 | environment: 30 | name: release 31 | steps: 32 | - uses: actions/checkout@v4 33 | # Setup .npmrc file to publish to npm 34 | - uses: actions/setup-node@v4.0.2 35 | with: 36 | node-version: 22.x 37 | registry-url: "https://registry.npmjs.org" 38 | # Defaults to the user or organization that owns the workflow file 39 | scope: rubenhalman 40 | - run: npm clean-install 41 | - run: npm publish 42 | env: 43 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKENX }} 44 | -------------------------------------------------------------------------------- /.github/workflows/generate-RELEASE.yml: -------------------------------------------------------------------------------- 1 | --- 2 | # 3 | # Documentation: 4 | # https://help.github.com/en/articles/workflow-syntax-for-github-actions 5 | # 6 | 7 | ####################################### 8 | # Start the job on all push to master # 9 | ####################################### 10 | name: Generate a Release 11 | on: 12 | workflow_dispatch: 13 | 14 | ############### 15 | # Set the Job # 16 | ############### 17 | jobs: 18 | # Deploy to NPM 19 | deploy_to_npm: 20 | name: Generate a Release Version and Commit to Repo 21 | runs-on: ubuntu-latest 22 | permissions: 23 | contents: write 24 | steps: 25 | - uses: actions/checkout@v4 26 | with: 27 | token: ${{ secrets.PATX }} 28 | # Setup .npmrc file to publish to npm 29 | - uses: actions/setup-node@v4.0.2 30 | with: 31 | node-version: 22.x 32 | registry-url: https://registry.npmjs.org 33 | scope: rubenhalman 34 | - name: Generate New Release Number 35 | id: generate-release-number 36 | run: | 37 | npm install -g semver 38 | export OLD_VER=$(semver --coerce $(cat package.json | jq .version)) 39 | export NEW_VER=$(semver --coerce $(cat package.json | jq .version) --increment minor) 40 | echo "NEW_VER=$(echo $NEW_VER)" >> "$GITHUB_OUTPUT" 41 | - name: Install dependencies 42 | run: | 43 | export NEW_VER=${{ steps.generate-release-number.outputs.NEW_VER }} 44 | jq --arg NEW_VER "$NEW_VER" '.version = $NEW_VER' package.json > tmp.json 45 | rm package.json 46 | mv tmp.json package.json 47 | npm install 48 | git config --global user.name ${{ vars.USER_NAME }} 49 | git config --global user.email ${{ vars.USER_EMAIL }} 50 | git add . 51 | git commit -m "chore(release): ${{ steps.generate-release-number.outputs.NEW_VER }} [skip ci]" --no-verify 52 | git push origin master 53 | git tag v${{ steps.generate-release-number.outputs.NEW_VER }} 54 | git push --tags 55 | -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test 2 | 3 | on: [pull_request] 4 | 5 | permissions: read-all 6 | 7 | concurrency: 8 | group: ${{ github.ref_name }}-${{ github.workflow }} 9 | cancel-in-progress: true 10 | 11 | jobs: 12 | test: 13 | name: Test 14 | runs-on: ubuntu-latest 15 | timeout-minutes: 15 16 | steps: 17 | - name: Checkout Code 18 | uses: actions/checkout@v4 19 | - name: Install node 20 | uses: actions/setup-node@v4.0.2 21 | with: 22 | node-version: 20.x 23 | - name: Install dependencies 24 | run: npm ci 25 | - name: Run tests 26 | run: npm run test 27 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *-debug.log 2 | *-error.log 3 | .DS_Store 4 | /.nyc_output 5 | /dist 6 | /lib 7 | /node_modules 8 | /tmp 9 | node_modules 10 | .yarn/install-state 11 | .yarn/** 12 | coverage/** 13 | .yarn/install-state.gz 14 | oclif.manifest.json 15 | *.log 16 | *.tgz -------------------------------------------------------------------------------- /.idea/.gitignore: -------------------------------------------------------------------------------- 1 | # Default ignored files 2 | /workspace.xml -------------------------------------------------------------------------------- /.idea/flowhealthcheck-cli.iml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | -------------------------------------------------------------------------------- /.idea/inspectionProfiles/Project_Default.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 6 | -------------------------------------------------------------------------------- /.idea/misc.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | -------------------------------------------------------------------------------- /.idea/modules.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | -------------------------------------------------------------------------------- /.idea/vcs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /.mocharc.json: -------------------------------------------------------------------------------- 1 | { 2 | "require": ["ts-node/register"], 3 | "watch-extensions": "ts", 4 | "recursive": true, 5 | "reporter": "spec", 6 | "timeout": 600000, 7 | "node-option": ["loader=ts-node/esm"] 8 | } 9 | -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | // Use IntelliSense to learn about possible attributes. 3 | // Hover to view descriptions of existing attributes. 4 | // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 5 | "version": "0.2.0", 6 | "configurations": [ 7 | { 8 | "name": "Launch via NPM", 9 | "request": "launch", 10 | "runtimeArgs": [ 11 | "run", 12 | "test:unit" 13 | ], 14 | "runtimeExecutable": "npm", 15 | "skipFiles": [ 16 | "/**" 17 | ], 18 | "type": "node" 19 | }, 20 | { 21 | "type": "node", 22 | "request": "attach", 23 | "name": "Attach to Remote", 24 | "address": "127.0.0.1", 25 | "port": 9229, 26 | "localRoot": "${workspaceFolder}", 27 | "remoteRoot": "${workspaceFolder}", 28 | "skipFiles": ["/**"] 29 | }, 30 | { 31 | "name": "Run All Tests", 32 | "type": "node", 33 | "request": "launch", 34 | "protocol": "inspector", 35 | "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha", 36 | "args": ["--inspect", "--no-timeouts", "--colors", "test/**/*.test.ts"], 37 | "env": { 38 | "NODE_ENV": "development", 39 | "SFDX_ENV": "development" 40 | }, 41 | "sourceMaps": true, 42 | "smartStep": true, 43 | "internalConsoleOptions": "openOnSessionStart", 44 | "preLaunchTask": "npm: pretest:unit" 45 | }, 46 | { 47 | "type": "node", 48 | "request": "launch", 49 | "name": "Run Current Test", 50 | "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha", 51 | "args": ["--inspect", "--no-timeouts", "--colors", "${file}"], 52 | "env": { 53 | "NODE_ENV": "development", 54 | "SFDX_ENV": "development" 55 | }, 56 | "sourceMaps": true, 57 | "smartStep": true, 58 | "internalConsoleOptions": "openOnSessionStart", 59 | "preLaunchTask": "npm: pretest:unit" 60 | } 61 | ] 62 | } 63 | -------------------------------------------------------------------------------- /.yarnrc.yml: -------------------------------------------------------------------------------- 1 | nodeLinker: node-modules 2 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## [2.26.1](https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/compare/v2.26.0...v2.26.1) (2024-06-15) 2 | 3 | 4 | ### Bug Fixes 5 | 6 | * release configurations and extension on workflow ([6dc4dd2](https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/commit/6dc4dd204f42e32c0c70590a0d7fd9d7c42d49af)) 7 | 8 | # Changelog 9 | 10 | All notable changes to this project will be documented in this file. 11 | 12 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 13 | 14 | ## [Unreleased] (beta, main branch content) 15 | 16 | - Fix wrong exit code which has to be related to --failon option (default: `error`) 17 | - Display severity in human format results 18 | - Automate Releases via GitHub Actions 19 | - From `master` branch: **beta** 20 | - From `alpha` branch: **alpha** 21 | - When a GitHub release is created: Git tag selected for the release. 22 | - Run tests during Pull Request checks 23 | 24 | ## [2.12.0] 2023-08-29 25 | 26 | - Fix exit code that should be 1 according to --failon value [#71](https://github.com/Force-Config-Control/lightning-flow-scanner-sfdx/issues/71) 27 | 28 | ## [2.11.0] 2023-08 29 | 30 | Fixes: 31 | 32 | - [False positive 'FlowDescription' rule](https://github.com/Force-Config-Control/lightning-flow-scanner-core/issues/39) 33 | - [False positive 'MissingNullHandler' rule](https://github.com/Force-Config-Control/lightning-flow-scanner-core/issues/38) 34 | 35 | ## [2.9.0] 2023-08 36 | 37 | - Bugfix folder scan & human output: some bugs have been fixed in 2.9 regarding including node modules in the scope of the scan and also the issues in the human output 38 | 39 | ## [2.8.0] 2023-08 40 | 41 | New Rule: **Copy of API Name** 42 | 43 | Having multiple elements called Copy_X_Of_Element will decrease the readability of the Flow. If you copy and paste them, make sure to update the API name of the new copy. 44 | 45 | Configuration ID: CopyOf ([View source code](https://github.com/Force-Config-Control/lightning-flow-scanner-core/tree/master/src/main/rules/CopyOf.ts)) 46 | 47 | ## [2.5.0] 2023-07 48 | 49 | Introducing two new configurable rules! 50 | 51 | 1. Old API Version 52 | 2. Flow Naming Convention 53 | 54 | ### 1. Old API version 55 | 56 | Newer API components may cause older versions of Flows to start behaving incorrectly due to differences in the underlying mechanics. The Api Version has been available as an attribute on the Flow since API v50.0 and it is recommended to limit variation and to update them on a regular basis. 57 | 58 | Default Value: `>50.0` 59 | 60 | Configuration example: 61 | ``` 62 | APIVersion: 63 | { 64 | severity: 'error', 65 | expression: '===58' 66 | } 67 | ``` 68 | 69 | Configuration ID: `APIVersion` _([View source code](https://github.com/Force-Config-Control/lightning-flow-scanner-core/tree/master/src/main/rules/APIVersion.ts))_ 70 | 71 | ### 2. Flow naming conventions 72 | 73 | Readability of flow is very important. Agreeing on and following the same naming conventions will ease collaboration. 74 | 75 | Default Value: `[A-Za-z0-9]+_[A-Za-z0-9]+` 76 | 77 | Configuration example: 78 | ``` 79 | FlowName: 80 | { 81 | severity: 'error', 82 | expression: '[A-Za-z0-9]' 83 | } 84 | ``` 85 | 86 | Configuration ID: `FlowName` _([View source code](https://github.com/Force-Config-Control/lightning-flow-scanner-core/tree/master/src/main/rules/FlowName.ts))_ 87 | 88 | ## [2.3.0] - 2023-07 89 | 90 | - DuplicateDMLOperations now also returns false when the navigation of the screen after a DML has been hidden completely and not just the previous navigational button. 91 | 92 | ## [2.1.0] - 2023-07-16 93 | 94 | - Fix npm package generation (please do not use 2.0.0 but 2.1.0) 95 | - Upgrade lightning-flow-scanner-core dependency to 2.5.0 96 | - Markdown formatting 97 | - Add screenshot image at the head of the README 98 | - Fix rules table alignment 99 | - Add banner at the top of the README 100 | 101 | ## [2.0.0] - 2023-07-16 102 | 103 | - **BREAKING CHANGE**: `--throwerrors` argument is not available anymore and is replaced by `--failon`, that has more options 104 | - Update documentation in README 105 | - Update human-readable output format 106 | - Sort errors by flow 107 | - New argument **--failon** (error/warning/note): Makes return code 1 in case --failon severity is reached 108 | 109 | ## [1.1.0] - 2023-07-03 110 | 111 | - Use [cosmiconfig](https://github.com/cosmiconfig/cosmiconfig) to load configuration 112 | - Add a **--retrieve** argument in case user wants to retrieve flows from org before scanning 113 | - Add a testing GitHub action Workflow 114 | - Add CHANGELOG.md file 115 | - Code refactorization 116 | - let <=> const 117 | - Split main method into smaller methods 118 | - use fs-extra instead of sf plugin fs 119 | - Remove tslint (deprecated), replaced by eslint 120 | - Upgrade dependencies 121 | - Add VsCode local debugging configuration 122 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | 3 | Version 3, 19 November 2007 4 | 5 | Copyright © 2007 Free Software Foundation, Inc. 6 | Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 7 | Preamble 8 | 9 | The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. 10 | 11 | The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. 12 | 13 | When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. 14 | 15 | Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. 16 | 17 | A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. 18 | 19 | The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. 20 | 21 | An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. 22 | 23 | The precise terms and conditions for copying, distribution and modification follow. 24 | TERMS AND CONDITIONS 25 | 0. Definitions. 26 | 27 | "This License" refers to version 3 of the GNU Affero General Public License. 28 | 29 | "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. 30 | 31 | "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. 32 | 33 | To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. 34 | 35 | A "covered work" means either the unmodified Program or a work based on the Program. 36 | 37 | To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. 38 | 39 | To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. 40 | 41 | An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 42 | 1. Source Code. 43 | 44 | The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. 45 | 46 | A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. 47 | 48 | The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. 49 | 50 | The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work. 51 | 52 | The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. 53 | 54 | The Corresponding Source for a work in source code form is that same work. 55 | 2. Basic Permissions. 56 | 57 | All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. 58 | 59 | You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. 60 | 61 | Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 62 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 63 | 64 | No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. 65 | 66 | When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 67 | 4. Conveying Verbatim Copies. 68 | 69 | You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. 70 | 71 | You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 72 | 5. Conveying Modified Source Versions. 73 | 74 | You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: 75 | 76 | a) The work must carry prominent notices stating that you modified it, and giving a relevant date. 77 | b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". 78 | c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. 79 | d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. 80 | 81 | A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 82 | 6. Conveying Non-Source Forms. 83 | 84 | You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: 85 | 86 | a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. 87 | b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. 88 | c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. 89 | d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. 90 | e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. 91 | 92 | A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. 93 | 94 | A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. 95 | 96 | "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. 97 | 98 | If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). 99 | 100 | The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. 101 | 102 | Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 103 | 7. Additional Terms. 104 | 105 | "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. 106 | 107 | When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. 108 | 109 | Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: 110 | 111 | a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or 112 | b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or 113 | c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or 114 | d) Limiting the use for publicity purposes of names of licensors or authors of the material; or 115 | e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or 116 | f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. 117 | 118 | All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. 119 | 120 | If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. 121 | 122 | Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 123 | 8. Termination. 124 | 125 | You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). 126 | 127 | However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. 128 | 129 | Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. 130 | 131 | Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 132 | 9. Acceptance Not Required for Having Copies. 133 | 134 | You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 135 | 10. Automatic Licensing of Downstream Recipients. 136 | 137 | Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. 138 | 139 | An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. 140 | 141 | You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 142 | 11. Patents. 143 | 144 | A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". 145 | 146 | A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. 147 | 148 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. 149 | 150 | In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. 151 | 152 | If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. 153 | 154 | If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. 155 | 156 | A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. 157 | 158 | Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 159 | 12. No Surrender of Others' Freedom. 160 | 161 | If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 162 | 13. Remote Network Interaction; Use with the GNU General Public License. 163 | 164 | Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. 165 | 166 | Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. 167 | 14. Revised Versions of this License. 168 | 169 | The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. 170 | 171 | Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. 172 | 173 | If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. 174 | 175 | Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 176 | 15. Disclaimer of Warranty. 177 | 178 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 179 | 16. Limitation of Liability. 180 | 181 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 182 | 17. Interpretation of Sections 15 and 16. 183 | 184 | If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 185 | 186 | END OF TERMS AND CONDITIONS 187 | How to Apply These Terms to Your New Programs 188 | 189 | If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. 190 | 191 | To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. 192 | 193 | 194 | Copyright (C) 195 | 196 | This program is free software: you can redistribute it and/or modify 197 | it under the terms of the GNU Affero General Public License as 198 | published by the Free Software Foundation, either version 3 of the 199 | License, or (at your option) any later version. 200 | 201 | This program is distributed in the hope that it will be useful, 202 | but WITHOUT ANY WARRANTY; without even the implied warranty of 203 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 204 | GNU Affero General Public License for more details. 205 | 206 | You should have received a copy of the GNU Affero General Public License 207 | along with this program. If not, see . 208 | 209 | Also add information on how to contact you by electronic and paper mail. 210 | 211 | If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. 212 | 213 | You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . 214 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Lightning Flow Scanner Banner](docs/images/banner.png)](https://github.com/Lightning-Flow-Scanner) 2 | __*Pinpoint deviations from Industry Best Practices in Salesforce Flows, ensuring standards of business automation excellence*__ 3 | 4 | ![FlowScan example](docs/images/sfdxgif.gif) 5 | 6 | **Also available as [VS Code Extension](https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-vsce)* 7 | 8 | ## Table of contents 9 | 10 | - [Installation](#installation) 11 | - [Usage](#usage) 12 | - [Options](#options) 13 | - [Examples](#examples) 14 | - [Configuration](#configuration) 15 | - [Defining the severity per rule](#defining-the-severity-per-rule) 16 | - [Specifying an exception](#specifying-an-exception) 17 | - [Configuring an expression](#configuring-an-expression) 18 | - [Loading Custom Rules](#loading-custom-rules) 19 | - [Development Setup](#development-setup) 20 | 21 | ## Installation 22 | 23 | Install with SFDX: 24 | 25 | ```sh-session 26 | sfdx plugins:install lightning-flow-scanner 27 | ``` 28 | 29 | Install with NPM: 30 | 31 | ```sh-session 32 | npm install -g lightning-flow-scanner 33 | ``` 34 | 35 | ## Usage 36 | 37 | ```sh-session 38 | sfdx flow:scan [options] 39 | ``` 40 | 41 | ***To learn more about the default rules and options, see the [core documentation](https://lightning-flow-scanner.github.io/lightning-flow-scanner-core/).*** 42 | 43 | ### Options 44 | 45 | ```sh-session 46 | -c, --config provide a path to the configuration file. 47 | 48 | -f, --failon provide a threshold level for returning status 1 49 | 50 | -p, --files provide a space-separated list of flow paths to scan. 51 | 52 | -u, --targetusername retrieve the latest metadata from the target before the scan. 53 | 54 | -d, --directory provide a directory to scan. 55 | 56 | --json set output format as json. 57 | 58 | --loglevel=(trace|debug|info|warn|error|fatal) [default: warn] logging level. 59 | ``` 60 | ### Examples 61 | 62 | You can test the scanner by simply opening an existing project that contains flows and running the scan without any configurations or parameters. This way all the default rules are autmatically included in the scan. 63 | 64 | ```sh-sessions 65 | sfdx flow:scan 66 | ``` 67 | 68 | ```sh-sessions 69 | sfdx flow:scan --json 70 | ``` 71 | 72 | ```sh-sessions 73 | sfdx flow:scan --config path/to/.flow-scanner.json 74 | ``` 75 | 76 | ## Configuration 77 | 78 | Create a .flow-scanner.json file in order to configure: 79 | - The ruleset to be executed. 80 | - The severity of violating any specific rule. 81 | - Custom expressions or rule implementations. 82 | - Any known exceptions that should be ignored during scanning. 83 | 84 | ```json 85 | { 86 | "rules": { 87 | ... 88 | }, 89 | "exceptions": { 90 | ... 91 | } 92 | } 93 | ``` 94 | 95 | _Note: if you prefer YAML format, you can create a `.flow-scanner.yml` file using the same format._ 96 | 97 | ### Defining the severity per rule 98 | 99 | When the severity is not provided it will be `error` by default. Other available values for severity are `warning` and `note`. Define the severity per rule as shown in the following example. 100 | 101 | ```json 102 | { 103 | "rules": { 104 | "FlowDescription": { 105 | "severity": "warning" 106 | }, 107 | "UnusedVariable": { 108 | "severity": "error" 109 | } 110 | } 111 | } 112 | ``` 113 | ### Specifying an exception 114 | 115 | Specifying exceptions can be done by flow, rule and result(s), as shown in the following example. 116 | 117 | ```json 118 | { 119 | "exceptions": { 120 | "AssignTaskOwner": { 121 | "UnusedVariable": [ 122 | "somecount" 123 | ] 124 | }, 125 | "GetAccounts":{ 126 | "UnusedVariable": [ 127 | "incvar" 128 | ] 129 | } 130 | } 131 | } 132 | ``` 133 | ### Configuring an expression 134 | 135 | Some rules have additional attributes to configure, such as the expression, that will overwrite default values. These can be configured in the same way as severity as shown in the following example. 136 | 137 | ```json 138 | { 139 | "rules": { 140 | "APIVersion": 141 | { 142 | "severity": "error", 143 | "expression": "===58" 144 | }, 145 | "FlowName": 146 | { 147 | "severity": "error", 148 | "expression": "[A-Za-z0-9]" 149 | } 150 | } 151 | } 152 | ``` 153 | 154 | ### Loading Custom Rules 155 | 156 | To load custom rules using the Lightning Flow Scanner Core, you can utilize the `path` attribute within the rules section of your configurations. This attribute allows you to specify the path to your custom rule class, enabling seamless integration of organization-specific rule definitions into the scanner's ruleset. 157 | 158 | ```json 159 | { 160 | "rules": { 161 | "": { 162 | "path": "" 163 | } 164 | } 165 | } 166 | ``` 167 | Custom Rules can either leverage our Flow compiler or be completely customized typescript functions. 168 | For more details and examples on custom rules, refer to our [Custom Rule Creation Guide](https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-core/tree/master/docs/customruleguide.md) 169 | 170 | ## Development Setup 171 | 172 | ### Preparing for Changes 173 | 174 | 1. **Clone Project**: Clone the Lightning Flow Scanner SFDX plugin project from the repository. 175 | 2. **Install Dependencies**: Open the directory and run `npm install` or `yarn install` in the terminal to install the necessary dependencies. 176 | 3. **Optional: Make changes**: For example, if you want to upgrade the core module using npm, you can use the command: `npm update lightning-flow-scanner-core` 177 | 4. **Prepack**: Execute `npm run prepack` to build the plugin locally and prepare for packaging. 178 | 5. **Link Plugin**: Link the plugin to your Salesforce DX environment using `sfdx plugins link .`. 179 | 180 | ### Debugging the Plugin 181 | 182 | 1. **Linking Core Module**: You may need to clone and link the `lightning-flow-scanner-core` locally to your project. This step is necessary if you're making changes to the core module and want those changes reflected in the plugin. You can link the core module by navigating to its directory and running: 183 | 184 | ```bash 185 | npm link 186 | ``` 187 | 188 | Then, navigate to the sfdx plugin directory and run: 189 | 190 | ```bash 191 | npm link lightning-flow-scanner-core 192 | ``` 193 | 194 | 1. **Run Plugin**: In the terminal of your example flow project (or any other project intended for scanning), run the following command to start the plugin with debugging enabled: 195 | 196 | ```bash 197 | NODE_OPTIONS=--inspect-brk /path/to/lightning-flow-scanner-sfdx/bin/run flow:scan 198 | ``` 199 | 200 | 2. **Attach Debugger**: Open your local Salesforce DX project in Visual Studio Code, set desired breakpoints, and attach the debugger to the remote session. 201 | 202 | For more detailed information, you can refer to the [wiki](https://github.com/salesforcecli/cli/wiki) of the Salesforce CLI repository. 203 | -------------------------------------------------------------------------------- /appveyor.yml: -------------------------------------------------------------------------------- 1 | environment: 2 | nodejs_version: "10" 3 | cache: 4 | - '%LOCALAPPDATA%\Yarn -> appveyor.yml' 5 | - node_modules -> yarn.lock 6 | 7 | install: 8 | - ps: Install-Product node $env:nodejs_version x64 9 | - yarn 10 | 11 | build: off 12 | 13 | build_script: 14 | - ps: Write-Host “Prepack plugin” 15 | - yarn prepack 16 | 17 | test_script: 18 | - yarn test 19 | 20 | after_test: 21 | - .\node_modules\.bin\nyc report --reporter text-lcov > coverage.lcov 22 | - ps: | 23 | $env:PATH = 'C:\msys64\usr\bin;' + $env:PATH 24 | Invoke-WebRequest -Uri 'https://codecov.io/bash' -OutFile codecov.sh 25 | bash codecov.sh 26 | 27 | -------------------------------------------------------------------------------- /bin/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | // eslint-disable-next-line node/shebang 4 | async function main() { 5 | const { execute } = await import('@oclif/core'); 6 | await execute({ dir: import.meta.url }); 7 | } 8 | 9 | await main(); 10 | -------------------------------------------------------------------------------- /bin/run.cmd: -------------------------------------------------------------------------------- 1 | @echo off 2 | 3 | node "%~dp0\run" %* 4 | -------------------------------------------------------------------------------- /docs/images/banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/da689607362a577e5c4953446a4c27b260e68545/docs/images/banner.png -------------------------------------------------------------------------------- /docs/images/demo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/da689607362a577e5c4953446a4c27b260e68545/docs/images/demo.png -------------------------------------------------------------------------------- /docs/images/flow-scan-example.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/da689607362a577e5c4953446a4c27b260e68545/docs/images/flow-scan-example.jpg -------------------------------------------------------------------------------- /docs/images/sfdxgif.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/da689607362a577e5c4953446a4c27b260e68545/docs/images/sfdxgif.gif -------------------------------------------------------------------------------- /messages/command.json: -------------------------------------------------------------------------------- 1 | { 2 | "commandDescription": "Find and fix potential bugs in Salesforce flows.", 3 | "errorRetrievingMetadata": "An error occurred during metadata retrieval. Please check the connection.", 4 | "errorNoOrgResults": "No results found for the org '%s'.", 5 | "throwErrors": "Errors will be thrown in case a violation is identified", 6 | "directoryToScan": "Directory to scan for flows" 7 | } 8 | -------------------------------------------------------------------------------- /messages/fix-command.json: -------------------------------------------------------------------------------- 1 | { 2 | "commandDescription":"Fix common problems using lfs core engine. Rule definitions that specifies autoFixable can be executed and fixes may be applied automatically", 3 | "flagsDirsDescription":"Specify one or more Directorie(s) to find flows and fix", 4 | "flagsRulesDescription": "Specify one or more Rule Id(s) to run", 5 | "flagsFilesDescription": "Specify one or more flow File(s) to run", 6 | "errorMutuallyExclusiveRequired": "Specify a directory or a file but not both" 7 | } -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "lightning-flow-scanner", 3 | "version": "3.17.0", 4 | "bugs": "https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/issues", 5 | "dependencies": { 6 | "@oclif/core": "^4.3.0", 7 | "@salesforce/core": "^8.11.4", 8 | "@salesforce/sf-plugins-core": "^12.2.2", 9 | "chalk": "^5.4.1", 10 | "cosmiconfig": "^9.0.0", 11 | "fs-extra": "^11.3.0", 12 | "glob": "^11.0.2", 13 | "lightning-flow-scanner-core": "4.38.0" 14 | }, 15 | "devDependencies": { 16 | "@oclif/plugin-help": "6.2.28", 17 | "@oclif/test": "4.1.13", 18 | "@salesforce/dev-config": "4.3.1", 19 | "@salesforce/ts-sinon": "1.4.30", 20 | "@sinonjs/fake-timers": "14.0.0", 21 | "@types/chai": "5.2.2", 22 | "@types/jsforce": "1.11.5", 23 | "@types/mocha": "10.0.10", 24 | "@types/node": "22.15.29", 25 | "@types/sinon": "17.0.4", 26 | "@types/sinonjs__fake-timers": "8.1.5", 27 | "@typescript-eslint/eslint-plugin": "8.33.0", 28 | "@typescript-eslint/parser": "8.33.0", 29 | "chai": "5.2.0", 30 | "eslint": "9.28.0", 31 | "eslint-config-prettier": "10.1.5", 32 | "globby": "14.1.0", 33 | "mocha": "11.5.0", 34 | "nyc": "17.1.0", 35 | "oclif": "4.17.46", 36 | "prettier": "3.5.3", 37 | "sinon": "20.0.0", 38 | "ts-node": "10.9.2", 39 | "typescript": "5.8.3" 40 | }, 41 | "engines": { 42 | "node": ">=14.0.0" 43 | }, 44 | "files": [ 45 | "/lib", 46 | "/messages", 47 | "/npm-shrinkwrap.json", 48 | "/oclif.manifest.json" 49 | ], 50 | "homepage": "https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx/", 51 | "keywords": [ 52 | "sfdx-plugin" 53 | ], 54 | "license": "AGPL-3.0", 55 | "oclif": { 56 | "commands": "./lib/src/commands", 57 | "bin": "sf", 58 | "topics": { 59 | "flow": { 60 | "description": "Commands to find and fix potential bugs in Salesforce Flows." 61 | } 62 | }, 63 | "devPlugins": [ 64 | "@oclif/plugin-help" 65 | ] 66 | }, 67 | "repository": "https://github.com/Lightning-Flow-Scanner/lightning-flow-scanner-sfdx.git", 68 | "scripts": { 69 | "lint": "eslint", 70 | "postpack": "rm -f oclif.manifest.json", 71 | "prepack": "rm -rf lib && tsc -b && oclif manifest && oclif readme", 72 | "prettier": "prettier --write '**/*.{js,json,md,ts,yaml,yml}'", 73 | "test": "nyc --include src npm run test:unit", 74 | "pretest": "npm run prepack", 75 | "test:unit": "mocha -r ts-node/register test/**/*.test.ts", 76 | "version": "oclif readme && git add README.md", 77 | "lfs:link": "npm link lightning-flow-scanner-core && npm pack && sf plugins link" 78 | }, 79 | "type": "module" 80 | } 81 | -------------------------------------------------------------------------------- /release.config.mjs: -------------------------------------------------------------------------------- 1 | /** 2 | * @type {import('semantic-release').GlobalConfig} 3 | */ 4 | export default { 5 | branches: [ 6 | { 7 | name: "master", 8 | channel: "beta", 9 | }, 10 | ], 11 | plugins: [ 12 | [ 13 | "@semantic-release/commit-analyzer", 14 | { 15 | preset: "conventionalcommits", 16 | releaseRules: [ 17 | { type: "fix", release: "patch" }, 18 | { type: "feat", release: "patch" }, 19 | { type: "build", release: "patch" }, 20 | { type: "chore", release: "patch" }, 21 | { type: "docs", release: "patch" }, 22 | { type: "style", release: "patch" }, 23 | { type: "refactor", release: "patch" }, 24 | { type: "perf", release: "patch" }, 25 | { type: "test", release: "patch" }, 26 | ], 27 | }, 28 | ], 29 | ["@semantic-release/npm", { tarballDir: "dist" }], 30 | [ 31 | "@semantic-release/git", 32 | { 33 | assets: ["package.json", "package-lock.json", "CHANGELOG.md"], 34 | message: 35 | "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}", 36 | }, 37 | ], 38 | ], 39 | }; 40 | -------------------------------------------------------------------------------- /src/commands/flow/fix.ts: -------------------------------------------------------------------------------- 1 | import { SfCommand, Flags } from "@salesforce/sf-plugins-core"; 2 | import { Messages, SfError } from "@salesforce/core"; 3 | 4 | import { ScanResult } from "../../models/ScanResult.js"; 5 | import CoreFixService from "../../libs/CoreFixService.js"; 6 | 7 | Messages.importMessagesDirectoryFromMetaUrl(import.meta.url, true); 8 | 9 | const commandMessages = Messages.loadMessages( 10 | "lightning-flow-scanner", 11 | "fix-command", 12 | ); 13 | 14 | export default class FlowFix extends SfCommand { 15 | static override description = 16 | commandMessages.getMessage("commandDescription"); 17 | 18 | static override examples = ["<%= config.bin %> <%= command.id %>"]; 19 | 20 | public static override flags = { 21 | rules: Flags.string({ 22 | multiple: true, 23 | char: "r", 24 | description: commandMessages.getMessage("flagsRulesDescription"), 25 | required: true, 26 | }), 27 | dir: Flags.string({ 28 | char: "d", 29 | multiple: true, 30 | description: commandMessages.getMessage("flagsDirsDescription"), 31 | exclusive: ["files"], 32 | }), 33 | files: Flags.file({ 34 | exists: true, 35 | multiple: true, 36 | description: commandMessages.getMessage("flagsFilesDescription"), 37 | char: "f", 38 | charAliases: ["p"], 39 | }), 40 | }; 41 | 42 | public async run(): Promise { 43 | const { flags } = await this.parse(FlowFix); 44 | const { dir, files, rules } = flags; 45 | if (!dir && !files) { 46 | throw new SfError( 47 | commandMessages.getMessage("errorMutuallyExclusiveRequired"), 48 | ); 49 | } 50 | 51 | this.spinner.start("Loading Lightning Flow Scanner", null, { 52 | stdout: true, 53 | }); 54 | 55 | const fixService = new CoreFixService(dir, files, rules); 56 | 57 | const outMessage = (await fixService.fix()).join(", "); 58 | 59 | this.debug(`test`, outMessage); 60 | 61 | this.spinner.stop(`Fix Complete.. Fixed ${outMessage}`); 62 | 63 | return { 64 | summary: { 65 | message: `Fixed ${outMessage}`, 66 | }, 67 | } as ScanResult; 68 | } 69 | } 70 | -------------------------------------------------------------------------------- /src/commands/flow/scan.ts: -------------------------------------------------------------------------------- 1 | import { SfCommand, Flags } from "@salesforce/sf-plugins-core"; 2 | import { Messages, SfError } from "@salesforce/core"; 3 | import chalk from "chalk"; 4 | import { exec } from "child_process"; 5 | 6 | import { loadScannerOptions } from "../../libs/ScannerConfig.js"; 7 | import { FindFlows } from "../../libs/FindFlows.js"; 8 | import { ScanResult as Output } from "../../models/ScanResult.js"; 9 | 10 | import pkg, { 11 | ParsedFlow, 12 | ScanResult, 13 | RuleResult, 14 | ResultDetails, 15 | } from "lightning-flow-scanner-core"; 16 | const { parse: parseFlows, scan: scanFlows } = pkg; 17 | 18 | Messages.importMessagesDirectoryFromMetaUrl(import.meta.url); 19 | 20 | const messages = Messages.loadMessages("lightning-flow-scanner", "command"); 21 | 22 | export default class Scan extends SfCommand { 23 | public static description = messages.getMessage("commandDescription"); 24 | public static examples: string[] = [ 25 | "sf flow scan", 26 | "sf flow scan --failon warning", 27 | "sf flow scan -c path/to/config.json", 28 | "sf flow scan -c path/to/config.json --json", 29 | "sf flow scan -c path/to/config.json --failon warning", 30 | "sf flow scan -d path/to/flows/directory", 31 | "sf flow scan --files path/to/single/file.flow-meta.xml path/to/another/file.flow-meta.xml", 32 | "sf flow scan -p path/to/single/file.flow-meta.xml path/to/another/file.flow-meta.xml", 33 | ]; 34 | 35 | protected static requiresUsername = false; 36 | protected static supportsDevhubUsername = false; 37 | public static requiresProject = false; 38 | protected static supportsUsername = true; 39 | 40 | protected userConfig: object; 41 | protected failOn = "error"; 42 | protected errorCounters: Map = new Map(); 43 | 44 | public static readonly flags = { 45 | directory: Flags.directory({ 46 | char: "d", 47 | description: messages.getMessage("directoryToScan"), 48 | required: false, 49 | exists: true, 50 | exclusive: ["files"], 51 | }), 52 | config: Flags.file({ 53 | char: "c", 54 | description: "Path to configuration file", 55 | required: false, 56 | }), 57 | failon: Flags.option({ 58 | char: "f", 59 | description: 60 | "Threshold failure level (error, warning, note, or never) defining when the command return code will be 1", 61 | options: ["error", "warning", "note", "never"] as const, 62 | default: "error", 63 | })(), 64 | retrieve: Flags.boolean({ 65 | char: "r", 66 | description: "Force retrieve Flows from org at the start of the command", 67 | default: false, 68 | }), 69 | files: Flags.file({ 70 | multiple: true, 71 | exists: true, 72 | description: "List of source flows paths to scan", 73 | charAliases: ["p"], 74 | exclusive: ["directory"], 75 | }), 76 | targetusername: Flags.string({ 77 | char: "u", 78 | description: 79 | "Retrieve the latest metadata from the target before the scan.", 80 | required: false, 81 | charAliases: ["o"], 82 | }), 83 | }; 84 | 85 | public async run(): Promise { 86 | const { flags } = await this.parse(Scan); 87 | this.failOn = flags.failon || "error"; 88 | this.spinner.start("Loading Lightning Flow Scanner"); 89 | this.userConfig = await loadScannerOptions(flags.config); 90 | if (flags.targetusername) { 91 | await this.retrieveFlowsFromOrg(flags.targetusername); 92 | } 93 | 94 | const targets: string[] = flags.files; 95 | 96 | const flowFiles = this.findFlows(flags.directory, targets); 97 | this.spinner.start(`Identified ${flowFiles.length} flows to scan`); 98 | // to 99 | // core.Flow 100 | const parsedFlows: ParsedFlow[] = await parseFlows(flowFiles); 101 | this.debug(`parsed flows ${parsedFlows.length}`, ...parsedFlows); 102 | 103 | const scanResults: ScanResult[] = 104 | this.userConfig && Object.keys(this.userConfig).length > 0 105 | ? scanFlows(parsedFlows, this.userConfig) 106 | : scanFlows(parsedFlows); 107 | 108 | this.debug(`scan results: ${scanResults.length}`, ...scanResults); 109 | this.spinner.stop(`Scan complete`); 110 | 111 | // Build results 112 | const results = this.buildResults(scanResults); 113 | 114 | if (results.length > 0) { 115 | const resultsByFlow = {}; 116 | for (const result of results) { 117 | resultsByFlow[result.flowName] = resultsByFlow[result.flowName] || []; 118 | resultsByFlow[result.flowName].push(result); 119 | } 120 | for (const resultKey in resultsByFlow) { 121 | const matchingScanResult = scanResults.find((res) => { 122 | return res.flow.label === resultKey; 123 | }); 124 | this.styledHeader( 125 | "Flow: " + 126 | chalk.yellow(resultKey) + 127 | " " + 128 | chalk.bgYellow(`(${matchingScanResult.flow.name}.flow-meta.xml)`) + 129 | " " + 130 | chalk.red("(" + resultsByFlow[resultKey].length + " results)"), 131 | ); 132 | this.log(chalk.italic("Type: " + matchingScanResult.flow.type)); 133 | this.log(""); 134 | // todo flow uri 135 | //this.table(resultsByFlow[resultKey], ['rule', 'type', 'name', 'severity']); 136 | this.table({ 137 | data: resultsByFlow[resultKey], 138 | columns: ["rule", "type", "name", "severity"], 139 | }); 140 | this.log(""); 141 | } 142 | } 143 | this.styledHeader( 144 | "Total: " + 145 | chalk.red(results.length + " Results") + 146 | " in " + 147 | chalk.yellow(scanResults.length + " Flows") + 148 | ".", 149 | ); 150 | 151 | // Display number of errors by severity 152 | for (const severity of ["error", "warning", "note"]) { 153 | const severityCounter = this.errorCounters[severity] || 0; 154 | this.log(`- ${severity}: ${severityCounter}`); 155 | } 156 | 157 | // TODO CALL TO ACTION 158 | this.log(""); 159 | this.log( 160 | chalk.bold( 161 | chalk.italic( 162 | chalk.yellowBright( 163 | "Be a part of our mission to champion Flow Best Practices by starring ⭐ us on GitHub:", 164 | ), 165 | ), 166 | ), 167 | ); 168 | this.log( 169 | chalk.italic( 170 | chalk.blueBright( 171 | chalk.underline("https://github.com/Lightning-Flow-Scanner"), 172 | ), 173 | ), 174 | ); 175 | 176 | const status = this.getStatus(); 177 | // Set status code = 1 if there are errors, that will make cli exit with code 1 when not in --json mode 178 | if (status > 0) { 179 | process.exitCode = status; 180 | } 181 | const summary = { 182 | flowsNumber: scanResults.length, 183 | results: results.length, 184 | message: 185 | "A total of " + 186 | results.length + 187 | " results have been found in " + 188 | scanResults.length + 189 | " flows.", 190 | errorLevelsDetails: {}, 191 | }; 192 | return { summary, status: status, results }; 193 | } 194 | 195 | private findFlows(directory: string, sourcepath: string[]) { 196 | // List flows that will be scanned 197 | let flowFiles; 198 | if (directory) { 199 | flowFiles = FindFlows(directory); 200 | } else if (sourcepath) { 201 | flowFiles = sourcepath; 202 | } else { 203 | flowFiles = FindFlows("."); 204 | } 205 | return flowFiles; 206 | } 207 | 208 | private getStatus() { 209 | let status = 0; 210 | if (this.failOn === "never") { 211 | status = 0; 212 | } else { 213 | if (this.failOn === "error" && this.errorCounters["error"] > 0) { 214 | status = 1; 215 | } else if ( 216 | this.failOn === "warning" && 217 | (this.errorCounters["error"] > 0 || this.errorCounters["warning"] > 0) 218 | ) { 219 | status = 1; 220 | } else if ( 221 | this.failOn === "note" && 222 | (this.errorCounters["error"] > 0 || 223 | this.errorCounters["warning"] > 0 || 224 | this.errorCounters["note"] > 0) 225 | ) { 226 | status = 1; 227 | } 228 | } 229 | return status; 230 | } 231 | 232 | private buildResults(scanResults) { 233 | const errors = []; 234 | for (const scanResult of scanResults) { 235 | const flowName = scanResult.flow.label; 236 | const flowType = scanResult.flow.type[0]; 237 | for (const ruleResult of scanResult.ruleResults as RuleResult[]) { 238 | const ruleDescription = ruleResult.ruleDefinition.description; 239 | const rule = ruleResult.ruleDefinition.label; 240 | if ( 241 | ruleResult.occurs && 242 | ruleResult.details && 243 | ruleResult.details.length > 0 244 | ) { 245 | const severity = ruleResult.severity || "error"; 246 | const flowUri = scanResult.flow.fsPath; 247 | const flowApiName = `${scanResult.flow.name}.flow-meta.xml`; 248 | for (const result of ruleResult.details as ResultDetails[]) { 249 | const detailObj = Object.assign(result, { 250 | ruleDescription, 251 | rule, 252 | flowName, 253 | flowType, 254 | severity, 255 | flowUri, 256 | flowApiName, 257 | }); 258 | errors.push(detailObj); 259 | this.errorCounters[severity] = 260 | (this.errorCounters[severity] || 0) + 1; 261 | } 262 | } 263 | } 264 | } 265 | return errors; 266 | } 267 | 268 | private async retrieveFlowsFromOrg(targetusername: string) { 269 | let errored = false; 270 | this.spinner.start(chalk.yellowBright("Retrieving Metadata...")); 271 | const retrieveCommand = `sf project retrieve start -m Flow -o "${targetusername}"`; 272 | try { 273 | await exec(retrieveCommand, { maxBuffer: 1000000 * 1024 }); 274 | } catch (exception) { 275 | errored = true; 276 | this.toErrorJson(exception); 277 | this.spinner.stop(chalk.redBright("Retrieve Operation Failed.")); 278 | } 279 | if (errored) { 280 | throw new SfError( 281 | messages.getMessage("errorRetrievingMetadata"), 282 | "", 283 | [], 284 | 1, 285 | ); 286 | } else { 287 | this.spinner.stop(chalk.greenBright("Retrieve Completed ✔.")); 288 | } 289 | } 290 | } 291 | -------------------------------------------------------------------------------- /src/index.ts: -------------------------------------------------------------------------------- 1 | export default {}; 2 | -------------------------------------------------------------------------------- /src/libs/CoreFixService.ts: -------------------------------------------------------------------------------- 1 | import { IRulesConfig } from "lightning-flow-scanner-core/main/internals/internals.js"; 2 | import { writeFileSync } from "node:fs"; 3 | 4 | import { FindFlows } from "./FindFlows.js"; 5 | import pkg from "lightning-flow-scanner-core"; 6 | const { scan, parse, fix: fixFlows } = pkg; 7 | 8 | import type { ScanResult as FlowScanResults } from "lightning-flow-scanner-core"; 9 | 10 | export default class CoreFixService { 11 | public constructor( 12 | private readonly dir, 13 | private readonly file, 14 | private readonly rules, 15 | ) {} 16 | 17 | public async fix(): Promise { 18 | //find flow file(s) 19 | const flowFiles = this.findFlows(); 20 | const parsedFlows = await parse(flowFiles); 21 | 22 | // make on the fly rule 23 | const flatRules = this.rules 24 | .map((content) => { 25 | return { rules: { [content]: { severity: "error" } } }; 26 | }) 27 | .reduce( 28 | (prev, current) => { 29 | prev.rules = { ...prev.rules, ...current.rules }; 30 | return prev; 31 | }, 32 | { rules: {} }, 33 | ) as IRulesConfig; 34 | 35 | // scan 36 | const scanResults: FlowScanResults[] = scan(parsedFlows, flatRules); 37 | 38 | // fix 39 | const fixFlow: FlowScanResults[] = fixFlows(scanResults); 40 | fixFlow.forEach((fixedObject) => { 41 | writeFileSync(fixedObject.flow.fsPath, fixedObject.flow.toXMLString()); 42 | }); 43 | 44 | return fixFlow.map((fixedOut) => fixedOut.flow.fsPath); 45 | } 46 | 47 | private findFlows(): string[] { 48 | if (this.dir) { 49 | return this.findFlowsByDir(this.dir); 50 | } 51 | return this.findFlowsByPath(this.file); 52 | } 53 | 54 | private findFlowsByDir(dir: string[]): string[] { 55 | return dir 56 | .map((dirName) => { 57 | return FindFlows(dirName); 58 | }) 59 | .flat(1); 60 | } 61 | 62 | private findFlowsByPath(path: string[]): string[] { 63 | return [...path]; 64 | } 65 | } 66 | -------------------------------------------------------------------------------- /src/libs/FindFlows.ts: -------------------------------------------------------------------------------- 1 | import * as glob from 'glob'; 2 | 3 | export function FindFlows(dir: string): string[] { 4 | 5 | const getDirectories = function (src) { 6 | return glob.sync(src + '/**/*.{flow-meta.xml,flow}', { 7 | ignore: ['./node_modules/**'] 8 | }); 9 | }; 10 | return getDirectories(dir); 11 | 12 | } 13 | -------------------------------------------------------------------------------- /src/libs/FindIgnoreFile.ts: -------------------------------------------------------------------------------- 1 | import {readdirSync, statSync} from 'fs'; 2 | import * as path from 'path'; 3 | 4 | export function FindIgnoreFile(dir: string) { 5 | const allFiles = (dir, ext, files?, result?, regex?) => { 6 | files = files || readdirSync(dir); 7 | result = result || []; 8 | regex = regex || new RegExp(`\\${ext}$`); 9 | 10 | for (let i = 0; i < files.length; i++) { 11 | let file = path.join(dir, files[i]); 12 | if (statSync(file).isDirectory() && !path.extname(file)) { 13 | try { 14 | result = allFiles(file, ext, readdirSync(file), result, regex); 15 | } catch (error) { 16 | continue; 17 | } 18 | } else { 19 | if (regex.test(file)) { 20 | result.push(file); 21 | } 22 | } 23 | } 24 | return result; 25 | }; 26 | return allFiles(dir, '.flowscanignore.json'); 27 | } 28 | -------------------------------------------------------------------------------- /src/libs/ScannerConfig.ts: -------------------------------------------------------------------------------- 1 | import { cosmiconfig } from "cosmiconfig"; 2 | export async function loadScannerOptions( 3 | forcedConfigFile: string, 4 | ): Promise { 5 | // Read config from file 6 | const moduleName = "flow-scanner"; 7 | const searchPlaces = [ 8 | "package.json", 9 | `.${moduleName}.yaml`, 10 | `.${moduleName}.yml`, 11 | `.${moduleName}.json`, 12 | `config/.${moduleName}.yaml`, 13 | `config/.${moduleName}.yml`, 14 | `.flow-scanner`, 15 | ]; 16 | const explorer = cosmiconfig(moduleName, { 17 | searchPlaces, 18 | }); 19 | let explorerResults; 20 | if (forcedConfigFile) { 21 | // Forced config file name 22 | explorerResults = await explorer.load(forcedConfigFile); 23 | } 24 | // Let cosmiconfig look for a config file 25 | explorerResults = explorerResults ?? (await explorer.search()); 26 | return explorerResults?.config ?? undefined; 27 | } 28 | -------------------------------------------------------------------------------- /src/models/ScanResult.ts: -------------------------------------------------------------------------------- 1 | import { Violation } from "./Violation.js"; 2 | 3 | export type ScanResult = { 4 | status: number; 5 | summary: { 6 | flowsNumber: number; 7 | results: number; 8 | message: string; 9 | }; 10 | results: Violation[]; 11 | }; 12 | -------------------------------------------------------------------------------- /src/models/Violation.ts: -------------------------------------------------------------------------------- 1 | export class Violation { 2 | constructor( 3 | public flowName: string, 4 | public ruleName: string, 5 | public description: string, 6 | public severity: string, 7 | public type: string, 8 | public details?, 9 | ) {} 10 | } 11 | -------------------------------------------------------------------------------- /test/commands/flow/fix.test.ts: -------------------------------------------------------------------------------- 1 | import { runCommand } from "@oclif/test"; 2 | import { expect } from "chai"; 3 | import { Config } from "@oclif/core"; 4 | import sinon from "sinon"; 5 | 6 | import { ScanResult } from "../../../src/models/ScanResult.js"; 7 | import FlowFix from "../../../src/commands/flow/fix.js"; 8 | import CoreFixService from "../../../src/libs/CoreFixService.js"; 9 | 10 | describe("flow:fix", () => { 11 | it("runs flow:fix e2e", async () => { 12 | sinon 13 | .stub(CoreFixService.prototype, "fix") 14 | .resolves(["/path/to/resolved.flow-meta.xml"]); 15 | const config: Config = new Config({ 16 | root: "/tmp", 17 | pjson: { 18 | name: "test-cli", 19 | version: "0.0.1", 20 | oclif: { 21 | bin: "test-cli", 22 | }, 23 | }, 24 | }); 25 | await config.load(); 26 | const scanResult: ScanResult = await new FlowFix( 27 | ["-r", "UnusedVariable", "-d", "."], 28 | config, 29 | ).run(); 30 | expect(scanResult.summary.message).to.contain( 31 | "Fixed /path/to/resolved.flow-meta.xml", 32 | ); 33 | }); 34 | 35 | describe("runs flow:fix flags", () => { 36 | it("should throw an exception when rule is not specified", async () => { 37 | const { stderr } = await runCommand("flow:fix -d a"); 38 | expect(stderr).to.contain("Missing required flag rules"); 39 | }); 40 | it("should throw an exception when mutually exclusive flags specified", async () => { 41 | const { stderr } = await runCommand( 42 | "flow:fix -r UnusedVariable -d a -f ./test/commands/flow/fix.test.ts", 43 | ); 44 | expect(stderr).to.contain("cannot also be provided when using"); 45 | expect(stderr).to.contain("--file"); 46 | expect(stderr).to.contain("--dir"); 47 | }); 48 | }); 49 | 50 | describe("runs flow:fix unit", () => { 51 | it("should throw an exception for mutually exclusive required", async () => { 52 | const config: Config = new Config({ 53 | root: "/tmp", 54 | pjson: { 55 | name: "test-cli", 56 | version: "0.0.1", 57 | oclif: { 58 | bin: "test-cli", 59 | }, 60 | }, 61 | }); 62 | await config.load(); 63 | try { 64 | await new FlowFix( 65 | [ 66 | "-r", 67 | "UnusedVariable", 68 | "-d", 69 | ".", 70 | "./src", 71 | "-f", 72 | "./test/commands/flow/fix.test.ts", 73 | ], 74 | config, 75 | ).run(); 76 | } catch (error: any) { 77 | expect(error.message).to.contain("cannot also be provided when using"); 78 | expect(error.message).to.contain("--file"); 79 | expect(error.message).to.contain("--dir"); 80 | } 81 | }); 82 | }); 83 | }); 84 | -------------------------------------------------------------------------------- /test/commands/flow/scan.test.ts: -------------------------------------------------------------------------------- 1 | import Scan from "../../../src/commands/flow/scan.js"; 2 | import { ScanResult } from "../../../src/models/ScanResult.js"; 3 | import { expect } from "chai"; 4 | import { Config } from "@oclif/core"; 5 | 6 | describe("flow:scan", () => { 7 | let config: Config; 8 | 9 | beforeEach(async () => { 10 | config = await Config.load(import.meta.url); 11 | }); 12 | 13 | it("scan no flows", async () => { 14 | const output = await new Scan([], config).run(); 15 | expect(output.summary.flowsNumber).to.equal(0); 16 | }); 17 | it("throw error if --directory and --sourcepath are given", async () => { 18 | let output: ScanResult; 19 | try { 20 | const output = await new Scan( 21 | ["--directory", "test/", "--files", "test/commands/flow/scan.test.ts"], 22 | config, 23 | ).run(); 24 | console.log(output); 25 | } catch (e) { 26 | expect((e as Error).message).to.contains( 27 | "cannot also be provided when using --directory", 28 | ); 29 | } 30 | expect(output).to.be.equal(undefined); 31 | }); 32 | }); 33 | -------------------------------------------------------------------------------- /test/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tsconfig" 3 | } 4 | 5 | -------------------------------------------------------------------------------- /tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "compilerOptions": { 3 | "moduleResolution": "Node16", 4 | "module": "Node16", 5 | "target": "ES2022", 6 | "lib": ["ES2022"], 7 | "alwaysStrict": true, 8 | "noUnusedLocals": true, 9 | "sourceMap": true, 10 | "declaration": true, 11 | "outDir": "./lib", 12 | "importHelpers": true, 13 | "resolveJsonModule": true, 14 | "types": ["node", "mocha"], 15 | "skipLibCheck": true, 16 | "allowSyntheticDefaultImports": true 17 | }, 18 | "ts-node": { 19 | "esm": true 20 | }, 21 | "include": ["./src/**/*", "./test/**/*"] 22 | } 23 | --------------------------------------------------------------------------------