RFC: Kint 6 #422
Comments
|
6.0-beta2 out
|
|
Nice work, didn't had the time to look at everything yet but would like to give feedback about
It's something I use sometimes as specially if the view area of kint is really limited, so maybe an button to open a "full screen" model which is on the highest dom level would be an alternative? |
Sounds like you want |
|
yeah I know the docked function, but for normally use it's a bit not optimal tbh, so with a button it would be a good solution, but I wouldn't but it the bottom, instead on top would be better but that's another story. |
|
Another interesting thing would be to customize the last line (with the stacktrace), I know that doesn't fit into this issue. But adding metadata to the rendered output would be nice, I can of course do this with my own additional line but having this as an programmable interface would be nice. Example I would like replace the simple stacktrace with an more complex variant (ex. counting the how often a function has been called in this trace (recursion)). Or having a second column with other meta information like how often this this specific kint in this line in this file has been called. Useful for loops. And I'm pretty sure I there is more useful information that could be displayed, like user information, memory usage, cpu spikes, you name it. I use kint warped in my own joomla plugin which prepare the usage, so filling the kint::statics would be easily possible before outputting kint. hmm I think that should be move to it's own issue... |
Number of calls/memory usage/timing info is there if you dump That said, you can (And I have in the past) extend the renderer itself and change whatever you want. All the RichRenderer props/methods are protected so you just subclass it and change the |
|
@HLeithner I've taken a crack at the dynamic-moving-of-the-dumps-to-folder work. Can you try out 055bc6f and see if that does what you want? (It's f in keyboard control mode) |
|
@jnvsor works as expected, on top would be good ;-) and moved back to the position before, but both is not really needed. I converted my own plugin to this version, a migration guide would be helpful but it wasn't too hard to find out the changes (it's a simple plugin). Thanks |
|
about the renderer topic
kint is a moving target which makes it hard to override things like you said, having to adapt own code often is not so fun as it sounds ;-) we at joomla have a strict semver policy (and sometimes fails) with a stable release cycle of 4 years and people are annoyed that we change anything... of course this tool has a different target group. never the less I will have a look at this. |
I think you can manage that with just CSS
I make no guarantees about JS but kint doesn't break semver on the PHP side (Or else it's a bug and should be reported) Obviously no guarantees about 6.0 before release either |
|
Beta 3 is now out:
|
|
On the sublevel the complexity is collected in the "Perfomance Profile" tab
on the first level the "Performance Profile" shows the complexity for it self and for all subentries
"Class Complexity" shows the subentries as a variable dump
Is it expected? |
|
@HLeithner The performance profile is a lot easier to grok if you use it in something massive and complex like a framework's container:
This lets you know which specific instances are being used all over the place and making the dump slower, but it doesn't tell you if you have many different instances of a specific class or interface, so class complexity shows the total complexity found under each class/interface:
This is much harder to read and full of false postives (Like you probably don't want to blacklist all stringables even if there are a lot of them) but helps if what you're dumping has many heavy instances of the same type. |
|
Ah ok, that makes more sense, that's thanks |
|
6.0-beta4:
|
|
6.0-beta5:
|
|
Just noticed this, interesting changes for Kint 6!
Sad to see this feature go away, I used it seldom on good old days when the front-end and back-end of an application lived in harmony together. I wasn't aware that the code relies on obfuscation to bypass browser pop-up window blocks, I mean this really shouldn't be required, as the developer certainly has the option to allow-list the domain they are working on. It was a cool handy feature. I guess other methods are available. Also a cool feature would be to get a exported
Seems like a good re-write, I agree in the modern age of web development, 12KB isn't really much when the other aspects of the application goes into MB. Still, miss the quite handy and compact tool, but reality is we don't write apps like we used to do ten years ago.
Never used the http/https scheme for this, also I use VS Code as an IDE more than IntelliJ-based IDEs such as PhpStrom, which supported application link schemes from the get go. BTW, On the CLI, Kint dumps the file path, which both the terminal (e.g. Windows Terminal) and VS Code will happily take me to the specified file an line number using some sort of keyboard combination (e.g. Alt-Click or Ctrl-Click) In both cases (CLI and Web) this is pretty useful! 👍🏻
|
|
Some more thoughts regarding the theming:
|
As discussed with HLeithner I ended up replacing it with a dynamic "Move to folder" button that gives you a larger viewing space without opening a new window context, which is the best of both worlds
The old JS was 4 files totalling 13kb but it would try to cleverly only dump the ones needed so while the new JS is now 15k in practice that 15k is 30k if you dump with both plain and rich. But dumping a symfony request is +170k, a container from a fresh symfony install is +4mb, and container from a fresh sylius/drupal install is ~80mb. A warm system with loads of services can easily reach into multiple GB of output (And then your browser is the performance bottleneck not the server) So I'm really not worried about a few kb more JS
This would require dumping at least 2 themes on start - one for light mode and one for dark mode. Currently the themes aren't designed to be dynamically switchable, if you load two at once it'd be some weird blend of the two. So you'd have to output two stylesheets and throw one away with JS. Is this a good idea?
Agreed. Unfortunately I have the artistic sense of a mole. (Blind and leaves a mess) I can implement a design or color scheme if you come up with one but don't ask me to come up with one myself :) If this is well designed and using more modern css variables that can be changed browser side, we could figure out a way to roll auto dark mode into it, but I've never looked into that. Could you start an issue and start thinking about new design stuff?
Oh good point. I'll have to look into this. Let me open a new issue
Way ahead of you. I'm just doing an out of the box esbuild now (It doesn't try to transpile to an older subset at all)
It's not window.open that's the problem, it's inserting script and style tags into the newly opened window. And it's not just browsers either. For instance the 5.1.1 code had to have a mktag function that just wrapped whatever you sent it in
No, it's been expanded, it's just that kint 1.0 wasn't extensible at all and there have been a lot of changes made to improve that over the years that never got documentation. |
I was actually thinking of loading one by default (which is also useful on non-JS enabled environments, like the developer console preview) then use JS to detect enabled dark mode and load that one. But this isn't even needed. Instead of relying on two themes with different color schemes (e.g. Using this: Which means that in the SCSS, the default light mode is used. But upon the existence of So we have:
If you are going to drop IE support, this can be paired with css variables which means a truely awesome experience for applying customizations to the color schemes with minimal lines of stylesheets being added at all. I also suggest creating a cool looking
For sure, I would love to contribute some values for the new color scheme. Functionality and eye strain prevention are top priorities, and I would prefer a very modern and cool looking design. The original theme could either use more contrast and vibrant colors, or stay to pale colors (also known as pastel, which is easy on the eyes). I just need some basic information about the layout and structure of the scss files, I can refactor to use CSS variables and then add dark mode into it without any worries.
That's awesome. Let's discuss more about theming in there.
Oh, I see, this is because Kint is rendering the content in the PHP side. You know, I was thinking of implementing a pure JS Kint app that is able to render the same thing as PHP, but from a serialized string. Wouldn't that be cool? 😉 Maybe in Kint 7 or the future. Imagine the possibilities: We can store a serialized string in the database during bug report/crash report (Laravel uses Symfony and provides such feature). Then later we would be able to see the dumps made and render it using Kint. Currently I resort to ob_* buffer feature of PHP to capture the entire HTML output that is generated by Kint. As said, just an idea! 😄
It's never late to document the features that Kint provides. Also happy to contribute in that area, but I have no idea where to start. Fortunately, GitHub Copilot is superb at generating good documentation based on the code, so maybe we can start at that. My colleagues hadn't even heard of Kint, one mentioned to me he had seen it but opted to use Symfony's dumper utility since it had more docs on especial use cases. He was blown away by the feature set that Kint provides. In my opinion we need to make sure people know what they're going to miss if they don't use Kint! 😄 |
kint-js renderer used to be a thing but it was a simplified dump compared to rich. I tried rewriting rich in vue for performance once. Turns out it's way less performant to add 10k dom elements from a virtual dom than to just set 10k preexisting elements display:block and let the browser reflow. So I'm not sure if this'll be worth the effort but you're welcome to give it a try
Yeah you could already do that if you made your own renderer. It's even documented:
Well clearly my documentation is lacking given the last few points but I question how good the quality of AI docs will be: Kint has a lot of weird stuff and recursion that it may not be great at handling. I think the "Using kint as a tool" part of the docs is fine, it's "Using kint as a library" that gets people confused. I'm thinking I should take the "Improving Kint" and "Writing plugins" part of the documentation and put them into a subsection (named "API" perhaps?) where I can expand on internal docs. |
|
6.0-beta6:
Because of the sheer engorged mass of this refactor I'm not going to bother updating the docs just yet - it'll change more before it's done. Next steps:
|
|
Also the CSS rewrite which I'll be submitting as a PR soon to support auto dark more and some tweaks - sorry been a bit busy at work, but super excited to include this as well! |
|
6.0-beta7:
Besides a few minor things that can be done after 6.0 releases I have 3 main issues:
I won't have time to put much more work into kint so I'll try and restrain myself from coming up with new improvements before php 8.4 release @DRSDavidSoft With less than a month before 6.0 has to be done, there's not much time left to review your changes. Will you have them soon or should we delay to a minor version? (I'm not particularly worried about breaking CSS BC) |
|
6.0-beta8:
Since the rest of my todo list is stuff that can be implemented without a breaking change I'm first going to make sure |
|
RC1 is out now:
Some test coverage issues and a bugfix are all that's left on my plate, anything else will wait for 6.1. Stable release should be in the next few days |
|
I updated my joomla plugin and it's kint plugin for rc1 and it works so far. Thanks. A bit more control about the output would be nice. Or maybe I don't recognize the possibilities. |
|
@HLeithner If you just want to add information, that's what plugins do. The JSON tab when you dump a json string is just a plugin you could write yourself just as easily. Pretty much every part of kint besides the main parser can be switched out at will. If you want to change the appearance of the bar itself you'd need a combination of a parser plugin and a renderer plugin, or maybe the theme if you just want to change the appearance. Shoot in an issue with specifics about what you want to do and I'll give you some suggestions. |
|
And we're live! Thanks for the feedback guys |
If you've been paying attention to the repo you may have noticed a lot of commits showing up. Since the PHP 8.4 feature freeze on the 13th I've been working on a new major version with 7.4 as the minimum requirement.
It's essentially ready to go (Though I will only be publishing beta tags for now) but I'd like some feedback since among other things the JS has been completely rewritten and modernized.
I've got much less experience in JS than in PHP so if any JS devs have any suggestions in that area I'd welcome those too.
Semi-complete list of changes:
Kint.init()run gets triggered somewherekint-ide-linkbehavior removed. You can setKint::$file_link_format(orxdebug.file_link_format) to get a link to source code, which is great for opening an editor right to a dump or stack trace frame. It had custom behavior of sending an AJAX request if the link is in http or https protocol that seems to have been used for VERY old phpstorm versions. Nowadays you can just set a protocol link, which is recommended by eg. symfony docs way back in symfony 2AbstractRenderer- old code should still work but now it'll work for plain styles/code tooConstructable..interfaces<!DOCTYPE html>intoDom\HTMLDocumentlike the XMLPlugin doesFor now, barring any feedback, I'm going to see if I can eke out more perf with cachegrind
The text was updated successfully, but these errors were encountered: