Skip to content

How to move forward with iovalkey and the valkey npm package #48

@marcbachmann

Description

@marcbachmann

As highlighted in issue #45, there has been some confusion in the ecosystem regarding the official Valkey client package.

Currently the official Valkey client is published as iovalkey on npm. That name was taken over to simplify the migration from ioredis to iovalkey.

There's a broken & abandoned package published as valkey that causes frustration for new users as new users search for valkey and try to use npm install valkey first.
Long term it's also a considerable security factor to have that module in control.

So far I've successfully acquired access to the valkey module on npm. (also matteo)
Therefore I'm creating this issue to discuss the next steps to clear the confusion about the modules. IMO the other issue can be closed to not disturb other people in the thread and to focus on the tasks ahead.

I think we have a few options:

  1. Deprecate valkey and just link to the other module in the readme. Clear all the content to prevent installs (maybe still contact npm to delete old versions)
  2. Migrate to the valkey package, while keeping the old module for a few releases. Either dual publish or just deprecate the iovalkey module.
  3. Migrate to the @valkey namespace and link both other modules to the new one. e.g. @valkey/client
  4. Dual publishing and keep both modules. (might still be confusing long-term)
  5. Create a wrapper package that re-exports everythng.

Both dual publishing and re-exporting requires multi step publish processes. Do we want to move forward with something like semantic-release to automate publishing.

In general I'd say option 2 is the most feasable. Considering the github repo is also named iovalkey, you might have different opinions.

What do you think? @mcollina

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions