寻找和解决你的销售流量的问题 在你的sf cli

快开始

echo y | sf plugins install @corekraft/flow-linter

sf flow lint

目录

• 安装
• 使用量
  • 选项
  • 实例
• 配置
  • 界定每项规则的严重程度
  • 指定例外
  • 配置表达式
  • 装入自定义规则
• 开发设置

安装

sf plugins install @corekraft/flow-linter

使用量

sf flow lint

选项

  -c, --config <path>                                               provide a path to the configuration file.

  -f, --failon                                                      provide a threshold level for returning status 1

  -p, --files <C:\..\flow1.flow, C:\..\flow2.flow>                  provide a space-separated list of flow paths to scan.

  -u, --targetusername <username>                                   retrieve the latest metadata from the target before the scan.

  -d, --directory <C:\..\force-app\main\default\flows>              provide a directory to scan.

  --json                                                            set output format as json.

  --loglevel=(trace|debug|info|warn|error|fatal)                    [default: warn] logging level.

实例

您可以通过简单地打开一个包含流和运行扫描而没有任何配置或参数的现有工程来测试扫描仪. 这样所有的默认规则都会自动地包含在扫描中.

sfdx flow:scan

sfdx flow:scan --json

sfdx flow:scan --config path/to/.flow-scanner.json

配置

创建 . flow-scanner.json 文件以配置 :

• 执行规则.
• 违反任何具体规则的严重程度.
• 自定义表达式或规则执行 .
• 在扫描时应忽略的任何已知例外.

{
    "rules": {
        ...
    },
    "exceptions": {
        ...
    }
}

注意: 如果您喜欢YAML格式, 您可以创建 .flow-scanner.yml 文件使用相同的格式.

界定每项规则的严重程度

当不提供严重程度时 error 默认。 其他可用严重值为: warning 财务报告和审定财务报表 note如以下例子所示,界定每项规则的严重程度.

{
  "rules": {
    "FlowDescription": {
      "severity": "warning"
    },
    "UnusedVariable": {
      "severity": "error"
    }
  }
}

指定例外

如下例所示,通过流量、规则和结果可以指定例外情况.

{
  "exceptions": {
    "AssignTaskOwner": {
      "UnusedVariable": [
        "somecount"
      ]
    },
    "GetAccounts":{
      "UnusedVariable": [
        "incvar"
      ]
    }
  }
}

配置表达式

一些规则有附加属性可以配置,如表达式会覆盖默认值. 如下例所示,这些可以与严重程度相同的方式配置.

{
  "rules": {
    "APIVersion":
    {
        "severity": "error",
        "expression": "===58"
    },
    "FlowName":
    {
        "severity": "error",
        "expression": "[A-Za-z0-9]"
    }
  }
}

装入自定义规则( 正在重新存档)

要使用 Flow Linter Core 装入自定义规则, 您可以使用 path 属性在配置的规则栏中。 此属性允许您指定您的自定义规则类的路径, 从而能够将特定组织的规则定义无缝地整合到扫描仪的规则集中.

{
    "rules": {
        "<RuleName>": {
            "path": "<yourtypescriptfilepath>"
        }
    }
}

自定义规则可以发挥我们流程编译器的杠杆作用,也可以被完全定制的打字功能. 关于海关规则的更多细节和实例,请参见我们 自定义规则创建指南

开发设置

准备更改

1. 克隆项目: 从寄存器中清除流式 linter sfcli 插件项目 .
2. 安装依赖关系: 打开目录并运行 npm install 或者说 yarn install 在终端中安装必要的依赖.
3. 可选: 更改: 例如,如果想要使用npm升级核心模块,可以使用命令: npm update @corekraft/flow-linter-core
4. 预包装: 执行 npm run prepack 用于本地构建插件并准备包装.
5. 链接插件: 使用 Salesforce DX 环境链接插件 sfdx plugins link .。 。 。 .

调试插件

1. 连接核心模块: 您可能需要克隆并链接 @corekraft/flow-linter-core 本地到您的项目。 这个步骤是有必要的,如果您正在对核心模块进行修改,并希望这些修改在插件中反映出来. 您可以通过导航与其目录和运行来链接核心模块:

npm link

然后,导航到 sfdx 插件目录并运行 :

npm link @corekraft/flow-linter-core

1. 运行插件: 在您示例流工程(或任何其他用于扫描的工程)的终端中,运行以下命令以启动已启用的调试插件:

NODE_OPTIONS=--inspect-brk /path/to/flow-linter-sfcli/bin/run flow:lint

2. 附加调试器:在Visual Studio代码中打开您本地的 Salesforce DX 项目,设置想要的断点,并将调试器附加到远程会话中.

更多信息,请参考 维基百科 销售力量CLI存储器.