Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vadimnastoyashchy/scripterio
JavaScript testing framework running on Node.js that makes testing easy and fun.
https://github.com/vadimnastoyashchy/scripterio
javascript nodejs tdd test testing-framework testing-library testing-tool
Last synced: 9 days ago
JSON representation
JavaScript testing framework running on Node.js that makes testing easy and fun.
- Host: GitHub
- URL: https://github.com/vadimnastoyashchy/scripterio
- Owner: VadimNastoyashchy
- License: mit
- Created: 2024-11-20T13:01:12.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-11-29T09:37:36.000Z (25 days ago)
- Last Synced: 2024-11-29T10:42:03.182Z (25 days ago)
- Topics: javascript, nodejs, tdd, test, testing-framework, testing-library, testing-tool
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
ScripterI/O - Simple, fast, runner for testing all JavaScript
Release Notes / History / Changes
Link to NPM repository > scripterio
ScripterI/O is a JavaScript testing framework running on Node.js that makes testing easy and fun.
## Getting started
> Before you follow the steps below, make sure that you have:
[Node.js](https://nodejs.org/en/download/) installed _globally_ only your system
## Installing
Install for Mac, Linux, or Windows:
```bash
npm install scripterio --save-dev
//or
yarn add scripterio --dev
```
## Write your first test:
Use the `test` function to write test cases and the `describe` function to group them.
More example:
https://github.com/VadimNastoyashchy/scripterio-boilerplate-project
Let's start by creating the `test.js` test file.
> Runner has JavaScript support only
> Runner has ESM support only
### `Example↓`
test.js
```
import { describe, test, expect} from 'scripterio'
describe('Title for describe block', () => {
test('Title for test', () => {
const arr = [1, 2, 3]
expect(arr).toHaveLength(3)
})
})
```
## Run test:
Specify the **--file=** argument as the path to your test file
```bash
npx scripterio --file="test.js"
//or
yarn scripterio --file="test.js"
```
### or
Specify the **--folder=** argument as the path to your test(s) folder
```bash
npx scripterio --folder="tests"
//or
yarn scripterio --folder="tests"
```
## `Test runner API`
---
| Option Name | Description |
| -------------- | ------------------------------------------------------------------------------------- |
| `"test"` | `test` is where you perform individual tests |
| `"describe"` | `describe` is for organizing and grouping tests. Describe can be nested in `describe` |
| `"beforeEach"` | Command allows to define setup tasks at the beginning of every It block |
| `"afterEach"` | Command allow to define teardown tasks at the end of every It block |
| `"beforeAll"` | Command allow to define setup tasks at the beginning of describe block |
| `"afterAll"` | Command allow to define teardown tasks at the end of describe block |
---
## `Assertions`
Use `expect(actual_value)` with assertions:
### `Example↓`
```
const arr = [1, 2, 3]
expect(arr).toHaveLength(3)
```
---
| Assert Name | Description |
| -------------------- | ----------------------------------------------------------------------------------------------- |
| `.toBeDefined()` | Check actual value to be not undefined `expect(1).toBeDefined()` |
| `.toHaveLength()` | Check actual array length to have expected value `expect(arr).toHaveLength(number)` |
| `.toBeFalsy()` | Check actual value to be false |
| `.toBeTruthy()` | Check actual value to be true |
| `.toBeEqual()` | Check actual and expected values are the same (using ===) `expect(value).toEqual(value)` |
| `.notToEqual()` | Check actual and expected values are not the same (using ===) `expect(value).notToEqual(value)` |
| `.toBeNull()` | Check actual value to be null |
| `.notToBeNull()` | Check actual value to be not null |
| `.toBeUndefined()` | Check actual value to be undefined |
| `.toBeNaN()` | Check actual value to be NaN |
| `.toBeGreaterThan()` | Check actual value to be greater than expected value |
| `.toBeLessThan()` | Check actual value to be less than expected value |
| `.toContain()` | Use when you want to check that an item is in an array or a string. |
| `.toMatch()` | Use .toMatch() to check that a string matches a regular expression. |
---
## `Context options`
Use `{}` as the second param for describe and tests func.
### `Example↓`
```
test('description', {}, () => {})
//or
describe('description', {}, () => {})
```
### `Example↓`
```
describe('description', { skip: true }, () => {})
//or
test('description', { skip: true }, () => {})
```
---
| Option Name | Description |
| ------------------- | ----------------------------------------------------------------------- |
| `{ skip: true }` | Option for skipping describe/test where it was provided |
| `{ timeout: 2000 }` | Option timeout (in ms) for specifying how long to wait before aborting. |
| | The default timeout is 5 seconds. |
---
## `Async/Await support`
Also supports async/await approach.
To use it just add `async` keyword before function callback inside `test` block
### `Example↓`
```
test('Wait 1 sec and check', async () => {
const number = await new Promise((resolve) =>
setTimeout(() => resolve(1), 1_000)
)
expect(number).toBeDefined()
})
```