Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–226 runs
build_error
glibcnode 18–226 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
BuildVersionTracker
✓ import BuildVersionTracker from 'build-version-tracker'
✗ const BuildVersionTracker = require('build-version-tracker')
ESM default import for Webpack plugin.
viteVersionPlugin
✓ import viteVersionPlugin from 'build-version-tracker/vite'
✗ import viteVersionPlugin from 'build-version-tracker'
For Vite plugin, must import from 'build-version-tracker/vite' subpath.
require for Webpack (CommonJS)
✓ const BuildVersionTracker = require('build-version-tracker')
✗ const BuildVersionTracker = require('build-version-tracker').default
CommonJS require works directly; no .default needed.
require for Vite (CommonJS)
✓ const viteVersionPlugin = require('build-version-tracker/vite')
✗ const viteVersionPlugin = require('build-version-tracker')
For Vite plugin in CJS, use require with subpath '/vite'.
Demonstrates both Webpack and Vite plugin usage with ESM imports and custom version formatting.
// Webpack plugin in ESM
import BuildVersionTracker from 'build-version-tracker';
export default {
// other webpack config
plugins: [
new BuildVersionTracker({
distPath: 'dist',
isBuild: true,
htmlName: 'index.html',
formatVersion: (info) => `Version: ${info.time}, Branch: ${info.currentBranch}, User: ${info.userName}`,
formatTextVersion: (info) => `Build: ${info.time}, Branch: ${info.currentBranch}, By: ${info.userName}`
})
]
};
// Vite plugin in ESM
import viteVersionPlugin from 'build-version-tracker/vite';
export default {
plugins: [
viteVersionPlugin({
distPath: 'dist',
isBuild: true,
htmlName: 'index.html'
})
]
};
Errors
Common errors & fixes
Cannot find module 'adm-zip'
Missing peer dependency adm-zip.
fixInstall adm-zip: npm install adm-zip
Error: You forgot to add 'adm-zip' plugin...
Vite or Webpack plugin missing required adm-zip.
fixInstall adm-zip and ensure it is in node_modules.
TypeError: BuildVersionTracker is not a constructor
Importing Webpack plugin from default export incorrectly or using wrong import path.
fixUse 'import BuildVersionTracker from 'build-version-tracker'' or 'const BuildVersionTracker = require('build-version-tracker')'. Cannot find module 'build-version-tracker/vite'
Trying to import Vite plugin without the /vite subpath or package missing.
fixUse correct import: 'import viteVersionPlugin from 'build-version-tracker/vite'' and ensure package installed.
Audit
Dependencies
adm-ziprequiredRequired peer dependency for ZIP archiving functionality in both Webpack and Vite plugins.
webpackoptionalRequired peer dependency for Webpack plugin variant.