This skill is organized to match the Jest official documentation structure (https://jestjs.io/docs/getting-started, https://jestjs.io/docs/api). When working with Jest:
- Identify the topic from the user's request:
- Getting started/ๅฟซ้ๅผๅง โ examples/getting-started/installation.md or examples/getting-started/using-matchers.md
- Testing/ๆต่ฏ โ examples/testing/asynchronous.md or examples/testing/setup-teardown.md
- Mock functions/Mock ๅฝๆฐ โ examples/testing/mock-functions.md
- Mock modules/Mock ๆจกๅ โ examples/testing/manual-mocks.md
- Snapshots/ๅฟซ็
ง โ examples/testing/snapshot-testing.md
- Configuration/้
็ฝฎ โ examples/configuration/jest-config.md
- CLI/ๅฝไปค่ก โ examples/configuration/cli-options.md
- Load the appropriate example file from the
examples/ directory:
Getting Started (ๅฟซ้ๅผๅง) - examples/getting-started/:
- examples/getting-started/installation.md - Installing Jest and basic setup
- examples/getting-started/using-matchers.md - Using Jest matchers and assertions
Testing (ๆต่ฏ) - examples/testing/:
- examples/testing/asynchronous.md - Testing asynchronous code
- examples/testing/setup-teardown.md - Setup and teardown functions
- examples/testing/mock-functions.md - Mocking functions
- examples/testing/manual-mocks.md - Manual mocks
- examples/testing/snapshot-testing.md - Snapshot testing
- examples/testing/timer-mocks.md - Mocking timers
- examples/testing/es6-class-mocks.md - Mocking ES6 classes
Configuration (้
็ฝฎ) - examples/configuration/:
- examples/configuration/jest-config.md - Jest configuration options
- examples/configuration/cli-options.md - CLI options and flags
- examples/configuration/babel.md - Using Jest with Babel
- examples/configuration/typescript.md - Using Jest with TypeScript
Guides (ๆๅ) - examples/guides/:
- examples/guides/migrating-to-jest.md - Migrating to Jest
- examples/guides/testing-react-apps.md - Testing React applications
- examples/guides/testing-vue-apps.md - Testing Vue applications
- Follow the specific instructions in that example file for syntax, structure, and best practices
Important Notes:
- All examples follow Jest best practices
- Examples include both JavaScript and TypeScript versions where applicable
- Each example file includes key concepts, code examples, and key points
- Always check the example file for best practices and common patterns
- Reference API documentation in the
api/ directory when needed:
- api/expect.md - expect() API and matchers
- api/mock-functions.md - Mock functions API
- api/jest-object.md - Jest object API
- api/test.md - test() and describe() API
- api/cli.md - CLI commands and options
- Use templates from the
templates/ directory:
- templates/jest-config.md - Jest configuration templates
- templates/test-template.md - Test file templates
- templates/setup-file.md - Setup file templates
Doc mapping (one-to-one with https://jestjs.io/docs/getting-started, https://jestjs.io/docs/api)
Getting Started (ๅฟซ้ๅผๅง):
examples/getting-started/installation.md โ https://jestjs.io/docs/getting-startedexamples/getting-started/using-matchers.md โ https://jestjs.io/docs/using-matchers
Testing (ๆต่ฏ):
examples/testing/asynchronous.md โ https://jestjs.io/docs/asynchronousexamples/testing/setup-teardown.md โ https://jestjs.io/docs/setup-teardownexamples/testing/mock-functions.md โ https://jestjs.io/docs/mock-functionsexamples/testing/manual-mocks.md โ https://jestjs.io/docs/manual-mocksexamples/testing/snapshot-testing.md โ https://jestjs.io/docs/snapshot-testingexamples/testing/timer-mocks.md โ https://jestjs.io/docs/timer-mocksexamples/testing/es6-class-mocks.md โ https://jestjs.io/docs/es6-class-mocks
Configuration (้
็ฝฎ):
examples/configuration/jest-config.md โ https://jestjs.io/docs/configurationexamples/configuration/cli-options.md โ https://jestjs.io/docs/cli
API Reference:
api/expect.md โ https://jestjs.io/docs/expectapi/mock-functions.md โ https://jestjs.io/docs/mock-functionsapi/jest-object.md โ https://jestjs.io/docs/jest-objectapi/test.md โ https://jestjs.io/docs/api#testname-fn-timeoutapi/cli.md โ https://jestjs.io/docs/cli