https://github.com/littensy/rbxts-jest

Delightful testing for Roblox TypeScript.
https://github.com/littensy/rbxts-jest

roblox roblox-ts typescript

Last synced: 11 days ago
JSON representation

Delightful testing for Roblox TypeScript.

• Host: GitHub
• URL: https://github.com/littensy/rbxts-jest
• Owner: littensy
• License: mit
• Created: 2024-04-03T10:49:35.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-04-07T07:49:45.000Z (9 months ago)
• Last Synced: 2024-12-07T20:57:48.470Z (18 days ago)
• Topics: roblox, roblox-ts, typescript
• Language: Shell
• Homepage:
• Size: 649 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


  


    

  

  
@rbxts/jest

  


    TypeScript type definitions for Jest Lua.

    


    npm package →

  


TypeScript type definitions for [Jest Lua](https://github.com/jsdotlua/jest-lua) and [roblox-ts](https://roblox-ts.com), sourced from the official Jest types.

See the [Jest Lua documentation](https://jsdotlua.github.io/jest-lua/) for more information on how to use Jest Lua.

> [!NOTE]

> Currently, installing `@rbxts/jest` will also install `@rbxts/react-vendor` as a dependency. While Jest Lua does not need React Lua to run, `@rbxts/jest` reuses the React vendor package to avoid duplicating React and other internal modules. This may change in the future.

## Setup

```sh

npm install @rbxts/jest @rbxts/jest-globals

yarn add @rbxts/jest @rbxts/jest-globals

pnpm add @rbxts/jest @rbxts/jest-globals # 🛑 See below

```

### Usage with pnpm

If you're using pnpm as your package manager, you'll need to create a `.npmrc` file in the root of your project with the following content:

```ini

node-linker=hoisted

```

## Examples

TODO

## License

This project is licensed under the [MIT license](LICENSE).