fix(ci): Fix CI configuration URL and package installation paths.
This commit is contained in:
14
readme.md
14
readme.md
@@ -1,7 +1,9 @@
|
||||
# @push.rocks/tapbundle
|
||||
|
||||
tap bundled for tapbuffer
|
||||
|
||||
## Install
|
||||
|
||||
Install the package by running the following command in your terminal:
|
||||
|
||||
```bash
|
||||
@@ -11,9 +13,11 @@ npm install @push.rocks/tapbundle --save-dev
|
||||
This will add `@push.rocks/tapbundle` to your project's `devDependencies`.
|
||||
|
||||
## Usage
|
||||
|
||||
The `@push.rocks/tapbundle` package is a tap-compatible testing framework written in TypeScript, intended for use with tapbuffer. It includes a range of useful features enabling easy setup and execution of tests, assertion handling through `expect` and `expectAsync`, as well as auxiliary tools for delay and colored console output.
|
||||
|
||||
### Getting Started
|
||||
|
||||
First, ensure your project is set up with Typescript and supports ESM syntax. You can then import `tap`, `expect`, and `expectAsync` from `@push.rocks/tapbundle` to start defining your tests.
|
||||
|
||||
```typescript
|
||||
@@ -33,6 +37,7 @@ tap.start();
|
||||
```
|
||||
|
||||
### Defining Tests
|
||||
|
||||
You can define tests with descriptions and async functions. The `tap` instance manages test execution, supports test skipping, and managing exclusive tests with the `.only` modifier.
|
||||
|
||||
```typescript
|
||||
@@ -52,6 +57,7 @@ tap.start();
|
||||
```
|
||||
|
||||
### Using `expect` and `expectAsync`
|
||||
|
||||
The package provides `expect` and `expectAsync` for assertions:
|
||||
|
||||
```typescript
|
||||
@@ -60,6 +66,7 @@ expect(5).toBeGreaterThan(2);
|
||||
```
|
||||
|
||||
### Handling Asynchronous Operations
|
||||
|
||||
`tapbundle` facilitates working with async operations in tests. You can introduce delays or set timeouts:
|
||||
|
||||
```typescript
|
||||
@@ -72,7 +79,9 @@ tap.start();
|
||||
```
|
||||
|
||||
### Advanced Usage
|
||||
|
||||
#### Pre Tasks
|
||||
|
||||
You can define tasks to run before test execution begins:
|
||||
|
||||
```typescript
|
||||
@@ -88,6 +97,7 @@ tap.start();
|
||||
```
|
||||
|
||||
#### Accessing Test Metadata
|
||||
|
||||
Each test returns a `TapTest` instance, from which you can access metadata and manipulate test behavior:
|
||||
|
||||
```typescript
|
||||
@@ -102,9 +112,11 @@ tap.start().then(() => {
|
||||
```
|
||||
|
||||
### Running Tests
|
||||
|
||||
Tests are executed by calling `tap.start()`. This method runs all defined tests in sequence and respects `.skip` and `.only` modifiers.
|
||||
|
||||
### Debugging and Output
|
||||
|
||||
`@push.rocks/tapbundle` supports colored console output via `consolecolor` to help with debugging and test result readability:
|
||||
|
||||
```typescript
|
||||
@@ -120,7 +132,7 @@ This detailed guide covers the most important aspects of using `@push.rocks/tapb
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user