Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
This commit is contained in:
Alex A. Naanou 2026-01-23 23:45:33 +03:00
parent 340d1ee867
commit 0c7d836857

View File

@ -9,6 +9,8 @@ of a specific approach to testing, i.e. _combinational testing_
Note, **this module is experimental** and can change quite allot within a short to mid Note, **this module is experimental** and can change quite allot within a short to mid
time frame, use at your own risk, though ideas, feedback and suggestions are welcome. time frame, use at your own risk, though ideas, feedback and suggestions are welcome.
## Features ## Features
- Simple / minimalist implementation - Simple / minimalist implementation
@ -23,6 +25,7 @@ time frame, use at your own risk, though ideas, feedback and suggestions are wel
- -
## Contents ## Contents
- [test.js](#testjs) - [test.js](#testjs)
- [Features](#features) - [Features](#features)
@ -64,6 +67,7 @@ time frame, use at your own risk, though ideas, feedback and suggestions are wel
- [License](#license) - [License](#license)
## Architecture ## Architecture
This package implements two testing schemes: This package implements two testing schemes:
@ -87,7 +91,7 @@ The system builds chains in the form:
setup -> modifier* -> test setup -> modifier* -> test
``` ```
Where `modifier` can me either single or a chain of modifiers. Where `modifier` is optional and can be a chain of zero or more modifiers.
A `setup` and `modifier` can also include assertions/tests for direct testing and A `setup` and `modifier` can also include assertions/tests for direct testing and
sanity checks. sanity checks.
@ -107,6 +111,7 @@ This makes it simple to define procedural/generative tests.
This is the traditional self-contained test approach. This is the traditional self-contained test approach.
## Installation ## Installation
```shell_session ```shell_session
@ -119,6 +124,7 @@ $ npm install -g ig-test
``` ```
## Basic usage ## Basic usage
Create a test script Create a test script
@ -246,6 +252,7 @@ XXX chains
XXX notes on coverage XXX notes on coverage
## Components ## Components
### `DEFAULT_TEST_FILES` ### `DEFAULT_TEST_FILES`
@ -496,6 +503,7 @@ This will:
``` ```
## Advanced components ## Advanced components
### `runner(..)` ### `runner(..)`
@ -508,12 +516,16 @@ The default test combinator and runner.
The default [`ig-argv`][ig-argv] parser setup. The default [`ig-argv`][ig-argv] parser setup.
## Utilities ## Utilities
### `getCallerFilename()` ### `getCallerFilename()`
Returns the filename of the module where `getCallerFilename()` is called. Returns the filename of the module where `getCallerFilename()` is called.
- Multiple modifier chaining
## License ## License