Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions packages/app/src/cli/commands/app/config/link.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
import ConfigLink from './link.js'
import link from '../../../services/app/config/link.js'
import {linkedAppContext} from '../../../services/app-context.js'
import {testAppLinked, testOrganizationApp} from '../../../models/app/app.test-data.js'
import {inTemporaryDirectory} from '@shopify/cli-kit/node/fs'
import {describe, expect, test, vi} from 'vitest'

vi.mock('../../../services/app/config/link.js')
vi.mock('../../../services/app-context.js')

describe('app config link command', () => {
test('accepts --client-id with --config to link a specific app to a specific config file', async () => {
await inTemporaryDirectory(async (tmp) => {
const app = testAppLinked()
vi.mocked(link).mockResolvedValue({
remoteApp: testOrganizationApp(),
configFileName: 'shopify.app.staging.toml',
configuration: app.configuration,
})
vi.mocked(linkedAppContext).mockResolvedValue({app} as Awaited<ReturnType<typeof linkedAppContext>>)

await ConfigLink.run(['--path', tmp, '--client-id', 'api-key', '--config', 'staging'], import.meta.url)

expect(link).toHaveBeenCalledWith({
directory: tmp,
apiKey: 'api-key',
configName: 'staging',
})
expect(linkedAppContext).toHaveBeenCalledWith({
directory: tmp,
clientId: undefined,
forceRelink: false,
userProvidedConfigName: 'shopify.app.staging.toml',
})
})
})
})
6 changes: 6 additions & 0 deletions packages/app/src/cli/commands/app/config/link.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import {linkedAppContext} from '../../../services/app-context.js'
import link, {LinkOptions} from '../../../services/app/config/link.js'
import AppLinkedCommand, {AppLinkedCommandOutput} from '../../../utilities/app-linked-command.js'
import {globalFlags} from '@shopify/cli-kit/node/cli'
import {Flags} from '@oclif/core'

export default class ConfigLink extends AppLinkedCommand {
static summary = 'Fetch your app configuration from the Developer Dashboard.'
Expand All @@ -17,6 +18,11 @@ export default class ConfigLink extends AppLinkedCommand {
static flags = {
...globalFlags,
...appFlags,
'client-id': Flags.string({
hidden: false,
description: 'The Client ID of your app.',
env: 'SHOPIFY_FLAG_CLIENT_ID',
}),
}

public async run(): Promise<AppLinkedCommandOutput> {
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ Fetch your app configuration from the Developer Dashboard.

```
USAGE
$ shopify app config link [--client-id <value> | -c <value>] [--no-color] [--path <value>] [--reset | ] [--verbose]
$ shopify app config link [--client-id <value>] [--no-color] [--path <value>] [--reset | -c <value>] [--verbose]

FLAGS
-c, --config=<value> [env: SHOPIFY_FLAG_APP_CONFIG] The name of the app configuration.
Expand Down
3 changes: 0 additions & 3 deletions packages/cli/oclif.manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -442,9 +442,6 @@
"client-id": {
"description": "The Client ID of your app.",
"env": "SHOPIFY_FLAG_CLIENT_ID",
"exclusive": [
"config"
],
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
Expand Down
Loading