@tspec/core

Core testing framework functionality for TSpec

ℹ️ Important Note

Provides the foundational testing APIs including describe(), test(), and the test runner engine.

This package is designed to work as part of the TSpec ecosystem and Typically used together with @tspec/assert for assertions.

📖 View complete documentation and examples →

Installation

1npm install --save-dev @tspec/core @tspec/assert

Features

• Test organization with describe(), test(), it()
• Async testing support with promises and async/await
• Test file discovery and execution
• TypeScript-first design with full type safety

Usage

1import { describe, test } from '@tspec/core';
2import { expect } from '@tspec/assert';
3
4describe('My Component', () => {
5  test('should work correctly', () => {
6    const result = myFunction();
7    expect(result).toBe('expected');
8  });
9});

Complete Testing Example

1import { describe, test } from '@tspec/core';
2import { expect } from '@tspec/assert';
3
4
5describe('core Example', () => {
6  test('demonstrates core functionality', () => {
7    // Test organization and structure
8    const value = 'test';
9    expect(value).toBe('test');
10    
11    
12  });
13});

Related Packages

TSpec is designed as a cohesive framework. Here are the related packages:

• @tspec/assert - Assertion library for TSpec testing framework
• @tspec/cli - Command-line interface for running TSpec tests

Documentation & Support

• 📖 Complete Documentation - Full usage guide and API reference
• 🚀 Getting Started Guide - Step-by-step setup
• 💡 Examples - Real-world usage examples
• 🐛 Issues - Report bugs or request features

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Setting up the development environment
• Running tests and ensuring quality
• Submitting pull requests

License

MIT License - see the LICENSE file for details.

---