npmluau

This utility can be used to allow Luau projects to use npm as a package manager. It lets your projects use string requires: use relative file paths for the project's files or prefix your dependency names with @pkg to use them.

If you are interested to know why should use npm for Luau development, read Why You Should Use npm for Luau.

If you are developing on a platform that does not support requires with, you can use a tool like darklua to automatically convert requires into your platform specific implementation.

For real examples, there is the Awesome Luau List that contains many Luau packages (published to npm!) following the Sea of Voices Luau Package Standard.

How to use

Add npmluau in your dev-dependencies:

yarn add --dev npmluau

Or if you are using npm:

npm install --save-dev npmluau

In your Luau project package.json file, add a prepare script to run npmluau:

  "scripts": {
    "prepare": "npmluau",
  }

How it works

This utility will generate a folder named .luau-aliases inside node_modules after installing your dependencies that contains module links to each dependency.

Luau-lsp:

If you using the VS code extension, you can define a directory alias in your .luaurc:

{
  "aliases": {
    "pkg": "node_modules/.luau-aliases"
  }
}

License

This project is available under the MIT license. See LICENSE.txt for details.