Skip to content
Open
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
8 changes: 8 additions & 0 deletions js/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

### Fixed

- Allow `@riverqueue/cli` to install alongside TypeScript 7 by removing its TypeScript compiler peer dependency. Running migrations and benchmarks does not require a compiler.

### Removed

- Removed the `riverqueue codemod-0.1` upgrade command. Follow [migrating from 0.1](./docs/migrating-from-0.1.md) for before/after examples and changes that need manual review. `@riverqueue/cli@0.3.2` is the last release containing the command and requires TypeScript 5 or 6 to run it.

## [0.3.2] - 2026-11-09

### Fixed
Expand Down
22 changes: 11 additions & 11 deletions js/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,17 +149,17 @@ packages; it uses Node's built-in `node:sqlite`. See the

## Packages

| Package | Purpose |
| ---------------------------- | ------------------------------------------------------------------- |
| `riverqueue` | Job definitions, insertion, workers, runtime, queries, and events |
| `@riverqueue/driver-knex` | Insert jobs inside Knex transactions on Postgres |
| `@riverqueue/driver-pg` | Postgres through `node-postgres` |
| `@riverqueue/driver-prisma` | Insert jobs inside Prisma transactions |
| `@riverqueue/driver-sqlite` | SQLite through Node's built-in `node:sqlite` |
| `@riverqueue/migrate` | Postgres and SQLite migrations |
| `@riverqueue/worker-threads` | Run CPU-bound handlers on worker threads |
| `@riverqueue/test` | Test helpers for producers and workers |
| `@riverqueue/cli` | The `riverqueue` command: migrations, benchmarks, and a 0.1 codemod |
| Package | Purpose |
| ---------------------------- | ----------------------------------------------------------------- |
| `riverqueue` | Job definitions, insertion, workers, runtime, queries, and events |
| `@riverqueue/driver-knex` | Insert jobs inside Knex transactions on Postgres |
| `@riverqueue/driver-pg` | Postgres through `node-postgres` |
| `@riverqueue/driver-prisma` | Insert jobs inside Prisma transactions |
| `@riverqueue/driver-sqlite` | SQLite through Node's built-in `node:sqlite` |
| `@riverqueue/migrate` | Postgres and SQLite migrations |
| `@riverqueue/worker-threads` | Run CPU-bound handlers on worker threads |
| `@riverqueue/test` | Test helpers for producers and workers |
| `@riverqueue/cli` | The `riverqueue` command: migrations and benchmarks |

## Documentation

Expand Down
20 changes: 5 additions & 15 deletions js/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
# `@riverqueue/cli`

The `riverqueue` command runs River's database migrations and a throughput
benchmark, and upgrades code written for `riverqueue@0.1`. It requires Node.js
24 or newer.
benchmark. It requires Node.js 24 or newer.

```sh
npm install --save-dev @riverqueue/cli
Expand Down Expand Up @@ -62,18 +61,8 @@ Applications can also migrate from code with `@riverqueue/migrate`.

## Upgrading from riverqueue 0.1

`riverqueue codemod-0.1` rewrites code written for the `riverqueue@0.1`
client to the current API and marks what it cannot rewrite with
`TODO(riverqueue-0.1)` comments. It needs the `typescript` package, version 5
or 6, in the project:

```sh
npx riverqueue codemod-0.1 --write src
```

Without `--write` it reports what would change; `--check` exits with status 1
if any file would change. [Migrating from riverqueue 0.1][migrating]
describes what it rewrites and what it leaves for review.
See [Migrating from riverqueue 0.1][migrating] for before/after examples and
changes to review when upgrading an insert-only client.

[migrating]: https://github.com/riverqueue/river/blob/master/js/docs/migrating-from-0.1.md

Expand Down Expand Up @@ -153,7 +142,8 @@ must supply a global Temporal implementation, as with other River libraries.
On Node.js 24, [preload a polyfill](../README.md#temporal-on-nodejs-24) before
importing it. Programmatic imports never install a global.

The CLI installs its own matching `riverqueue` and database packages.
The CLI installs its own matching `riverqueue` and database packages. Running
its commands does not require a TypeScript compiler.

TypeScript users need TypeScript 6.0 or newer and `@types/node` and `@types/pg`,
with `"node"` listed in `compilerOptions.types`. See [River's
Expand Down
8 changes: 2 additions & 6 deletions js/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@riverqueue/cli",
"version": "0.3.2",
"description": "Command-line migrations, benchmarks, and upgrade codemods for River TypeScript.",
"description": "Command-line migrations and benchmarks for River TypeScript.",
"type": "module",
"sideEffects": [
"./dist/bin.js"
Expand Down Expand Up @@ -57,18 +57,14 @@
},
"peerDependencies": {
"@types/node": ">=24",
"@types/pg": ">=8",
"typescript": "^5.0.0 || ^6.0.0"
"@types/pg": ">=8"
},
"peerDependenciesMeta": {
"@types/node": {
"optional": true
},
"@types/pg": {
"optional": true
},
"typescript": {
"optional": true
}
},
"devDependencies": {
Expand Down
225 changes: 0 additions & 225 deletions js/cli/src/codemod-command.test.ts

This file was deleted.

Loading
Loading