Skip to content

docs: fix up some diffs #261

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
43081j merged 1 commit into from
Nov 12, 2025
Merged

docs: fix up some diffs #261

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions docs/modules/read-pkg-up.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ description: Modern alternatives to the read-pkg-up package for reading package.
For example:

```ts
import { readPackageJSON } from 'pkg-types' // [!code ++]
import { readPackageUp } from 'read-pkg-up' // [!code --]
import { readPackageJSON } from 'pkg-types' // [!code ++]

const packageJson = await readPackageUp() // [!code --]
const packageJson = await readPackageJSON() // [!code ++]
const packageJson = await readPackageUp() // [!code --]
```

Similarly, you can get hold of the path via `resolvePackageJSON`:
Expand All @@ -33,9 +33,9 @@ const packageJsonPath = await resolvePackageJSON()
It can be combined with `node:fs` to read `package.json` files:

```ts
import { readPackageUp } from 'read-pkg-up' // [!code --]
import fs from 'node:fs/promises' // [!code ++]
import * as pkg from 'empathic' // [!code ++]
import { readPackageUp } from 'read-pkg-up' // [!code --]

const packageJson = await readPackageUp() // [!code --]
const packageJsonPath = pkg.up() // [!code ++]
Expand Down