README.md

TSTL Lurker

Declarations for lurker, a small module which automatically hotswaps changed Lua files in a running LÖVE project.

Command	Description
yarn add -D tstl-lurker	Install these declarations
yarn add rxi/lume rxi/lurker	Install Lurker
tstl -p tsconfig.json --watch	Transpile and continue to transpile changed .ts files
love /path/to/game/directory	Run the game. Make sure lurker.update() is called

Upon installation these declarations can be linked to a tsconfig.json file.

{
    "compilerOptions": {
        "types": [
            "tstl-lurker"
        ]
    }
}

And used within any .ts file.

import lurker = require("lurker");
// this import style is not available in esnext

lurker.preswap = (f) => f === "lualib_bundle.lua";
// do NOT hotswap lualib_bundle.lua, lurker can't hotswap this

lurker.path = "./entities";
lurker.quiet = false;

love.update = () => {
    lurker.update();
};

Make sure to append ";./node_modules/?/?.lua" to your package.path in a conf.ts file (this is run first) to assist where Lua looks for modules.

package.path += ";./node_modules/?/?.lua";