Contributing to vlayer JavaScript codebase

Prerequisites

To start working with this repository, you will need to install following software:

  • Bun JavaScript runtime.

Bumping version

  1. Apply changes to the code
  2. Run bun changeset
  3. Submit information about your changes (would be visible in the changelog)
  4. Run bun changeset version
  5. Commit modified files changes
  6. Push

Quick list of common questions to get you started engaging with changesets (tool for versioning) is in their docs

Troubleshooting

Hanging SDK tests

If you see the following when trying to run SDK unit tests

$ cd packages/sdk
$ bun run test:unit
 vitest --run

 RUN  v2.1.4 /Users/kubkon/dev/vlayer/vlayer/packages/sdk

and nothing happening for a longer while, make sure you have Node.js installed.

bun install hung on resolving dependencies

If you see bun install hung on resolving dependencies in any of our examples, for instance

$ vlayer init --template simple
$ cd vlayer
$ bun install
Resolving dependencies

disable Bun's global cache by either using bunfig.toml as described here

[install.cache]
disable = true
disableManifest = true

or by directly passing a CLI flag

$ bun install --no-cache

There is a long-standing bug in Bun that despite many attempts at fixing is still present in all versions: issue #5831: Bun install hangs sporadically