-
Notifications
You must be signed in to change notification settings - Fork 503
Add reference to Nu Plugin Tracer in the Nushell Book. #1372
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
Conversation
I've been on the fence about this PR, here's why. We allow other 3rd party software to be mentioned in our docs, but this is not just an external tool but something that is tied to the deep "guts" of nushell plugins. So, it makes me feel responsible that it always works, even though it's not nushell owned software. I'm not trying to make a case to "own" your software. Just sharing my feelings to have a conversation. I think we can probably land this. 🤔 The last thing that bothers me about this tool is that there's no on/off switch. Correct me if I'm wrong, but once you "turn it on" with If it's not already in our awesome_nu repo, it could definitely go there. I don't have the same feelings about that repo. |
I did think about adding it to awesome_nu, but I decided against it. Here's why. The tracer is not a plugin per se. It's a tool for plugin developers. So it ought to be referenced from the place that plugin developers look to learn how to create plugins. In contrast, the list of plugins on awesome_nu is a reference for end users. Unless you envisage a new section, say Tools for Plugin Developers? But that would be a pretty small section so far! 😁 |
I have no objections to another section. Also, I ran into another problem. Since it's named in the same style as a plugin, it's easily mistaken for a plugin and fails to be registered with So, for me, having it named like a plugin isn't great. Also, as mentioned previously, not having some type of on/off switch makes it a little tricky to use too. There should at least be a warning that you'll fill up your file system if you don't disable it. |
Yes, I've also had reservations about the name. How about I'll add a warning to the README about the ongoing accumulation of trace output. (I don't think it's worth adding an actual feature to mitigate that though, would make it unreasonably complicated.) |
Yes, I think that's even more descriptive.
Sounds good. I'll land this PR with these changes. |
That's done. 😎 |
I thought you were going to put a warning here too? |
Ah sorry, I can also do that if you like. |
Its also in the README for trace_nu_plugin
How's that? |
Looks good. Just one small change to help people know how to remove a plugin since it's new. |
Co-authored-by: Darren Schroeder <[email protected]>
Thanks! |
No description provided.