yarn-deps-check

Check whether dependencies have been installed.

Usage no npm install needed!

<script type="module">
  import yarnDepsCheck from 'https://cdn.skypack.dev/yarn-deps-check';
</script>

README

yarn-deps-check

GitHub license npm version CircleCI Status

Simple module to check that your project's node_modules directory is up-to-date with your project's yarn.lock Yarn lockfile. This module can be used in your build system to enforce that builds are done with the current versions of your dependencies. This protects against the case where a developer git pulls some commits including changes to yarn.lock and tries to build or run the application before running yarn to update the node_modules directory of dependencies, which would otherwise run with the incorrect versions of the dependencies.

Usage

  • Put it at the top of your build system's javascript (such as a gulpfile):
import 'yarn-deps-check';
  • Or run it as an independent executable from your project's directory:
yarn yarn-deps-check
  • Or import it as a function and call it only when you need to:
import depsCheck from 'yarn-deps-check/function';

// ...
if (...) {
  depsCheck();
}

The function will throw an error if the dependency check fails.

Types

TypeScript type definitions for this module are included! The type definitions won't require any configuration to use.