Template strings have some parsing bugs

[I-Want-ToBelieve]

"zx": "^7.2.3"

// Define the signals
const signals = [
  { event: 'application_launched', label: 'yakite-application-launched', action: 'event application-launched --env YABAI_PROCESS_ID=$YABAI_PROCESS_ID' },
  { event: 'application_terminated', label: 'yakite-application-terminated', action: 'event application-terminated --env YABAI_PROCESS_ID=$YABAI_PROCESS_ID' }
]

  for (const { event, label, action } of signals) {
    console.log(`action=${action}`)  //  action=event application-launched --env YABAI_PROCESS_ID=$YABAI_PROCESS_ID
    $`action=${action}` // action=$'event application-launched --env YABAI_PROCESS_ID=$YABAI_PROCESS_ID'
  }

[I-Want-ToBelieve]

const cmd = `yabai -m signal --add event=${event} label=${label} action='${yakite} ${action}'`
$`sh -c ${cmd}`

work well

[ufondu88]

I am having issues with this problem.

const PR_TITLE = "Sample PR title"
const body = "Sample body"

try {
  await $`gh pr create --title=${PR_TITLE} --body=${body}`
} catch (error) {
  throw chalk.red(error.stderr);
}

will attempt to run this command

gh pr create --title=$'Sample PR title' --body=$'Sample body'

which is wrong.

Expected output:

gh pr create --title='Sample PR title' --body='Sample body'

Does anyone know of a fix for this?

[markrzen]

Test function

import { $ } from 'zx';

async function test(name) {
  await $`echo hello: ${name}`;
}

test('world'); // Produces `set -euo pipefail;echo hello: world`
test('not spaces'); // Produces `set -euo pipefail;echo hello: $'not spaces'`

[markrzen]

@antongolub Do you happen to know what the intention is behind the quote function? There are only two test cases and no docs, so any patch might move the function away from intention.

Update: I stand corrected, there is doc in the primary html docs
https://google.github.io/zx/quotes

[markrzen]

Well, I am proper confused now. The above, which was failing, is now passing, without any changes. 🤷🏻

[markrzen]

Found the issue again.

import { $, echo } from 'zx';

async function test(name) {
  const cmd = `echo hello: ${name}`;
  const { stdout } = await $`${cmd}`;
  echo(stdout);
}

test('john smith'); // Produces `set -euo pipefail;echo hello: $'john smith'`

[markrzen]

@antongolub OK, put in a PR. There are a few tests on main that don't seem to work on my machine, but the ones that flex this code are running, and I added a few additional.

#778

[antonmedv]

Please read: https://google.github.io/zx/quotes
Everything works as expected.

[antonmedv]

This is a correct behavior. More info at https://google.github.io/zx/quotes

[markrzen]

I read that document about 4 hours ago (as noted here #700 (reply in thread)).

I appreciate that I must have misunderstood the documentation, and that a conflict between the PR and the docs was made.

Before I spend more time on this use case, do you view it as valid?

import assert from 'node:assert'
import { $ }  from './build/core.js'

async function test() {
  const cmd = `echo /tmp/foo bar`
  assert.equal((await $`${cmd}`).stdout.trim(), path)
}

test()

[antonmedv]

NO. It's not valid. You should not specify cmd as a string. This is considered a bad practice which leads to security issue.

[markrzen]

Thank. Good luck.