Merge pull request #7199 from Shopify/fix-eslint-config

Fix eslint config

Author: gonzaloriestra

packages/cli/project.json

@@ -37,14 +37,14 @@
     "lint": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "pnpm eslint \"src/**/*.ts\" 'bin/*.js' ",
+        "command": "pnpm eslint src 'bin/*.js'",
         "cwd": "packages/cli"
       }
     },
     "lint:fix": {
       "executor": "nx:run-commands",
       "options": {
-        "command": "pnpm eslint 'src/**/*.ts' 'bin/*.js' --fix",
+        "command": "pnpm eslint src 'bin/*.js' --fix",
         "cwd": "packages/cli"
       }
     },

packages/cli/src/cli/commands/docs/generate.ts

@@ -90,7 +90,6 @@ export async function writeCommandDocumentation(
   const previewDescription = command.summary ?? description ?? ''
   const cleanPreview = previewDescription.replace(/`/g, '\\`').replace(/https:\/\/shopify\.dev/g, '')
 
-  // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
   const category = hasTopic && !generalTopics.includes(topic!) ? topic : 'general commands'
 
   const docString = `// This is an autogenerated file. Don't edit this file manually.
@@ -139,7 +138,7 @@ export async function writeCommandFlagInterface(
       const flag = command.flags[flagName]
       if (!flag) return
       if (flag.hidden) return
-      const flagDescription = flag.description || ''
+      const flagDescription = flag.description ?? ''
       const char = flag.char ? `-${flag.char}, ` : ''
       const type = flag.type === 'option' ? 'string' : "''"
       const value = flag.type === 'option' ? ' <value>' : ''

packages/cli/src/cli/commands/store/auth.test.ts

@@ -1,18 +1,14 @@
-import {beforeEach, describe, expect, test, vi} from 'vitest'
 import StoreAuth from './auth.js'
 import {authenticateStoreWithApp} from '../../services/store/auth/index.js'
 import {createStoreAuthPresenter} from '../../services/store/auth/result.js'
+import {describe, expect, test, vi} from 'vitest'
 
 vi.mock('../../services/store/auth/index.js')
 vi.mock('../../services/store/auth/result.js', () => ({
   createStoreAuthPresenter: vi.fn((format: 'text' | 'json') => ({format})),
 }))
 
 describe('store auth command', () => {
-  beforeEach(() => {
-    vi.clearAllMocks()
-  })
-
   test('passes parsed flags through to the auth service', async () => {
     await StoreAuth.run(['--store', 'shop.myshopify.com', '--scopes', 'read_products,write_products'])
 

packages/cli/src/cli/commands/store/auth.ts

@@ -1,9 +1,9 @@
+import {authenticateStoreWithApp} from '../../services/store/auth/index.js'
+import {createStoreAuthPresenter} from '../../services/store/auth/result.js'
 import Command from '@shopify/cli-kit/node/base-command'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 import {Flags} from '@oclif/core'
-import {authenticateStoreWithApp} from '../../services/store/auth/index.js'
-import {createStoreAuthPresenter} from '../../services/store/auth/result.js'
 
 export default class StoreAuth extends Command {
   static summary = 'Authenticate an app against a store for store commands.'

packages/cli/src/cli/commands/store/execute.test.ts

@@ -1,14 +1,13 @@
-import {beforeEach, describe, expect, test, vi} from 'vitest'
 import StoreExecute from './execute.js'
 import {executeStoreOperation} from '../../services/store/execute/index.js'
 import {writeOrOutputStoreExecuteResult} from '../../services/store/execute/result.js'
+import {beforeEach, describe, expect, test, vi} from 'vitest'
 
 vi.mock('../../services/store/execute/index.js')
 vi.mock('../../services/store/execute/result.js')
 
 describe('store execute command', () => {
   beforeEach(() => {
-    vi.clearAllMocks()
     vi.mocked(executeStoreOperation).mockResolvedValue({data: {shop: {name: 'Test shop'}}})
   })
 
@@ -24,11 +23,7 @@ describe('store execute command', () => {
       version: undefined,
       allowMutations: false,
     })
-    expect(writeOrOutputStoreExecuteResult).toHaveBeenCalledWith(
-      {data: {shop: {name: 'Test shop'}}},
-      undefined,
-      'text',
-    )
+    expect(writeOrOutputStoreExecuteResult).toHaveBeenCalledWith({data: {shop: {name: 'Test shop'}}}, undefined, 'text')
   })
 
   test('passes the query file through to the service', async () => {
@@ -46,11 +41,7 @@ describe('store execute command', () => {
   test('writes json output when --json is provided', async () => {
     await StoreExecute.run(['--store', 'shop.myshopify.com', '--query', 'query { shop { name } }', '--json'])
 
-    expect(writeOrOutputStoreExecuteResult).toHaveBeenCalledWith(
-      {data: {shop: {name: 'Test shop'}}},
-      undefined,
-      'json',
-    )
+    expect(writeOrOutputStoreExecuteResult).toHaveBeenCalledWith({data: {shop: {name: 'Test shop'}}}, undefined, 'json')
   })
 
   test('defines the expected flags', () => {

packages/cli/src/cli/commands/store/execute.ts

@@ -1,10 +1,10 @@
+import {executeStoreOperation} from '../../services/store/execute/index.js'
+import {writeOrOutputStoreExecuteResult} from '../../services/store/execute/result.js'
 import Command from '@shopify/cli-kit/node/base-command'
 import {globalFlags, jsonFlag} from '@shopify/cli-kit/node/cli'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 import {resolvePath} from '@shopify/cli-kit/node/path'
 import {Flags} from '@oclif/core'
-import {executeStoreOperation} from '../../services/store/execute/index.js'
-import {writeOrOutputStoreExecuteResult} from '../../services/store/execute/result.js'
 
 export default class StoreExecute extends Command {
   static summary = 'Execute GraphQL queries and mutations on a store.'

packages/cli/src/cli/services/kitchen-sink/static.ts

@@ -35,7 +35,7 @@ export async function staticService() {
   })
 
   renderInfo({
-    headline: 'About your app',
+    headline: 'About your app.',
     customSections: [
       {
         body: {

packages/cli/src/cli/services/store/auth/callback.test.ts

@@ -1,9 +1,9 @@
-import {createServer} from 'http'
-import {describe, expect, test} from 'vitest'
 import {waitForStoreAuthCode} from './callback.js'
+import {describe, expect, test} from 'vitest'
+import {createServer} from 'http'
 
 async function getAvailablePort(): Promise<number> {
-  return await new Promise<number>((resolve, reject) => {
+  return new Promise<number>((resolve, reject) => {
     const server = createServer()
 
     server.on('error', reject)
@@ -26,12 +26,7 @@ async function getAvailablePort(): Promise<number> {
   })
 }
 
-function callbackParams(options?: {
-  code?: string
-  shop?: string
-  state?: string
-  error?: string
-}): URLSearchParams {
+function callbackParams(options?: {code?: string; shop?: string; state?: string; error?: string}): URLSearchParams {
   const params = new URLSearchParams()
   params.set('shop', options?.shop ?? 'shop.myshopify.com')
   params.set('state', options?.state ?? 'state-123')
@@ -101,7 +96,8 @@ describe('store auth callback server', () => {
       }),
     ).rejects.toMatchObject({
       message: 'OAuth callback store does not match the requested store.',
-      tryMessage: 'Shopify returned other-shop.myshopify.com during authentication. Re-run using the permanent store domain:',
+      tryMessage:
+        'Shopify returned other-shop.myshopify.com during authentication. Re-run using the permanent store domain:',
       nextSteps: [[{command: 'shopify store auth --store other-shop.myshopify.com --scopes <comma-separated-scopes>'}]],
     })
   })

packages/cli/src/cli/services/store/auth/callback.ts

@@ -1,10 +1,10 @@
+import {STORE_AUTH_CALLBACK_PATH, maskToken} from './config.js'
+import {retryStoreAuthWithPermanentDomainError} from './recovery.js'
 import {normalizeStoreFqdn} from '@shopify/cli-kit/node/context/fqdn'
 import {AbortError} from '@shopify/cli-kit/node/error'
 import {outputContent, outputDebug, outputToken} from '@shopify/cli-kit/node/output'
 import {timingSafeEqual} from 'crypto'
 import {createServer} from 'http'
-import {STORE_AUTH_CALLBACK_PATH, maskToken} from './config.js'
-import {retryStoreAuthWithPermanentDomainError} from './recovery.js'
 
 export interface WaitForAuthCodeOptions {
   store: string
@@ -15,16 +15,8 @@ export interface WaitForAuthCodeOptions {
 }
 
 function renderAuthCallbackPage(title: string, message: string): string {
-  const safeTitle = title
-    .replace(/&/g, '&')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
-  const safeMessage = message
-    .replace(/&/g, '&amp;')
-    .replace(/</g, '&lt;')
-    .replace(/>/g, '&gt;')
-    .replace(/"/g, '&quot;')
+  const safeTitle = title.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;')
+  const safeMessage = message.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;')
 
   return `<!doctype html>
 <html lang="en">
@@ -120,7 +112,9 @@ export async function waitForStoreAuthCode({
       res.setHeader('Content-Type', 'text/html')
       res.setHeader('Connection', 'close')
       res.once('finish', () => settle(() => resolve(code)))
-      res.end(renderAuthCallbackPage('Authentication succeeded', 'You can close this window and return to the terminal.'))
+      res.end(
+        renderAuthCallbackPage('Authentication succeeded', 'You can close this window and return to the terminal.'),
+      )
     })
 
     const settle = (callback: () => void) => {
@@ -162,24 +156,22 @@ export async function waitForStoreAuthCode({
       settleWithError(error)
     })
 
-    server.listen(port, '127.0.0.1', async () => {
+    server.listen(port, '127.0.0.1', () => {
       isListening = true
       outputDebug(
         outputContent`PKCE callback server listening on http://127.0.0.1:${outputToken.raw(String(port))}${outputToken.raw(STORE_AUTH_CALLBACK_PATH)}`,
       )
 
       if (!onListening) return
 
-      try {
-        await onListening()
-      } catch (error) {
+      Promise.resolve(onListening()).catch((error: unknown) => {
         settleWithError(error instanceof Error ? error : new Error(String(error)))
-      }
+      })
     })
   })
 }
 
-function constantTimeEqual(a: string, b: string): boolean {
-  if (a.length !== b.length) return false
-  return timingSafeEqual(Buffer.from(a, 'utf8'), Buffer.from(b, 'utf8'))
+function constantTimeEqual(left: string, right: string): boolean {
+  if (left.length !== right.length) return false
+  return timingSafeEqual(Buffer.from(left, 'utf8'), Buffer.from(right, 'utf8'))
 }

packages/cli/src/cli/services/store/auth/existing-scopes.test.ts

@@ -1,17 +1,19 @@
-import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'
-import {adminUrl} from '@shopify/cli-kit/node/api/admin'
-import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql'
-import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'
 import {STORE_AUTH_APP_CLIENT_ID} from './config.js'
 import {resolveExistingStoreAuthScopes} from './existing-scopes.js'
 import {loadStoredStoreSession} from './session-lifecycle.js'
 import {getCurrentStoredStoreAppSession} from './session-store.js'
+import {afterEach, beforeEach, describe, expect, test, vi} from 'vitest'
+import {adminUrl} from '@shopify/cli-kit/node/api/admin'
+import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql'
+import {mockAndCaptureOutput} from '@shopify/cli-kit/node/testing/output'
 
 vi.mock('./session-store.js')
 vi.mock('./session-lifecycle.js', () => ({loadStoredStoreSession: vi.fn()}))
 vi.mock('@shopify/cli-kit/node/api/graphql')
 vi.mock('@shopify/cli-kit/node/api/admin', async () => {
-  const actual = await vi.importActual<typeof import('@shopify/cli-kit/node/api/admin')>('@shopify/cli-kit/node/api/admin')
+  const actual = await vi.importActual<typeof import('@shopify/cli-kit/node/api/admin')>(
+    '@shopify/cli-kit/node/api/admin',
+  )
   return {
     ...actual,
     adminUrl: vi.fn(),
@@ -20,19 +22,20 @@ vi.mock('@shopify/cli-kit/node/api/admin', async () => {
 
 describe('resolveExistingStoreAuthScopes', () => {
   beforeEach(() => {
-    vi.clearAllMocks()
     vi.mocked(adminUrl).mockReturnValue('https://shop.myshopify.com/admin/api/unstable/graphql.json')
   })
 
   afterEach(() => {
-    vi.restoreAllMocks()
     mockAndCaptureOutput().clear()
   })
 
   test('returns no scopes when no stored auth exists', async () => {
     vi.mocked(getCurrentStoredStoreAppSession).mockReturnValue(undefined)
 
-    await expect(resolveExistingStoreAuthScopes('shop.myshopify.com')).resolves.toEqual({scopes: [], authoritative: true})
+    await expect(resolveExistingStoreAuthScopes('shop.myshopify.com')).resolves.toEqual({
+      scopes: [],
+      authoritative: true,
+    })
     expect(loadStoredStoreSession).not.toHaveBeenCalled()
     expect(graphqlRequest).not.toHaveBeenCalled()
   })
@@ -120,7 +123,8 @@ describe('resolveExistingStoreAuthScopes', () => {
         errors: '[API] Invalid API key or access token (unrecognized login or wrong password)',
       },
       request: {
-        query: '#graphql query CurrentAppInstallationAccessScopes { currentAppInstallation { accessScopes { handle } } }',
+        query:
+          '#graphql query CurrentAppInstallationAccessScopes { currentAppInstallation { accessScopes { handle } } }',
       },
     })
     vi.mocked(graphqlRequest).mockRejectedValue(scopeLookupError)
@@ -129,7 +133,9 @@ describe('resolveExistingStoreAuthScopes', () => {
       scopes: ['read_orders'],
       authoritative: false,
     })
-    expect(output.debug()).toContain('after remote scope lookup failed: HTTP 401: [API] Invalid API key or access token')
+    expect(output.debug()).toContain(
+      'after remote scope lookup failed: HTTP 401: [API] Invalid API key or access token',
+    )
     expect(output.debug()).not.toContain('CurrentAppInstallationAccessScopes')
   })