@nordcraft/search 1.0.37 → 1.0.39

package/src/types.d.ts

@@ -21,6 +21,8 @@ import type {
   Route,
   ToddleProject,
 } from '@nordcraft/ssr/dist/ssr.types'
+import type { NoReferenceComponentRuleFix } from './rules/components/noReferenceComponentRule'
+import type { LegacyFormulaRuleFix } from './rules/formulas/legacyFormulaRule'
 
 type Code =
   | 'ambiguous style variable syntax'
@@ -106,6 +108,7 @@ export type Result = {
   category: Category
   level: Level
   details?: any
+  fixes?: FixType[]
 }
 
 interface ApplicationCookie {
@@ -239,9 +242,9 @@ type ComponentAttributeNode = {
   component: ToddleComponent<Function>
 } & Base
 
-type FormulaNode = {
+type FormulaNode<F = Formula> = {
   nodeType: 'formula'
-  value: Formula
+  value: F
   component?: ToddleComponent<Function>
 } & Base
 
@@ -308,13 +311,21 @@ export type NodeType =
   | ProjectRoute
   | StyleVariantNode
 
+type FixType = LegacyFormulaRuleFix | NoReferenceComponentRuleFix
+
 export interface Rule<T = unknown, V = NodeType> {
   category: Category
   code: Code
   level: Level
   visit: (
-    report: (path: (string | number)[], details?: T) => void,
+    report: (path: (string | number)[], details?: T, fixes?: FixType[]) => void,
     data: V,
     state?: ApplicationState | undefined,
   ) => void
+  fixes?: Partial<
+    Record<
+      FixType,
+      (data: V, state?: ApplicationState | undefined) => ProjectFiles | void
+    >
+  >
 }

package/src/util/helpers.test.ts

@@ -0,0 +1,80 @@
+import { describe, expect, test } from 'bun:test'
+import { shouldSearchExactPath, shouldVisitTree } from './helpers'
+
+describe('shouldSearchPath', () => {
+  test('should return true for paths in pathsToVisit', () => {
+    const pathsToVisit = [
+      ['components', 'Button'],
+      ['components', 'Input'],
+    ]
+    expect(
+      shouldVisitTree({
+        path: ['components', 'Button', 'attrs', 'attr1', 'testValue'],
+        pathsToVisit,
+      }),
+    ).toBe(true)
+    expect(
+      shouldVisitTree({ path: ['components', 'Input'], pathsToVisit }),
+    ).toBe(true)
+    expect(
+      shouldVisitTree({
+        path: ['components', 'Button', 'formulas'],
+        pathsToVisit,
+      }),
+    ).toBe(true)
+    expect(
+      shouldVisitTree({
+        path: ['components', 'project-sidebar-item'],
+        pathsToVisit: [
+          [
+            'components',
+            'project-sidebar-item',
+            'formulas',
+            'p_Z1PzOcDop79KGafQ7Lm',
+            'formula',
+          ],
+        ],
+      }),
+    ).toBe(true)
+  })
+
+  test('should return false for paths not in pathsToVisit', () => {
+    const pathsToVisit = [
+      ['components', 'Button'],
+      ['components', 'Input'],
+    ]
+    expect(
+      shouldVisitTree({ path: ['components', 'Card'], pathsToVisit }),
+    ).toBe(false)
+    expect(
+      shouldVisitTree({ path: ['components', 'Form'], pathsToVisit }),
+    ).toBe(false)
+  })
+})
+
+describe('shouldSearchExactPath', () => {
+  test.only('should only return true for exact matches', () => {
+    const pathsToVisit = [
+      ['components', 'Button'],
+      ['components', 'Input'],
+    ]
+    expect(
+      shouldSearchExactPath({ path: ['components', 'Button'], pathsToVisit }),
+    ).toBe(true)
+    expect(
+      shouldSearchExactPath({ path: ['components', 'Input'], pathsToVisit }),
+    ).toBe(true)
+    expect(
+      shouldSearchExactPath({
+        path: ['components', 'Button', 'formulas'],
+        pathsToVisit,
+      }),
+    ).toBe(false)
+    expect(
+      shouldSearchExactPath({
+        path: ['components', 'project-sidebar-item'],
+        pathsToVisit,
+      }),
+    ).toBe(false)
+  })
+})

package/src/util/helpers.ts

@@ -4,18 +4,46 @@ import type {
 } from '@nordcraft/core/dist/component/component.types'
 import { isDefined } from '@nordcraft/core/dist/utils/util'
 
-export function shouldSearchPath(
-  path: (string | number)[],
-  pathsToVisit: string[][] = [],
-) {
+/**
+ * Returns true if the full path is included in any of the pathsToVisit
+ * This allows searching only certain sub-trees in the files
+ * If pathsToVisit is empty, all paths are searched
+ */
+export function shouldVisitTree({
+  path,
+  pathsToVisit = [],
+}: {
+  path: (string | number)[]
+  pathsToVisit?: (string | number)[][]
+}) {
   return (
     pathsToVisit.length === 0 ||
     pathsToVisit.some((pathToVisit) =>
-      pathToVisit.every((p1, i) => path[i] === p1),
+      // Either the index is outside the current path (we are deeper in the tree)
+      // or the path matches on each index
+      pathToVisit.every((p1, i) => i >= path.length || path[i] === p1),
     )
   )
 }
 
+/**
+ * Returns true if the exact path is included in pathsToVisit
+ * This allows searching only certain nodes in the files
+ */
+export function shouldSearchExactPath({
+  path,
+  pathsToVisit,
+}: {
+  path: (string | number)[]
+  pathsToVisit: (string | number)[][]
+}) {
+  return pathsToVisit.some(
+    (pathToVisit) =>
+      path.length === pathToVisit.length &&
+      pathToVisit.every((p1, i) => path[i] === p1),
+  )
+}
+
 export const isLegacyAction = (model: ActionModel) => {
   switch (model.type) {
     case 'Custom':