Better Local Library Support / Code Organisation

[nodes-io]

Better Local Library Support / Code Organisation

[dmnsgn]

Hi @K3TH3R,

require() calls in Nodes are currently not commonjs require (more info here: https://nodes.io/docs/api-reference/#:~:text=Note%20that%20they,chunk%20%7D%20from%20%27lodash%27.) but we've had success including local libraries anyway.

Suppose your project has the following structure:

$ tree -L 1
.
├── assets
├── custom
├── graphs
├── index.html
├── local_modules
│   ├── WebGLImageFilter
├── node_modules
├── nodes
├── package-lock.json
├── package.json
└── user.json

The package.json can include your external library like this:

{
  // ...
  "dependencies" : {
    // ...
    "webgl-image-filter": "file:local_modules/WebGLImageFilter"
  }
}

The local_modules/WebGLImageFilter folder needs to be a valid node modules so it needs to contain a package.json. It could be as simple as:

{
  "name": "webgl-image-filter",
  "version": "1.0.0",
  "main": "./WebGLImageFilter.js"
}

After that if you open your project and if they are no syntax errors in WebGLImageFilter, you should be able to require("webgl-image-filter") in your node to include whatever the package exports.