Namibian Pyjama Merchant

    svlt-testing-library

    1.5.1 • Public • Published

    svelte-testing-library

    chipmunk

    Simple and complete Svelte testing utilities that encourage good testing practices.


    Read The Docs | Edit the docs


    Hello {name}!

    Build Status Code Coverage version downloads MIT License

    All Contributors PRs Welcome Code of Conduct Join the community on Spectrum

    Watch on GitHub Star on GitHub Tweet

    Table of Contents

    The problem

    You want to write maintainable tests for your Svelte components. As a part of this goal, you want your tests to avoid including implementation details of your components and rather focus on making your tests give you the confidence for which they are intended. As part of this, you want your testbase to be maintainable in the long run so refactors of your components (changes to implementation but not functionality) don't break your tests and slow you and your team down.

    This solution

    The svelte-testing-library is a very lightweight solution for testing Svelte components. It provides light utility functions on top of svelte and dom-testing-library, in a way that encourages better testing practices. Its primary guiding principle is:

    The more your tests resemble the way your software is used, the more confidence they can give you.

    Example

    App.svelte

    <script>
      export let name
    </script> 
     
    <style>
      h1 {
        color: purple;
      }
    </style> 
     
    <h1>Hello {name}!</h1>

    App.spec.js

    import App from '../src/App.svelte'
    import {render} from 'svlt-testing-library'
    describe('App', () => {
      test('should render greeting', () => {
        const {getByText} = render(App, {props: {name: 'world'}})
     
        expect(getByText('Hello world!'))
      })
     
      test('should change button text after click', async () => {
        const {getByText} = render(App, {props: {name: 'world'}})
     
        fireEvent.click(getByText('Button Text'))
     
        const button = await waitForElement(() => getByText('Button Clicked'))
     
        expect(button).toBeInTheDocument()
      })
    })

    Installation

    This module is distributed via npm which is bundled with node and should be installed as one of your project's devDependencies:

    npm install --save-dev svlt-testing-library
    

    This library has peerDependencies listings for svelte.

    You may also be interested in installing jest-dom so you can use the custom jest matchers.

    Docs

    Examples

    We're in the process of moving examples to the docs site

    You can also find svelte-testing-library examples at react-testing-examples.com.

    Other Solutions

    There's currently a package published in npm called svelte-testing-library but the git repository is not yet public. We are hoping to pull that work (and name) into this repository.

    Guiding Principles

    The more your tests resemble the way your software is used, the more confidence they can give you.

    We try to only expose methods and utilities that encourage you to write tests that closely resemble how your svelte components are used.

    Utilities are included in this project based on the following guiding principles:

    1. If it relates to rendering components, it deals with DOM nodes rather than component instances, nor should it encourage dealing with component instances.
    2. It should be generally useful for testing individual Svelte components or full Svelte applications.
    3. Utility implementations and APIs should be simple and flexible.

    At the end of the day, what we want is for this library to be pretty light-weight, simple, and understandable.

    Contributors

    Ben Monro
    Ben Monro

    💻 ⚠️ 🤔 📖
    Emil Tholin
    Emil Tholin

    💻 ⚠️ 🤔
    Tim Deschryver
    Tim Deschryver

    📖
    Eduardo Rabelo
    Eduardo Rabelo

    ⚠️ 💻

    Thanks goes to these people (emoji key):

    This project follows the all-contributors specification. Contributions of any kind welcome!

    Docs

    Read The Docs | Edit the docs

    Issues

    Looking to contribute? Look for the Good First Issue label.

    🐛 Bugs

    Please file an issue for bugs, missing documentation, or unexpected behavior.

    See Bugs

    💡 Feature Requests

    Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.

    See Feature Requests

    ❓ Questions

    For questions related to using the library, please visit a support community instead of filing an issue on GitHub.

    LICENSE

    MIT

    Keywords

    none

    Install

    npm i svlt-testing-library

    DownloadsWeekly Downloads

    1

    Version

    1.5.1

    License

    none

    Unpacked Size

    38.5 kB

    Total Files

    18

    Last publish

    Collaborators

    • benmonro