https://github.com/hazzard993/busted-tstl

TypeScript declarations for Busted (lua)
https://github.com/hazzard993/busted-tstl

definitions lua testing typescript typescript-to-lua

Last synced: 24 days ago
JSON representation

TypeScript declarations for Busted (lua)

• Host: GitHub
• URL: https://github.com/hazzard993/busted-tstl
• Owner: hazzard993
• Created: 2019-02-23T03:19:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-01-06T12:52:14.000Z (almost 3 years ago)
• Last Synced: 2024-10-02T11:21:04.967Z (about 1 month ago)
• Topics: definitions, lua, testing, typescript, typescript-to-lua
• Homepage:
• Size: 22.5 KB
• Stars: 3
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# TypeScript declarations for Busted

This repository contains TypeScript declarations for [Busted](https://olivinelabs.com/busted/). An Elegant Lua unit testing framework.

You can install these via npm.

```

yarn add -D busted-tstl

# or

npm install -D busted-tstl

```

link them up in your **tsconfig.json** file.

> It is recommended to use [lua-types](https://github.com/ark120202/lua-types) with these declarations as those will tell TypeScript about Lua's environment.

```json

{

    "compilerOptions": {

        "lib": ["esnext"],

        "types": [

            "busted-tstl",

            "lua-types/5.1

        ]

    }

}

```

start creating your busted tests within _.ts_ files (preferably with the suffix _\_spec.ts_ within a folder named _spec_).

```ts

describe("mocks", () => {

    it("replaces a table with spies", () => {

        const t = {

            thing: function (this: void, msg) { print(msg) }

        };

        const m = mock(t); // mocks the table with spies, so it will print

        m.thing("Coffee");

        assert.spy(m.thing).was.called_with("Coffee");

    });

    it("replaces a table with stubs", () => {

        const t = {

            thing: function (this: void, msg) { print(msg) }

        };

        const m = mock(t, true); // mocks the table with stubs, so it will not print

        m.thing("Coffee");

        assert.stub(m.thing).was.called_with("Coffee");

        mock.revert(m); // reverts all stubs/spies in m

        m.thing("Tea"); // DOES print 'Tea'

    });

});

```

Then transpile the file(s) with [TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua) and run busted!

```sh

tstl spec/test_spec.ts

tstl -p tsconfig.json

busted      # Install with `luarocks install busted`

```

It is recommended to use [lua-types](https://github.com/ark120202/lua-types) with these declarations as those will tell TypeScript about Lua's environment.

## Assertion Statement Info

Assertion statements can be built with underscores and/or dots.

```ts

assert.is.True(true);           // Equivalent

assert.is_true(true);           // Equivalent

assert.is.not.True(false);      // Equivalent

assert.is_not_true(false);      // Equivalent

```

Verbs can be chained. However if there is a `not` or `no` within the chain, the assertion is expected to be fail. This cannot be reverted with another `not` or `no`.

```ts

assert.is.is.is.not.is.not.False(true);   // Assertion failed.

                                          // This was expected because of `not`

```

## Async Tests

To use `async()` and `done()` make sure your test case is wrapped in a `pending(...)` call.

```ts

async(); // error, trying to call nil value

done(); // error, trying to call nil value

pending("waiting for sleep to complete", () => {

  async();

  sleep(5000);

  done();

});

```