Introduction to bin-check

bin-check is an extensive library intended for verifying the presence and operability of command-line binaries on various systems. This guide provides an in-depth look at bin-check’s functionalities, complete with API explanations and sample code snippets, culminating in a comprehensive application example.

Key APIs and Their Examples

1. checkBin()

The checkBin() function tests for the availability of a specified binary.

 const binCheck = require('bin-check');
binCheck('git')
  .then(works => {
    console.log(works ? 'Git is available' : 'Git is not available');
  })
  .catch(error => {
    console.error('An error occurred:', error);
  });

2. checkBinVersion()

The checkBinVersion() function checks if the installed binary version matches a given constraint.

 const binCheck = require('bin-check');
binCheck.version('node', '>=14.0.0')
  .then(isValid => {
    console.log(isValid ? 'Node.js version is valid' : 'Node.js version is not valid or not found');
  })
  .catch(error => {
    console.error('An error occurred:', error);
  });

3. checkMultipleBins()

The checkMultipleBins() function allows bulk checking of multiple binaries at once.

 const binCheck = require('bin-check');
binCheck.multiple(['git', 'node', 'npm'])
  .then(results => {
    results.forEach(result => {
      console.log(`${result.bin} is ${result.works ? 'available' : 'not available'}`);
    });
  })
  .catch(error => {
    console.error('An error occurred:', error);
  });

Application Example

The following example demonstrates a scenario where different binaries are checked before executing a set of tasks in an application.

 const binCheck = require('bin-check');
async function preCheck() {
  const checks = await binCheck.multiple(['git', 'node', 'npm']);
  checks.forEach(result => {
    if (!result.works) {
      console.error(`${result.bin} is required but not found. Exiting...`);
      process.exit(1);
    }
  });
  console.log('All required binaries are available. Proceeding with the application...');
  // Proceed with the application logic
}
preCheck(); 

This example ensures that Git, Node.js, and npm are available before proceeding with the main application logic.

Hash: b1346bd0df7681006ea3eea37c99636508adbfe27c5da267e81df41003cc3119