Skip to content

Assorted README.md updates #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 27, 2025
Merged

Assorted README.md updates #36

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
aee425f
Update README.md examples to reflect the need for a "dependencies" key
YellowApple Feb 20, 2025
a95bee6
Remove outdated warning about env var command substitutions
YellowApple Feb 20, 2025
aed3caf
Missed a frontmatter fence
YellowApple Feb 20, 2025
9d0ce57
Update the "one-liner" example, too
YellowApple Feb 20, 2025
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
35 changes: 22 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,11 @@ We allow you to add YAML front matter to all files to specify versions more
precisely:

```toml
# ---
# pkgx:
# openssl.org: 1.1.1n
# dependencies:
# openssl.org: 1.1.1n
# ---

[package]
name = "my cargo project"
Expand All @@ -107,7 +110,10 @@ name = "my cargo project"
We allow more terse expressions including eg:

```toml
# pkgx: openssl.org@1.1.1n deno^2 npm
# ---
# pkgx:
# dependencies: openssl.org@1.1.1n deno^2 npm
# ---
```

The major exception being json since it doesn’t support comments, in this case
Expand All @@ -116,9 +122,11 @@ we read a special `pkgx` node:
```json
{
"pkgx": {
"openssl.org": "1.1.1n",
"deno": "^2",
"npm": null
"dependencies": {
"openssl.org": "1.1.1n",
"deno": "^2",
"npm": null
}
}
}
```
Expand All @@ -130,18 +138,19 @@ You can also make a `pkgx.yaml` file.
You can add your own environment variables if you like:

```toml
# ---
# pkgx:
# openssl.org: 1.1.1n
# env:
# MY_VAR: my-value
# dependencies:
# openssl.org: 1.1.1n
# env:
# MY_VAR: my-value
# ---
```

> [!CAUTION]
> [!NOTE]
>
> The assignment of these variables are run through the shell, so you can do
> stuff like `$(pwd)` if you like. Obviously, be careful with that—we don’t
> sanitize the input. We will accept a PR to escape this by default or something
> ∵ we agree this is maybe a bit insane.
> The environment variable's value is sanitized, so expressions like
> `MY_VAR: $(sudo rm -rf --no-preserve-root /)` will throw an error.

## `dev` & Editors

Expand Down