Skip to content

Better user experience when using .include without .deep. #1619

@koddsson

Description

@koddsson

Given the following assertion:

expect({ tags: {} }).to.include({ tags: {} });

You get the following assertion error:

AssertionError: expected { tags: {} } to have property 'tags' of {}, but got {}

For those of us that have read the guide know that I really want to do:

expect({ tags: {} }).to.deep.include({ tags: {} });

According to the guide using .deep:

Causes all .equal, .include, .members, .keys, and .property assertions that follow in the chain to use deep equality instead of strict (===) equality. See the deep-eql project page for info on the deep equality algorithm: https://github.com/chaijs/deep-eql.

This isn't obvious from the usage though. I wonder if we could improve the user experience by point the user towards .deep in the assertion error?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions