npm - @nordcraft/search - Versions diffs - 1.0.84 → 1.0.86 - Mend

@@ -15,7 +15,14 @@ export const duplicateWorkflowParameterRule: Rule<{ parameter: string }> = {
     const parameterNames = new Set<string>()
     value.parameters.forEach((p, i) => {
       if (parameterNames.has(p.name)) {
-        report([...path, 'parameters', i], { parameter: p.name })
+        report({
+          path: [...path, 'parameters', i],
+          info: {
+            title: 'Duplicate workflow parameter',
+            description: `Multiple parameters with the name **${p.name}** exist. Ensure parameter names are unique.`,
+          },
+          details: { parameter: p.name },
+        })
       }
       parameterNames.add(p.name)
     })

@@ -34,7 +34,14 @@ export const noPostNavigateAction: Rule<
     const actionIndex = Number(_actionIndex)
     if (actionIndex < actions.length - 1) {
       // If the action is not the last one in the array, report it
-      report(path, undefined, ['delete-following-actions'])
+      report({
+        path,
+        info: {
+          title: 'Avoid actions after "Go to URL" action',
+          description: `The "Go to URL" action should be the last action in a workflow, as subsequent actions might not be evaluated before the browser navigates to the new URL.`,
+        },
+        fixes: ['delete-following-actions'],
+      })
     }
   },
   fixes: {

@@ -77,6 +77,13 @@ export const noReferenceComponentWorkflowRule: Rule<{
       }
     }
-    report(path, { contextSubscribers, name: value.name })
+    report({
+      path,
+      info: {
+        title: 'Unused component workflow',
+        description: `**${value.name}** is never used by any workflow. Consider removing it.`,
+      },
+      details: { contextSubscribers, name: value.name },
+    })
   },
 }

@@ -25,9 +25,16 @@ export const unknownContextProviderWorkflowRule: Rule<{
     }
     for (const workflowName of value.workflows) {
       if (component.workflows?.[workflowName]?.exposeInContext !== true) {
-        report(path, {
-          providerName: value.componentName,
-          workflowName,
+        report({
+          path,
+          info: {
+            title: 'Unknown context provider workflow',
+            description: `**${workflowName}** does not exist on the context provider **${value.componentName}**. Calling an unknown workflow will have no effect. Make sure to define it before using it.`,
+          },
+          details: {
+            providerName: value.componentName,
+            workflowName,
+          },
         })
       }
     }

@@ -22,9 +22,16 @@ export const unknownContextWorkflowRule: Rule<{
       return
     }
-    report(path, {
-      providerName: value.contextProvider,
-      workflowName: value.workflow,
+    report({
+      path,
+      info: {
+        title: 'Unknown context workflow',
+        description: `**${value.workflow}** is not subscribed. Make sure to subscribe to it in the component context section before using it.`,
+      },
+      details: {
+        providerName: value.contextProvider,
+        workflowName: value.workflow,
+      },
     })
   },
 }

@@ -45,8 +45,15 @@ export const unknownTriggerWorkflowParameterRule: Rule<{ parameter: string }> =
       )
       Object.keys(value.parameters ?? {}).forEach((parameterKey) => {
         if (!workflowParameters.has(parameterKey)) {
-          report([...path, 'parameters', parameterKey], {
-            parameter: parameterKey,
+          report({
+            path: [...path, 'parameters', parameterKey],
+            info: {
+              title: `Unknown parameter in workflow`,
+              description: `The workflow parameter "${parameterKey}" is not a valid. It may have been removed from the workflow after it was set. This parameter can safely be removed.`,
+            },
+            details: {
+              parameter: parameterKey,
+            },
           })
         }
       })

@@ -16,7 +16,13 @@ export const unknownTriggerWorkflowRule: Rule<void> = {
     const workflow = args.component.workflows?.[value.workflow]
     if (!workflow) {
-      report(path)
+      report({
+        path,
+        info: {
+          title: 'Unknown workflow trigger',
+          description: `This workflow does not exist and cannot be triggered.`,
+        },
+      })
     }
   },
 }

@@ -30,8 +30,15 @@ export const unknownWorkflowParameterRule: Rule<{ parameter: string }> = {
       ),
     )
     if (!workflowParameters.has(parameterName)) {
-      report(path, {
-        parameter: parameterName,
+      report({
+        path,
+        info: {
+          title: 'Unknown workflow parameter',
+          description: `**${parameterName}** does not exist in this workflow.`,
+        },
+        details: {
+          parameter: parameterName,
+        },
       })
     }
   },

@@ -272,7 +272,7 @@ function* visitNode({
       console.timeStamp(`Visiting rule ${rule.code}`)
       rule.visit(
         // Report callback used to report issues
-        (path, details, fixes) => {
+        ({ path, details, fixes, info }) => {
           if (fixOptions) {
             // We're in "fix mode"
             if (
@@ -301,6 +301,7 @@ function* visitNode({
               path,
               details,
               fixes,
+              info,
             })
           }
         },

@@ -157,6 +157,7 @@ export type Result = {
   level: Level
   details?: any
   fixes?: FixType[]
+  info: ReportedIssueInfo
 }
 export interface ApplicationCookie {
@@ -460,6 +461,11 @@ export type FixType =
   | UnknownApiServiceRuleFix
   | UnknownComponentAttributeRuleFix
+interface ReportedIssueInfo {
+  title: string
+  description: string
+}
 export interface Rule<
   T = unknown,
   V extends NodeType = NodeType,
@@ -469,7 +475,12 @@ export interface Rule<
   code: Code
   level: Level
   visit: (
-    report: (path: (string | number)[], details?: T, fixes?: FixType[]) => void,
+    report: (args: {
+      path: (string | number)[]
+      info: ReportedIssueInfo
+      details?: T
+      fixes?: FixType[]
+    }) => void,
     data: V,
     state?: ApplicationState | undefined,
   ) => void

@nordcraft/search 1.0.84 → 1.0.86