requires-version

A TypeScript library for checking system dependency versions. Verify that required command-line tools exist and meet minimum version requirements in your Node.js projects.

Features

• ✅ Simple Existence Checks - Verify if a command-line tool is installed
• 🔍 Version Validation - Compare installed versions against requirements
• 🎯 Flexible Operators - Use <, >, =, <=, >= for version comparisons
• 🚀 TypeScript First - Full type safety with TypeScript
• 🌐 Cross-Platform - Works on Linux, macOS, and Windows
• 📦 Zero Dependencies (runtime)
• 🧪 Well Tested - 96%+ test coverage

Installation

npm install requires-version --save-dev
Copy

Usage

Basic Existence Check

Check if a command-line tool is installed:

import { requires } from 'requires-version'

// Check if Node.js is installed
if (requires('node')) {
	console.log('Node.js is installed')
} else {
	console.log('Node.js is not installed')
}
Copy

Version Comparison

Verify that a tool meets version requirements:

import { requires, GREATER, EQUAL } from 'requires-version'

// Check if Node.js version is >= 18.0.0
if (requires('node', '18.0.0', GREATER | EQUAL)) {
	console.log('Node.js version is 18.0.0 or higher')
}

// Check if npm version is exactly 9.5.0
if (requires('npm', '9.5.0', EQUAL)) {
	console.log('npm version is 9.5.0')
}
Copy

All Comparison Operators

import { requires, LESS, GREATER, EQUAL } from 'requires-version'

// Greater than
requires('node', '16.0.0', GREATER) // version > 16.0.0

// Less than
requires('node', '20.0.0', LESS) // version < 20.0.0

// Equal to
requires('node', '18.14.1', EQUAL) // version === 18.14.1

// Greater than or equal to
requires('node', '18.0.0', GREATER | EQUAL) // version >= 18.0.0

// Less than or equal to
requires('node', '20.0.0', LESS | EQUAL) // version <= 20.0.0
Copy

Error Handling

When a version check fails, a VersionException is thrown:

import { requires, GREATER, EQUAL, VersionException } from 'requires-version'

try {
	requires('nonexistent-tool', '1.0.0', GREATER | EQUAL)
} catch (error) {
	if (error instanceof VersionException) {
		console.error('Version check failed:', error.message)
		// Possible messages:
		// - "nonexistent-tool" not found.
		// - "nonexistent-tool" version not found.
	}
}
Copy

Practical Examples

Pre-flight Checks

Validate your development environment before running tasks:

import { requires, GREATER, EQUAL } from 'requires-version'

function checkDevelopmentEnvironment() {
	const checks = [
		{ name: 'node', version: '18.0.0' },
		{ name: 'npm', version: '9.0.0' },
		{ name: 'git', version: '2.0.0' }
	]

	for (const { name, version } of checks) {
		if (!requires(name, version, GREATER | EQUAL)) {
			throw new Error(`${name} >= ${version} is required`)
		}
	}

	console.log('✅ All dependencies satisfied')
}
Copy

Build Script Validation

import { requires, GREATER, EQUAL } from 'requires-version'

// Ensure required build tools are available
if (!requires('docker')) {
	throw new Error('Docker is required for building')
}

if (!requires('node', '18.0.0', GREATER | EQUAL)) {
	throw new Error('Node.js 18.0.0 or higher is required')
}

// Proceed with build...
Copy

API

requires(dependencyName: string): boolean

Check if a command exists in the system PATH.

Parameters:

• dependencyName - Name of the command-line tool to check

Returns:

• true if the tool exists, false otherwise

Example:

requires('node') // true or false
Copy

---

requires(dependencyName: string, version: string, op: Operator): boolean

Check if a command exists and satisfies a version requirement.

Parameters:

• dependencyName - Name of the command-line tool to check
• version - Version string to compare against (e.g., "18.14.1")
• op - Comparison operator (LESS, GREATER, EQUAL, or combinations)

Returns:

• true if the version requirement is satisfied

Throws:

• VersionException if the tool is not found or version cannot be determined

Example:

requires('node', '18.0.0', GREATER | EQUAL) // true or false
Copy

---

Operators

export const LESS: number    // 0x02 - Less than operator
export const GREATER: number // 0x04 - Greater than operator
export const EQUAL: number   // 0x08 - Equal to operator
Copy

Operators can be combined using bitwise OR (|):

• GREATER | EQUAL → >=
• LESS | EQUAL → <=

---

VersionException

Custom error class thrown when version checks fail.

Example:

import { VersionException } from 'requires-version'

try {
	requires('tool', '1.0.0', EQUAL)
} catch (error) {
	if (error instanceof VersionException) {
		console.error(error.message)
	}
}
Copy

How It Works

1. Tool Detection: Uses the which package to locate executables in the system PATH
2. Version Extraction: Attempts multiple common version flags (-v, --version, etc.)
3. Version Parsing: Extracts version numbers using regex patterns
4. Comparison: Uses semantic versioning comparison via compare-versions package

Platform Support

Tested on:

• ✅ Linux (Ubuntu, Debian, etc.)
• ✅ macOS (Darwin)
• ✅ Windows (Win32)

Development

# Install dependencies
npm install

# Run tests
npm test

# Run tests in watch mode
npm run test:watch

# Run tests with coverage
npm run coverage

# Build
npm run build

# Lint
npm run lint

# Lint and fix
npm run lint:fix
Copy

Testing

The library includes comprehensive tests covering:

• Basic functionality (existence checks, version comparisons)
• Error handling (missing dependencies, invalid versions)
• Version parsing (various formats, prefixes)
• Real-world platform tests (Linux, macOS, Windows)
• Edge cases (version format variations)

See test/index.spec.ts for all test cases.

Contributing

Contributions are welcome! Please read our Contributing Guide for details on:

• Setting up the development environment
• Code style and conventions
• Commit message format
• Pull request process

License

MIT © sanghaklee

Related Projects

• which - Cross-platform implementation of Unix which
• compare-versions - Semantic version comparison
• semver - Semantic versioning for Node.js

Support

• 📝 Documentation
• 🐛 Issue Tracker
• 💖 Sponsor