docsify/test

Docsify Testing

Environment

• Jest: A test framework used for assertions, mocks, spies, etc.
• Playwright: A test automation tool for launching browsers and manipulating the DOM.
• Jest-Playwright: A Jest preset that simplifies using Jest and Playwright together

Test files

• E2E tests are located in /test/e2e/ and use Jest + Playwright.
• Integration tests are located in /test/integration/ and use Jest.
• Unit tests located in /test/unit/ and use Jest.

Global Variables

• BLANK_URL: Test server route to virtual _blank.html file
• TEST_HOST: Test server ip:port

CLI commands

# Run all tests
npm run test

# Run test types
npm run test:e2e
npm run test:integration
npm run test:unit

# Run test file
npm run test -- -i /path/to/file.test.js

# Run matching test files
npm run test -- -i /path/to/*.test.js

# Run matching test name(s)
npm run test -- -t \"describe() or test() name\"

# Run matching test name(s) in file
npm run test -- -i /path/to/file.test.js -t \"describe() or test() name\"

# Run all example tests
npm run test -- -i /test/**/example.test.js

# Run specific example test file
npm run test -- -i /path/to/example.test.js

# ------------------------------------------------------------------------------

# Update snapshots for matching test files
npm run test -- -u -i /path/to/*.test.js

# Update snapshots for matching test name(s)
npm run test -- -u -t \"describe() or test() name\"

# Update snapshots for matching test name(s) in file
npm run test -- -u -i /path/to/file.test.js -t \"describe() or test() name\"

# ------------------------------------------------------------------------------

# Start manual test server instance. Useful for previewing test fixtures.
# Root: /test/e2e/fixtures/
# Routes: /docs, /lib,
node ./test/config/server.js --start

Resource

• UI Testing Best Practices
• Using Jest with Playwright