New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: use chaijs/loupe for inspection #1401
Conversation
I think we'd like https://github.com/chaijs/loupe to display |
I think this one is a good change, please comment if you disagree |
In both of these instances the changes are welcome I think. |
Alright, thanks for the confirmation. For the next ones, I suggest you just add an emoji on the github comment to say that you're OK with the change or add a new comment if you're not. |
Using ISO format for printing dates:
|
Unquoted complex key in objects:
|
We'll need to fix chaijs/loupe#44 as well |
A bit more complex: when using prototype properties, Object.create({tea: 'chai'}) We use to show it as regular properties:
We now exclude them which makes it less readable:
What do you think? |
|
Typed array:
|
I think this is a regression. Ideally loupe would give us inspections which are syntactically valid and can be pasted into a REPL with minimal editing. I think loupe should detect if it needs quotes and add them. |
This looks like a regression. I'd expect |
This is intentional. It is useful to know what typed array class is being inspected. We should update chai here. |
Another one: it('inspect with custom stylize-calling inspect()s', function () {
chai.use(function (_chai, _) {
var obj = {
outer: {
inspect: function (depth, options) {
return options.stylize('Object content', 'string');
}
}
};
expect(_.inspect(obj)).to.equal('{ outer: Object content }');
});
});
|
What does nodejs do here? To me the loupe example seems correct but I’d be interested in Nodes output as it has the same API |
For reference this is Node's API. So the test is correct and I should fix the code. |
To make progress on this, I would now need some reviews on loupe pull requests. @keithamus can you take a look please? https://github.com/chaijs/loupe/pulls |
All fixes on loupe and been merged and published to npm. This should be able to progress now. |
@pcorpet I've also invited you to the chai org as a maintainer for loupe! |
Thanks for the review, this PR should now be good for review as the tests pass. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This LGTM but perhaps a second set of eyes would be good. @flaambe as you worked on this before, do you think this looks good?
}, "expected { tea: \'chai\' } to deeply equal { tea: \'black\' }"); | ||
}, "expected {} to deeply equal {}"); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like we're losing data here. Perhaps this should be a feature of loupe that if the object has no own-properties then it can inspect the prototype to make it more useful for instances like this?
message: 'expected [ Array(4) ] to equal [ Array(4) ]' | ||
message: "expected [ 'string1', 'string2', …(2) ] to equal [ 'string5', 'string6', …(2) ]" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is so much nicer IMO 👌
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, but I was thinking we are going to replace lib/chai/utils/inspect.js
completely?
I agree that's definitely the ultimate goal here. Merging this PR gets us a lot closer to that though so I'm happy to ship this. |
@pcorpet did you want to try porting this PR to the |
* Fixed a regression that caused SyntaxErrors on IE 11 The changes made in #1334 incorrectly used an arrow function and as this isn't supported on IE 11 it causes a SyntaxError to be thrown when loading chai. * chai@4.3.2 * export chai.Assertion (#1378) * chai@4.3.3 * fix: support inspecting bigints (#1321) (#1383) * 4.3.4 * feat: use chaijs/loupe for inspection (#1401) (#1407) Fix #1228 * fix: package.json - deprecation warning on exports field (#1400) * fix package.json exports * build(deps-dev): bump codecov from 3.1.0 to 3.7.1 (#1446) Bumps [codecov](https://github.com/codecov/codecov-node) from 3.1.0 to 3.7.1. - [Release notes](https://github.com/codecov/codecov-node/releases) - [Changelog](https://github.com/codecov/codecov-node/blob/master/CHANGELOG.md) - [Commits](codecov/codecov-node@v3.1.0...v3.7.1) --- updated-dependencies: - dependency-name: codecov dependency-type: direct:development ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * build chaijs * 4.3.5 * fix: use loupe@^2.3.1 * build chaijs * 4.3.6 * fix: deep-eql bump package to support symbols comparison (#1483) * 4.3.7 * build * chore: 4.x.x: Fix link to commit logs on GitHub (#1487) * 4.x.x: Fix link to commit logs on GitHub As there is no `master` branch, the link returned a 404. * Update History.md Co-authored-by: Andre Meyering <info@andremeyering.de> Co-authored-by: Keith Cirkel <keithamus@users.noreply.github.com> * build(deps): bump socket.io-parser from 4.0.4 to 4.0.5 (#1488) Bumps [socket.io-parser](https://github.com/socketio/socket.io-parser) from 4.0.4 to 4.0.5. - [Release notes](https://github.com/socketio/socket.io-parser/releases) - [Changelog](https://github.com/socketio/socket.io-parser/blob/main/CHANGELOG.md) - [Commits](socketio/socket.io-parser@4.0.4...4.0.5) --- updated-dependencies: - dependency-name: socket.io-parser dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * test: fix typo in test.js (#1459) * docs: specify return type of objDisplay (#1490) previously it was incorrectly labeled as `objDisplay(obj: object): void` in `@types/chai`. * feat: rework into ES modules This moves all of the sources to be ES modules rather than CommonJS. In order to produce the entrypoints, we use esbuild as a bundler (and as a transpiler in a way). Due to the fact that some dependencies are written in CommonJS, we actually use esbuild to create _two_ bundles: a CommonJS bundle, and an ES module bundle. Otherwise, someone importing the raw source would inevitably end up trying to import a CommonJS module somewhere down the tree, which would not work in browsers natively. --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Lee Newson <lnewso@hotmail.com> Co-authored-by: Keith Cirkel <keithamus@users.noreply.github.com> Co-authored-by: rbruckheimer <rob@cosaic.io> Co-authored-by: Mike Frysinger <vapier@gmail.com> Co-authored-by: Pascal Corpet <pcorpet@users.noreply.github.com> Co-authored-by: Mimi <stevenjoezhang@gmail.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Scott Newcomer <snewcomer@users.noreply.github.com> Co-authored-by: Andre Meyering <info@andremeyering.de> Co-authored-by: Mavaddat Javid <5055400+mavaddat@users.noreply.github.com> Co-authored-by: scarf <greenscarf005@gmail.com> Co-authored-by: James Garbutt <james.garbutt@crispthinking.com>
Fix #1228
Note that for now this is just a quick attempt to explore which diffs are OK in the error messages and which ones we'd like to fix in
loupe
before merging.