@nordcraft/search 1.0.43 → 1.0.45

package/src/rules/apis/noReferenceApiRule.ts

@@ -1,4 +1,5 @@
 import type { Rule } from '../../types'
+import { removeFromPathFix } from '../../util/removeUnused.fix'
 
 export const noReferenceApiRule: Rule<void> = {
   code: 'no-reference api',
@@ -8,7 +9,8 @@ export const noReferenceApiRule: Rule<void> = {
     if (args.nodeType !== 'component-api') {
       return
     }
-    const { path, value, memo, component } = args
+    const { value, memo, component } = args
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     if (!component) {
       return
     }
@@ -37,6 +39,11 @@ export const noReferenceApiRule: Rule<void> = {
     if (componentApiReferences.has(value.name)) {
       return
     }
-    report(path)
+    report(args.path, undefined, ['delete-api'])
+  },
+  fixes: {
+    'delete-api': removeFromPathFix,
   },
 }
+
+export type NoReferenceApiRuleFix = 'delete-api'

package/src/rules/attributes/noReferenceAttributeRule.test.ts

@@ -1,8 +1,10 @@
+import type { ProjectFiles } from '@nordcraft/ssr/dist/ssr.types'
 import { describe, expect, test } from 'bun:test'
+import { fixProject } from '../../fixProject'
 import { searchProject } from '../../searchProject'
 import { noReferenceAttributeRule } from './noReferenceAttributeRule'
 
-describe('noReferenceAttributeRule', () => {
+describe('find noReferenceAttributeRule', () => {
   test('should detect attributes with no references', () => {
     const problems = Array.from(
       searchProject({
@@ -137,3 +139,35 @@ describe('noReferenceAttributeRule', () => {
     expect(problems).toEqual([])
   })
 })
+
+describe('fix noReferenceAttributeRule', () => {
+  test('should remove attributes with no references', () => {
+    const files: ProjectFiles = {
+      formulas: {},
+      components: {
+        test: {
+          name: 'test',
+          nodes: {},
+          formulas: {},
+          apis: {},
+          attributes: {
+            'my-attribute': {
+              name: 'my-attribute-name',
+              testValue: { type: 'value', value: null },
+              '@nordcraft/metadata': {
+                comments: null,
+              },
+            },
+          },
+          variables: {},
+        },
+      },
+    }
+    const fixedFiles = fixProject({
+      files,
+      rule: noReferenceAttributeRule,
+      fixType: 'delete-attribute',
+    })
+    expect(fixedFiles.components['test']?.attributes).toEqual({})
+  })
+})

package/src/rules/attributes/noReferenceAttributeRule.ts

@@ -1,4 +1,5 @@
 import type { Rule } from '../../types'
+import { removeFromPathFix } from '../../util/removeUnused.fix'
 
 export const noReferenceAttributeRule: Rule<void> = {
   code: 'no-reference attribute',
@@ -26,7 +27,11 @@ export const noReferenceAttributeRule: Rule<void> = {
     if (attrs.has(attributeKey)) {
       return
     }
-
-    report(path)
+    report(args.path, undefined, ['delete-attribute'])
+  },
+  fixes: {
+    'delete-attribute': removeFromPathFix,
   },
 }
+
+export type NoReferenceAttributeRuleFix = 'delete-attribute'

package/src/rules/components/noReferenceComponentRule.ts

@@ -1,53 +1,42 @@
 import type { Component } from '@nordcraft/core/dist/component/component.types'
-import { omit } from '@nordcraft/core/dist/utils/collections'
 import { isDefined } from '@nordcraft/core/dist/utils/util'
-import type { ApplicationState, NodeType, Rule } from '../../types'
+import type { Rule } from '../../types'
+import { removeFromPathFix } from '../../util/removeUnused.fix'
 
 export const noReferenceComponentRule: Rule<void> = {
   code: 'no-reference component',
   level: 'warning',
   category: 'No References',
   visit: (report, data, state) => {
-    if (hasReferences(data, state)) {
+    if (
+      data.nodeType !== 'component' ||
+      isPage(data.value) ||
+      (state?.projectDetails?.type === 'package' &&
+        data.value.exported === true)
+    ) {
       return
     }
+    for (const component of Object.values(data.files.components)) {
+      // Enforce that the component is not undefined since we're iterating
+      for (const node of Object.values(component!.nodes ?? {})) {
+        if (
+          node.type === 'component' &&
+          node.name === data.value.name &&
+          // Circular references from a component to itself should
+          // not count as a reference
+          node.name !== component!.name
+        ) {
+          return
+        }
+      }
+    }
     report(data.path, undefined, ['delete-component'])
   },
   fixes: {
-    'delete-component': (data, state) => {
-      if (hasReferences(data, state)) {
-        return
-      }
-      return omit(data.files, data.path)
-    },
+    'delete-component': removeFromPathFix,
   },
 }
 
-const hasReferences = (data: NodeType, state?: ApplicationState) => {
-  if (
-    data.nodeType !== 'component' ||
-    isPage(data.value) ||
-    (state?.projectDetails?.type === 'package' && data.value.exported === true)
-  ) {
-    return true
-  }
-  for (const component of Object.values(data.files.components)) {
-    // Enforce that the component is not undefined since we're iterating
-    for (const node of Object.values(component!.nodes ?? {})) {
-      if (
-        node.type === 'component' &&
-        node.name === data.value.name &&
-        // Circular references from a component to itself should
-        // not count as a reference
-        node.name !== component!.name
-      ) {
-        return true
-      }
-    }
-  }
-  return false
-}
-
 export type NoReferenceComponentRuleFix = 'delete-component'
 
 const isPage = (

package/src/rules/events/duplicateEventTriggerRule.ts

@@ -10,8 +10,9 @@ export const duplicateEventTriggerRule: Rule<{ trigger: string }> = {
     }
     const eventTriggers = new Set<string>()
 
+    // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     Object.entries(value.events ?? {}).forEach(([key, event]) => {
-      if (typeof event.trigger !== 'string') {
+      if (typeof event?.trigger !== 'string') {
         return
       }
       if (eventTriggers.has(event.trigger)) {

package/src/rules/events/noReferenceEventRule.test.ts

@@ -1,9 +1,11 @@
 import { valueFormula } from '@nordcraft/core/dist/formula/formulaUtils'
+import type { ProjectFiles } from '@nordcraft/ssr/dist/ssr.types'
 import { describe, expect, test } from 'bun:test'
+import { fixProject } from '../../fixProject'
 import { searchProject } from '../../searchProject'
 import { noReferenceEventRule } from './noReferenceEventRule'
 
-describe('noReferenceEventRule', () => {
+describe('find noReferenceEventRule', () => {
   test('should detect events with no references', () => {
     const problems = Array.from(
       searchProject({
@@ -146,3 +148,59 @@ describe('noReferenceEventRule', () => {
     expect(problems).toEqual([])
   })
 })
+
+describe('fix noReferenceEventRule', () => {
+  test('should remove events with no references', () => {
+    const files: ProjectFiles = {
+      components: {
+        test: {
+          name: 'test',
+          nodes: {
+            root: {
+              type: 'element',
+              attrs: {},
+              classes: {},
+              events: {
+                click: {
+                  trigger: 'click',
+                  actions: [
+                    {
+                      type: 'TriggerEvent',
+                      event: 'unknown-event',
+                      data: valueFormula(null),
+                    },
+                  ],
+                },
+              },
+              tag: 'div',
+              children: [],
+              style: {},
+            },
+          },
+          formulas: {},
+          apis: {},
+          attributes: {},
+          variables: {},
+          events: [
+            {
+              name: 'unused-event',
+              // eslint-disable-next-line inclusive-language/use-inclusive-words
+              dummyEvent: {
+                name: 'Name',
+              },
+              '@nordcraft/metadata': {
+                comments: null,
+              },
+            },
+          ],
+        },
+      },
+    }
+    const fixedFiles = fixProject({
+      files,
+      rule: noReferenceEventRule,
+      fixType: 'delete-event',
+    })
+    expect(fixedFiles.components['test']?.events).toEqual([])
+  })
+})

package/src/rules/events/noReferenceEventRule.ts

@@ -1,5 +1,6 @@
 import type { Rule } from '../../types'
 import { isLegacyAction } from '../../util/helpers'
+import { removeFromPathFix } from '../../util/removeUnused.fix'
 
 export const noReferenceEventRule: Rule<{ name: string }> = {
   code: 'no-reference event',
@@ -9,7 +10,7 @@ export const noReferenceEventRule: Rule<{ name: string }> = {
     if (args.nodeType !== 'component-event') {
       return
     }
-    const { path, memo, value } = args
+    const { memo, value } = args
     const { component, event } = value
     const events = memo(`${component.name}-events`, () => {
       const events = new Set<string>()
@@ -40,7 +41,11 @@ export const noReferenceEventRule: Rule<{ name: string }> = {
     if (events.has(event.name)) {
       return
     }
-
-    report(path, { name: event.name })
+    report(args.path, { name: args.value.event.name }, ['delete-event'])
+  },
+  fixes: {
+    'delete-event': removeFromPathFix,
   },
 }
+
+export type NoReferenceEventRuleFix = 'delete-event'