relatively

For the Node `require('../../../../../../..')` problem.

Usage no npm install needed!

<script type="module">
  import relatively from 'https://cdn.skypack.dev/relatively';
</script>

README

A WIP experimental approach to solving the Node require() ../../../../../../.. problem. See for example Better local require() paths for Node.js. Allows require()ing paths that are relative to the application root, or whatever you configure.

Demo

Use case

// Before
require("../../../../../../../whatever");

// After
require("app/whatever");

Features

  • Only needs to be invoked at app launch. Doesn't require any changes to modules, they just call require() normally (except with the paths you configure).
  • Uses only public Node API.
  • More flexible than NODE_PATH.

Usage

Create an initialization script that you require prior to your normal app entry script:

// init.js
require("relatively")({
  mods: [
    {
      type: "dir",
      // Makes `require("app/whatever")` behave like
      // `require("/path/to/some/dir/whatever")`, from anywhere in your
      // dependency tree.
      from: "app",
      to: "/path/to/some/dir",
    },
  ]
});

// entry.js
// Loads /path/to/some/dir/x/y/z
require("app/x/y/z");

node -r ./init.js entry.js