Skip to content

Report and forgive missing plugins in make_docs.nu#2017

Merged
hustcer merged 1 commit into
nushell:mainfrom
Kissaki:fix/makedocs-plgerr
Sep 6, 2025
Merged

Report and forgive missing plugins in make_docs.nu#2017
hustcer merged 1 commit into
nushell:mainfrom
Kissaki:fix/makedocs-plgerr

Conversation

@Kissaki
Copy link
Copy Markdown
Contributor

@Kissaki Kissaki commented Aug 23, 2025

Example screenshot of constructed error case:

image

Resolves #2010


I would have preferred an error exit, but I'm not sure how to do that in a way that it works for this script both when calling it as a script via nu as well as when running it via source then make_docs command.

Checking for invalid paths, reporting them and skipping them seems like a reasonable improvement, especially in the context of #2010 (runtime errors further down the script and command pipeline).

@fdncred
Copy link
Copy Markdown
Contributor

fdncred commented Aug 23, 2025

This could lead to incomplete documentation which I wouldn't be in favor of.

@Kissaki
Copy link
Copy Markdown
Contributor Author

Kissaki commented Aug 23, 2025

Should it run through and do nothing, or is an exit call fine?

When I used exit and called it via nu make_docs.nu it seemed to exit the parent too.

@fdncred
Copy link
Copy Markdown
Contributor

fdncred commented Aug 23, 2025

I'll leave it for @hustcer to decide what he wants to do since he regenerates docs

@hustcer
Copy link
Copy Markdown
Contributor

hustcer commented Sep 6, 2025

Thanks, I can accept this change, and I won't create the PR if any error happens next time.

@hustcer hustcer merged commit 2d7b505 into nushell:main Sep 6, 2025
2 checks passed
@Kissaki Kissaki deleted the fix/makedocs-plgerr branch September 6, 2025 08:59
jexjws pushed a commit to jexjws/nushell.github.io that referenced this pull request Sep 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

make_docs.nu does not take kindly to being run without plugins installed

3 participants