Merge pull request #63 from Lightning-Flow-Scanner/f2

Improvement 	Unexisting specified rulesin configuration 
Incorrect severity configurations

Author: RubenHalman

package.json

@@ -1,6 +1,6 @@
 {
   "name": "lightning-flow-scanner-core",
-  "version": "2.26.0",
+  "version": "2.27.0",
   "main": "out/**",
   "types": "out/index.d.ts",
   "scripts": {

readme.md

@@ -6,7 +6,7 @@
 
 - [Outdated API Version](#outdated-api-version)
 - [Copy API Name](#copy-api-name)
-- [DML Statement In A Loop'](#dml-statement-in-a-loop)
+- [DML Statement In A Loop](#dml-statement-in-a-loop)
 - [Duplicate DML Operation](#duplicate-dml-operation)
 - [Missing Flow Description](#missing-flow-description)
 - [Flow Naming Convention](#flow-naming-convention)

src/index.ts

@@ -3,10 +3,10 @@ import { IRulesConfig } from './main/interfaces/IRulesConfig';
 import { FixFlows } from './main/libs/FixFlows';
 import { GetRuleDefinitions } from './main/libs/GetRuleDefinitions';
 import { ScanFlows } from './main/libs/ScanFlows';
-import { Flow } from './main/models/Flow';
-import { ResultDetails } from './main/models/ResultDetails';
-import { RuleResult } from './main/models/RuleResult';
-import { ScanResult } from './main/models/ScanResult';
+import Flow from './main/models/Flow';
+import ResultDetails from './main/models/ResultDetails';
+import RuleResult from './main/models/RuleResult';
+import ScanResult from './main/models/ScanResult';
 
 export function getRules(ruleNames?: string[]): IRuleDefinition[] {
   if (ruleNames && ruleNames.length > 0) {
@@ -53,4 +53,9 @@ export function scan(flows: Flow[], ruleOptions?: IRulesConfig): ScanResult[] {
 
 export function fix(flows: Flow[]): ScanResult[] {
   return FixFlows(flows);
-}
+}
+
+export { default as Flow } from './main/models/Flow';
+export { default as ScanResult } from './main/models/ScanResult';
+export { default as RuleResult } from './main/models/RuleResult';
+export { default as ResultDetails } from './main/models/ResultDetails';

src/main/interfaces/IRuleDefinition.ts

@@ -1,5 +1,5 @@
-import { Flow } from '../models/Flow';
-import { RuleResult } from '../models/RuleResult';
+import Flow from '../models/Flow';
+import RuleResult from '../models/RuleResult';
 
 export interface IRuleDefinition {
   uri: string;

src/main/libs/Compiler.ts

@@ -1,4 +1,4 @@
-import { Flow } from '../models/Flow';
+import Flow from '../models/Flow';
 import { FlowNode } from '../models/FlowNode';
 
 export class Compiler {
@@ -26,7 +26,7 @@ export class Compiler {
 
     traverseFlow(flow: Flow, startElementName: string, visitCallback: (element: FlowNode) => void) {
         // Iterative Deepening Depth-First Search (IDDFS)
-        let depth = 0;
+        // let depth = 0;
         let elementsToVisit = [startElementName];
 
         while (elementsToVisit.length > 0) {
@@ -44,8 +44,8 @@ export class Compiler {
             }
 
             elementsToVisit = nextElements;
-            depth++;
             // add logic to control depth or terminate the traversal based on requirements.
+            // depth++;
         }
     }
 

src/main/libs/DynamicRule.ts

@@ -5,7 +5,7 @@ export class DynamicRule {
 
     if (DefaultRuleStore[className] === undefined || DefaultRuleStore[className] === null) {
 
-      throw new Error(`Class type of \'${className}\' is not in the store`);
+      throw new Error(`Rule \'${className}\' does not exist in the store.`);
     }
     return new DefaultRuleStore[className]();
   }

src/main/libs/FixFlows.ts

@@ -1,22 +1,19 @@
-import { Flow } from '../models/Flow';
 import { FlowNode } from '../models/FlowNode';
 import { FlowVariable } from '../models/FlowVariable';
-import { ResultDetails } from '../models/ResultDetails';
-import { RuleResult } from '../models/RuleResult';
-import { ScanResult } from '../models/ScanResult';
 import { UnconnectedElement } from '../rules/UnconnectedElement';
 import { UnusedVariable } from '../rules/UnusedVariable';
 import { BuildFlow } from './BuildFlow';
+import * as core from '../../index';
 
-export function FixFlows(flows: Flow[]): ScanResult[] {
+export function FixFlows(flows: core.Flow[]): core.ScanResult[] {
 
-  const flowResults: ScanResult[] = [];
+  const flowResults: core.ScanResult[] = [];
   for (const flow of flows) {
-    const unconnectedElementsResult: RuleResult = new UnconnectedElement().execute(flow);
-    const unusedVariablesResult: RuleResult = new UnusedVariable().execute(flow);
-    const ruleResults: RuleResult[] = [unusedVariablesResult, unconnectedElementsResult];
-    const unusedVariableReferences = unusedVariablesResult.details ? (unusedVariablesResult.details as ResultDetails[]).map(unusedVariable => unusedVariable.name) : [];
-    const unconnectedElementsReferences = unconnectedElementsResult.details ? (unconnectedElementsResult.details as ResultDetails[]).map(unconnectedElement => unconnectedElement.name) : [];
+    const unconnectedElementsResult: core.RuleResult = new UnconnectedElement().execute(flow);
+    const unusedVariablesResult: core.RuleResult = new UnusedVariable().execute(flow);
+    const ruleResults: core.RuleResult[] = [unusedVariablesResult, unconnectedElementsResult];
+    const unusedVariableReferences = unusedVariablesResult.details ? (unusedVariablesResult.details as core.ResultDetails[]).map(unusedVariable => unusedVariable.name) : [];
+    const unconnectedElementsReferences = unconnectedElementsResult.details ? (unconnectedElementsResult.details as core.ResultDetails[]).map(unconnectedElement => unconnectedElement.name) : [];
     const nodesToBuild = flow.elements.filter(node => {
       switch (node.metaType) {
         case 'variable':
@@ -38,7 +35,7 @@ export function FixFlows(flows: Flow[]): ScanResult[] {
     );
     flow.xmldata = BuildFlow(nodesToBuild);
     flow.preProcessNodes();
-    flowResults.push(new ScanResult(flow, ruleResults));
+    flowResults.push(new core.ScanResult(flow, ruleResults));
   }
   return flowResults;
 }

src/main/libs/GetRuleDefinitions.ts

@@ -8,15 +8,17 @@ export function GetRuleDefinitions(ruleConfig?: Map<string, {}>): IRuleDefinitio
 
   if (ruleConfig && ruleConfig instanceof Map) {
     for (const ruleName of ruleConfig.keys()) {
-      const matchedRule = new DynamicRule(ruleName);
-      const configuredSeverity = ruleConfig.get(ruleName)['severity'];
-      if (configuredSeverity && (configuredSeverity === "error" || configuredSeverity === "warning" || configuredSeverity === "note")) {
-        severity = configuredSeverity;
-      } else {
-        throw new Error(`Invalid severity "${configuredSeverity}" provided for rule "${ruleName}".`);
+      try{
+        const matchedRule = new DynamicRule(ruleName);
+          const configuredSeverity = ruleConfig.get(ruleName)['severity'];
+          if (configuredSeverity && (configuredSeverity === "error" || configuredSeverity === "warning" || configuredSeverity === "note")) {
+            severity = configuredSeverity;
+          } 
+          matchedRule['severity'] = severity;
+          matchedRules.push(matchedRule);
+      } catch (error) {
+        console.log(error.message)
       }
-      matchedRule['severity'] = severity;
-      matchedRules.push(matchedRule);
     }
   } else {
     // tslint:disable-next-line:forin

src/main/libs/ScanFlows.ts

@@ -1,13 +1,11 @@
 import { IRuleDefinition } from '../interfaces/IRuleDefinition';
-import { Flow } from '../models/Flow';
-import { RuleResult } from '../models/RuleResult';
-import { ScanResult } from '../models/ScanResult';
 import { GetRuleDefinitions } from './GetRuleDefinitions';
 import { keys } from './Keys';
+import * as core from '../../index';
 
-export function ScanFlows(flows: Flow[], rulesConfig?: Map<string, {}>): ScanResult[] {
+export function ScanFlows(flows: core.Flow[], rulesConfig?: Map<string, {}>): core.ScanResult[] {
 
-  const flowResults: ScanResult[] = [];
+  const flowResults: core.ScanResult[] = [];
   let selectedRules: IRuleDefinition[] = [];
   if (rulesConfig) {
     selectedRules = GetRuleDefinitions(rulesConfig);
@@ -18,7 +16,7 @@ export function ScanFlows(flows: Flow[], rulesConfig?: Map<string, {}>): ScanRes
   for (const flow of flows) {
 
     try{
-      const ruleResults: RuleResult[] = [];
+      const ruleResults: core.RuleResult[] = [];
       for (const rule of selectedRules) {
         if (rule.supportedTypes.includes(flow.type[0])) {
           try {
@@ -39,7 +37,7 @@ export function ScanFlows(flows: Flow[], rulesConfig?: Map<string, {}>): ScanRes
           }
         }
       }
-      flowResults.push(new ScanResult(flow, ruleResults));
+      flowResults.push(new core.ScanResult(flow, ruleResults));
     }
     catch (error) { 
       console.log(error.message)

src/main/models/Flow.ts

@@ -4,7 +4,7 @@ import { FlowElement } from './FlowElement';
 import { FlowVariable } from './FlowVariable';
 import * as p from 'path';
 
-export class Flow {
+export default class Flow {
 
   public label: string;
   public xmldata;