Guidelines and best practices for writing unit tests in the G2 visualization library, covering directory structure, testing patterns, and implementation guidelines. Use when need to generate test.
npxskills add antvis/g2--skill "G2 Unit Testing Skills"Loading…
Document Title: G2 Unit Testing Skill Specification Version: 1.0 Author: G2 Development Team Purpose: Guide for writing effective unit tests in the G2 visualization library
This skill specification provides comprehensive guidelines for writing unit tests in the G2 visualization library. It covers directory structure, testing patterns, best practices, and implementation guidelines to ensure consistent and maintainable test code.
Before writing unit tests for G2, ensure you have:
G2 organizes tests into two main categories:
__tests__/unit/)Unit tests are for testing pure data modules or functions. They are located in __tests__/unit/ and organized by module:
api/ - Chart API related testsdata/ - Data transformation testsscale/encode/ - Encoding related testscomponent/ - Component related testsutils/ - Utility function tests__tests__/plots/)Integration tests test the rendering results of the entire visualization chart by comparing screenshots. Located in __tests__/plots/, these are organized by focus areas:
static/ - Static drawing related casesanimation/ - Animation related casesapi/ - Chart API related casesinteraction/ - Interaction related casestooltip/ - Tooltip related caseslegend/ - Legend related casesbugfix/ - Bug fix related casesFollow the standard Jest testing structure:
import { YourFunction } from '../../../src/your-module';
describe('YourFunction', () => {
it('should perform expected behavior', () => {
// Test implementation
expect(result).toBe(expected);
});
});
Integration tests typically export chart configurations:
import { G2Spec } from '../../../src';
export function alphabetInterval(): G2Spec {
return {
type: 'interval',
transform: [{ type: 'sortX', by: 'y', reverse: true }],
data: {
type: 'fetch',
value: 'data/alphabet.csv',
},
axis: {
y: { labelFormatter: '.0%' },
},
encode: {
x: 'letter',
y: 'frequency',
},
};
}
G2Specindex.ts file to make it visible in the preview environmentTo run all tests locally:
npm run test
To run tests on demand (specific test files or directories):
# Run specific test file
npm run test -- path/to/your/test-file.test.ts
# Run tests matching a pattern
npm run test -- --testNamePattern="legend"
This ensures your changes pass all existing tests before submitting a pull request.
Common issues and solutions:
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Create or update AgentSkills. Use when designing, structuring, or packaging skills with scripts, references, and assets.
Set up and use 1Password CLI (op). Use when installing the CLI, enabling desktop app integration, signing in (single or multi-account), or reading/injecting/running secrets via op.
CLI to manage emails via IMAP/SMTP. Use `himalaya` to list, read, write, reply, forward, search, and organize emails from the terminal. Supports multiple accounts and message composition with MML (MIME Meta Language).