voidzero-dev/Setup vp
Install Vite+ (vp) and optionally cache project dependencies
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| version | Version of Vite+ to install. Takes precedence over version-file. When neither is set, the version is auto-detected from the project's package.json (its vite-plus dependency or catalog entry; a semver range is resolved to the exact version in the lockfile), falling back to the latest release. | no | "" |
| version-file | Path to a file to resolve the Vite+ version from (package.json, pnpm-workspace.yaml, or .yarnrc.yml). A package.json `vite-plus` entry of `catalog:`/`catalog:<name>` is resolved through the nearest catalog source: pnpm-workspace.yaml (pnpm), .yarnrc.yml (yarn), or a root package.json `catalog`/`catalogs` (bun). Ignored when version is specified. | no | — |
| run-install | Run `vp install` after setup. Accepts boolean or YAML object with cwd/args. | no | true |
| sfw | Wrap `vp install` with Socket Firewall Free (sfw) to block malicious dependency fetches. Works on Linux, macOS, and Windows (macOS/Windows require Vite+ v0.1.23+). See https://docs.socket.dev/docs/socket-firewall-free. | no | false |
| node-version | Node.js version to install via `vp env use`. Defaults to Node.js latest LTS version. | no | — |
| node-version-file | Path to file containing the Node.js version spec (.nvmrc, .node-version, .tool-versions, package.json). Ignored when node-version is specified. | no | — |
| working-directory | Project directory to use for relative paths, lockfile auto-detection, environment checks, and default `vp install` execution. | no | — |
| cache | Enable caching of project dependencies | no | false |
| cache-dependency-path | Path to lock file for cache key generation. Auto-detected if not specified. | no | — |
| registry-url | Optional registry to set up for auth. Will write .npmrc in $RUNNER_TEMP with registry and auth config, and set NPM_CONFIG_USERCONFIG to point npm at it. Auth token is read from env.NODE_AUTH_TOKEN. | no | — |
| scope | Optional scope for authenticating against scoped registries. Will fall back to the repository owner when using the GitHub Packages registry (https://npm.pkg.github.com/). | no | — |
Outputs
| name | description |
|---|---|
| version | The installed version of Vite+ |
| cache-hit | Boolean indicating if cache was restored |