lightning-flow-scanner-core - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

package.json

 {
   "name": "lightning-flow-scanner-core",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "out/**",
@@ -5,0 +5,0 @@ "types": "out/index.d.ts",

readme.md

@@ -17,13 +17,13 @@ # Lightning Flow Scanner(Core)
 
-`getRuleDefinitions(ruleNames? : string[]): IRuleDefinition[];`
+`GetRules(ruleNames? : string[]): IRuleDefinition[];`
 
 Returns all rules if there are no ruleNames specified. In case ruleNames are specified, it will only return rules which are included by name. 
 
-`scan(flows :Flow[], ruleNames? : string[]): ScanResult[];`
+`Scan(flows: Flow[], ruleOptions?: ScannerOptions): ScanResult[];`
 
-Runs all rules if there are no ruleNames specified. In case ruleNames are specified, it will only run rules which are included by name. 
+If there are no ruleNames specified, it will run all available rules by default. In case that there are ruleNames specified, only the  specified rules will be ran.
 
-`fix(flows :Flow[]): ScanResult[];`
+`Fix(flows :Flow[]): ScanResult[];`
 
-Removes unused variables and unconnected elements from all selected flows.
+Remove unused variables and unconnected elements from selected flows automatically.
 

src/index.ts

@@ -0,9 +1,9 @@
+import {IRuleDefinition} from './main/interfaces/IRuleDefinition';
+import {ApplyOverrides} from './main/libs/ApplyOverrides';
 import {FixFlows} from './main/libs/FixFlows';
 import {GetRuleDefinitions} from './main/libs/GetRuleDefinitions';
-import {IRuleDefinition} from './main/interfaces/IRuleDefinition';
 import {ScanFlows} from './main/libs/ScanFlows';
 import {Flow} from './main/models/Flow';
+import {ScannerOptions} from './main/models/ScannerOptions';
 import {ScanResult} from './main/models/ScanResult';
-import {ScannerOptions} from "./main/models/ScannerOptions";
-import {ApplyOverrides} from "./main/libs/ApplyOverrides";
 
@@ -10,0 +10,0 @@ export function GetRules(ruleNames?: string[]): IRuleDefinition[] {

src/main/libs/ApplyOverrides.ts

@@ -1,3 +0,3 @@
-import {ScanResult} from "../models/ScanResult";
-import {FlowScanOverrides} from "../models/FlowScanOverrides";
+import {FlowScanOverrides} from '../models/FlowScanOverrides';
+import {ScanResult} from '../models/ScanResult';
 
@@ -4,0 +4,0 @@ export function ApplyOverrides(scanResults: ScanResult[], overrides: FlowScanOverrides[]): ScanResult[] {

src/main/libs/FixFlows.ts

 import {Flow} from '../models/Flow';
 import {FlowElement} from '../models/FlowElement';
 import {FlowVariable} from '../models/FlowVariable';
+import {RuleResult} from '../models/RuleResult';
+import {ScanResult} from '../models/ScanResult';
 import {UnconnectedElements} from '../rules/UnconnectedElements';
 import {UnusedVariables} from '../rules/UnusedVariables';
 import {BuildFlow} from './BuildFlow';
-import {ScanResult} from "../models/ScanResult";
-import {RuleResult} from "../models/RuleResult";
 
@@ -10,0 +10,0 @@ export function FixFlows(flows: Flow[]) : ScanResult[] {

src/main/libs/GetRuleDefinitions.ts

@@ -0,4 +1,4 @@
+import {IRuleDefinition} from '../interfaces/IRuleDefinition';
 import {RuleDefinitions} from '../ruledefinitions/RuleDefinitions';
 import {DynamicRule} from './DynamicRule';
-import {IRuleDefinition} from '../interfaces/IRuleDefinition';
 
@@ -5,0 +5,0 @@ export function GetRuleDefinitions(ruleNames? : string[]) : IRuleDefinition[] {

src/main/libs/ScanFlows.ts

@@ -0,1 +1,2 @@
+import {IRuleDefinition} from '../interfaces/IRuleDefinition';
 import {Flow} from '../models/Flow';
@@ -5,3 +6,2 @@ import {RuleResult} from '../models/RuleResult';
 import {GetRuleDefinitions} from './GetRuleDefinitions';
-import {IRuleDefinition} from '../interfaces/IRuleDefinition';
 
@@ -8,0 +8,0 @@ export function ScanFlows(flows: Flow[], ruleNames?: string[]): ScanResult[] {

src/main/models/FlowScanOverrides.ts

@@ -1,2 +0,2 @@
-import {Override} from "./Override";
+import {Override} from './Override';
 
@@ -3,0 +3,0 @@ export class FlowScanOverrides {

src/main/rules/HardcodedIds.ts

@@ -5,4 +5,4 @@ import * as IdPrefixes from '../data/IdPrefixes.json';
 import {RuleResult} from '../models/RuleResult';
-import {RuleInfo} from "../ruledefinitions/RuleInfo";
-import {RuleDefinitions} from "../ruledefinitions/RuleDefinitions";
+import {RuleDefinitions} from '../ruledefinitions/RuleDefinitions';
+import {RuleInfo} from '../ruledefinitions/RuleInfo';
 
@@ -9,0 +9,0 @@ export class HardcodedIds implements IRuleDefinition{

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

1102776

decreased by-6.71%

Number of package files

249

decreased by-4.96%

Lines of code

40297

decreased by-9.82%

No dependency changes