Rename issue to alert

Author: jdalton

src/shadow/arborist.ts

@@ -26,7 +26,7 @@ import {
   rootPath
 } from '../constants'
 import { ColorOrMarkdown } from '../utils/color-or-markdown'
-import { createAlertUXLookup } from '../utils/issue-rules'
+import { createAlertUXLookup } from '../utils/alert-rules'
 import { isErrnoException } from '../utils/misc'
 import { findRoot } from '../utils/path-resolve'
 import { getDefaultKey, setupSdk } from '../utils/sdk'
@@ -43,6 +43,12 @@ import type {
 import type { Writable } from 'node:stream'
 import type { AliasResult, RegistryResult } from 'npm-package-arg'
 
+type AlertUxLookup = ReturnType<typeof createAlertUXLookup>
+
+type AlertUxLookupSettings = Parameters<AlertUxLookup>[0]
+
+type AlertUxLookupResult = ReturnType<AlertUxLookup>
+
 type ArboristClass = typeof BaseArborist & {
   new (...args: any): typeof BaseArborist
 }
@@ -88,12 +94,6 @@ type InstallEffect = {
   existing?: NodeClass['pkgid'] | undefined
 }
 
-type IssueUXLookup = ReturnType<typeof createAlertUXLookup>
-
-type IssueUXLookupSettings = Parameters<IssueUXLookup>[0]
-
-type IssueUXLookupResult = ReturnType<IssueUXLookup>
-
 type NodeClass = Omit<
   BaseNode,
   'edgesIn' | 'edgesOut' | 'from' | 'isTop' | 'parent' | 'resolve' | 'root'
@@ -314,11 +314,11 @@ const pubToken = getDefaultKey() ?? SOCKET_PUBLIC_API_KEY
 
 const ttyServer = createTTYServer(isInteractive({ stream: process.stdin }), log)
 
-let _uxLookup: IssueUXLookup | undefined
+let _uxLookup: AlertUxLookup | undefined
 
 async function uxLookup(
-  settings: IssueUXLookupSettings
-): Promise<IssueUXLookupResult> {
+  settings: AlertUxLookupSettings
+): Promise<AlertUxLookupResult> {
   while (_uxLookup === undefined) {
     // eslint-disable-next-line no-await-in-loop
     await wait(1, { signal: abortSignal })

src/utils/issue-rules.ts renamed to src/utils/alert-rules.ts

@@ -19,7 +19,7 @@ const ERROR_UX: RuleActionUX = {
 }
 //#endregion
 //#region utils
-type NonNormalizedIssueRule =
+type NonNormalizedRule =
   | NonNullable<
       NonNullable<
         NonNullable<
@@ -30,7 +30,7 @@ type NonNormalizedIssueRule =
       >
     >[string]
   | boolean
-type NonNormalizedResolvedIssueRule =
+type NonNormalizedResolvedRule =
   | (NonNullable<
       NonNullable<
         (SocketSdkResultType<'postSettings'> & {
@@ -45,9 +45,9 @@ type NonNormalizedResolvedIssueRule =
  * all issue rules and finds the first defined value that does not defer otherwise
  * uses the defaultValue. Takes the value and converts into a UX workflow
  */
-function resolveIssueRuleUX(
-  entriesOrderedIssueRules: Iterable<Iterable<NonNormalizedIssueRule>>,
-  defaultValue: NonNormalizedResolvedIssueRule
+function resolveAlertRuleUX(
+  orderedRulesCollection: Iterable<Iterable<NonNormalizedRule>>,
+  defaultValue: NonNormalizedResolvedRule
 ): RuleActionUX {
   if (defaultValue === true || defaultValue == null) {
     defaultValue = { action: 'error' }
@@ -57,9 +57,9 @@ function resolveIssueRuleUX(
   let block = false
   let display = false
   let needDefault = true
-  iterate_entries: for (const issueRuleArr of entriesOrderedIssueRules) {
-    for (const rule of issueRuleArr) {
-      if (issueRuleValueDoesNotDefer(rule)) {
+  iterate_entries: for (const rules of orderedRulesCollection) {
+    for (const rule of rules) {
+      if (ruleValueDoesNotDefer(rule)) {
         needDefault = false
         const narrowingFilter = uxForDefinedNonDeferValue(rule)
         block = block || narrowingFilter.block
@@ -82,13 +82,13 @@ function resolveIssueRuleUX(
 /**
  * Negative form because it is narrowing the type
  */
-function issueRuleValueDoesNotDefer(
-  issueRule: NonNormalizedIssueRule
-): issueRule is NonNormalizedResolvedIssueRule {
-  if (issueRule === undefined) {
+function ruleValueDoesNotDefer(
+  rule: NonNormalizedRule
+): rule is NonNormalizedResolvedRule {
+  if (rule === undefined) {
     return false
-  } else if (issueRule !== null && typeof issueRule === 'object') {
-    const { action } = issueRule
+  } else if (rule !== null && typeof rule === 'object') {
+    const { action } = rule
     if (action === undefined || action === 'defer') {
       return false
     }
@@ -100,12 +100,12 @@ function issueRuleValueDoesNotDefer(
  * Handles booleans for backwards compatibility
  */
 function uxForDefinedNonDeferValue(
-  issueRuleValue: NonNormalizedResolvedIssueRule
+  ruleValue: NonNormalizedResolvedRule
 ): RuleActionUX {
-  if (typeof issueRuleValue === 'boolean') {
-    return issueRuleValue ? ERROR_UX : IGNORE_UX
+  if (typeof ruleValue === 'boolean') {
+    return ruleValue ? ERROR_UX : IGNORE_UX
   }
-  const { action } = issueRuleValue
+  const { action } = ruleValue
   if (action === 'warn') {
     return WARN_UX
   } else if (action === 'ignore') {
@@ -134,9 +134,9 @@ export function createAlertUXLookup(
     if (ux) {
       return ux
     }
-    const entriesOrderedIssueRules: Array<Array<NonNormalizedIssueRule>> = []
+    const orderedRulesCollection: Array<Array<NonNormalizedRule>> = []
     for (const settingsEntry of settings.entries) {
-      const orderedIssueRules: Array<NonNormalizedIssueRule> = []
+      const orderedRules: NonNormalizedRule[] = []
       let target = settingsEntry.start
       while (target !== null) {
         const resolvedTarget = settingsEntry.settings[target]
@@ -145,25 +145,25 @@ export function createAlertUXLookup(
         }
         const issueRuleValue = resolvedTarget.issueRules?.[type]
         if (typeof issueRuleValue !== 'undefined') {
-          orderedIssueRules.push(issueRuleValue)
+          orderedRules.push(issueRuleValue)
         }
         target = resolvedTarget.deferTo ?? null
       }
-      entriesOrderedIssueRules.push(orderedIssueRules)
+      orderedRulesCollection.push(orderedRules)
     }
     const defaultValue = settings.defaults.issueRules[type] as
       | { action: 'error' | 'ignore' | 'warn' }
       | boolean
       | undefined
-    let resolvedDefaultValue: NonNormalizedResolvedIssueRule = {
+    let resolvedDefaultValue: NonNormalizedResolvedRule = {
       action: 'error'
     }
     if (defaultValue === false) {
       resolvedDefaultValue = { action: 'ignore' }
     } else if (defaultValue && defaultValue !== true) {
       resolvedDefaultValue = { action: defaultValue.action ?? 'error' }
     }
-    ux = resolveIssueRuleUX(entriesOrderedIssueRules, resolvedDefaultValue)
+    ux = resolveAlertRuleUX(orderedRulesCollection, resolvedDefaultValue)
     cachedUX.set(type, ux)
     return ux
   }

test/issue-rule-ux.test.ts renamed to test/alert-rule-ux.test.ts

@@ -1,9 +1,9 @@
 import assert from 'node:assert/strict'
 import { describe, it } from 'node:test'
 
-import { createAlertUXLookup } from '../src/utils/issue-rules'
+import { createAlertUXLookup } from '../src/utils/alert-rules'
 
-describe('Issue Rule UX', () => {
+describe('Alert Rule UX', () => {
   it('should properly defer', () => {
     const noEntriesLookup = createAlertUXLookup({
       defaults: {
@@ -14,7 +14,7 @@ describe('Issue Rule UX', () => {
           fromUndefinedAction: {
             action: 'warn'
           },
-          fromUndefinedIssueRule: {
+          fromUndefinedRule: {
             action: 'warn'
           },
           willError: {
@@ -123,7 +123,7 @@ describe('Issue Rule UX', () => {
           name: 'bar',
           version: '0.0.0'
         },
-        alert: { type: 'fromUndefinedIssueRule' }
+        alert: { type: 'fromUndefinedRule' }
       }),
       {
         block: false,