@voidzero-dev/vite-task-client

@voidzero-dev/vite-task-client

A tiny Node.js client that lets your tool talk to the Vite+ task runner (vp run) it's running under. Use it to hand the runner more precise cache-correctness information than it can infer from the outside.

Outside a runner-managed task, every call is a graceful no-op — you can call into this from a tool that's also used standalone without any runtime detection or conditionals.

Install

npm install @voidzero-dev/vite-task-client

Quick start

import { ignoreInput, ignoreOutput, disableCache, getEnv } from '@voidzero-dev/vite-task-client';

ignoreInput('./node_modules/.cache/my-tool');

// `vp run` only exposes envs the task config declares; for everything
// else, `getEnv` fetches the value from the runner and registers it as
// a cache-key dependency in the same call.
const apiVersion = process.env.MY_API_VERSION ?? getEnv('MY_API_VERSION');

if (somethingNonDeterministicHappened) disableCache();

Why this exists

vp run decides whether a task's cached result is reusable by hashing everything your task read and everything it depends on. It infers that set automatically — watching filesystem syscalls, scanning declared inputs and env vars. That's safe but can be too coarse:

• Your tool maintains its own cache under node_modules/.cache/…. Every miss there would invalidate every other run, even though the contents don't actually affect your output.
• Your tool reads process.env.MY_API_VERSION, and vp run's task config doesn't list it.
• Your tool has a non-deterministic mode it sometimes falls into and should skip the cache entirely.

These functions give you a precise way to correct each case from inside your tool, without forcing your users to rewrite their vp run task config.

API

See src/index.d.ts for the full signatures and per-function behavior.

For vite-task developers

This package is a thin pure-JS wrapper with no dependencies in package.json — its only runtime artifact is the napi addon, which the runner provides at execution time.

That means when you change this package in a vite-task PR, the consuming tool can pull your unpublished commit directly via a git URL with a subpath, no npm release required:

// In the consuming tool's package.json
{
  "dependencies": {
    "@voidzero-dev/vite-task-client": "github:voidzero-dev/vite-task#<commit-sha>&path:/packages/vite-task-client",
  },
}

(&path: is supported by pnpm. For npm/yarn, see your package manager's docs on monorepo-subpath git installs.)