posargs for script commands

[bigjools]

Hey everyone, I just started using Hatch and it looks fantastic, so I'm using it to replace tox in my project.

One thing I used tox a lot for was running commands in the context of the virtualenv, but tox made it easy to pass positional args directly from the CLI by declaring {posargs} in the command to execute. I could not find anything similar in the Hatch docs at https://hatch.pypa.io/latest/config/environment/overview/#scripts.

For example in the docs we have:

[tool.hatch.envs.test.scripts]
run-coverage = "pytest --cov-config=pyproject.toml --cov=pkg --cov=tests"

I'd like to be able to invoke
hatch run run-coverage foobar
Which would end up executing:
run-coverage = "pytest --cov-config=pyproject.toml --cov=pkg --cov=tests foobar"

[ischaojie]

Try this:

[tool.hatch.envs.test.scripts]
run-coverage = "pytest --cov-config=pyproject.toml --cov=pkg --cov=tests {args}"

[bigjools]

It's not mentioned at all in the first link, which is where I would expect to find it. The latter is not very discoverable in this context.

[ofek]

I'm not sure if it's rendering the same for you but the first link has a link to the second one in the first part with the words "Context formatting"

[bigjools]

Sorry I don't think I am explaining myself very well.

As a new user, I would never know to click "Context formatting" to get what I need as that means nothing to me. There's a bunch of examples just below, which is what I was using to drive my understanding and as that new user I'd really expect to see this {args} parameter there. In fact, given the help text for "args" says For executed commands only I'd really, really, expect to see it as a scripts example or further documentation right there.

Anyway, as I say, I'm just coming at this very fresh and recounting my experience in that context. I know from my own projects that you can get a bit snow blind to things where you're already very familiar. If you want to take my advice, that's fine, as is ignoring it, I'm just trying to be helpful.

Cheers.

[ofek]

Oh that makes more sense. I'll add an example there, thanks!

[bigjools]

Great! And thanks for this project, loving what I am seeing so far.