Shortcodes: Update readfile to throw compile error when file not found #1457
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update readfile shortcode to throw a compile error when the file is not found. Currenlty the shortcode prints a message on the UI, which presents a problem when refactoring a docs site. A UI message requires visual conformation and is easy to miss when moving or renaming directories.
|
@LisaFC can someone review this please? |
|
Looks fine to me, but @geriom can you take a look as you wrote the original shortcode? |
LisaFC
approved these changes
Apr 17, 2023
deining
reviewed
Apr 17, 2023
There was a problem hiding this comment.
A UI message requires visual conformation and is easy to miss when moving or renaming directories.
I see the point, and yes, I consider this PR an improvement and agree that throwing a compile error should be made the default behaviour. However, I can imagine situations where throwing a compile error is unwanted (e.g. with draft documents). What about adding and evaluating a shortcode parameter draft? With attribute draft set to true, the current behaviour (printing out an error message in the code) would apply. This way, one could author:
{{< readfile draft=true >}}
...
{{< /readfile >}}
Without parameter draft, a compile error would be thrown.
Just my tow cents ....
deining
approved these changes
Apr 18, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
readfileshortcode to throw a compile error when the file is not found.Currently the shortcode prints a message on the UI, which presents a problem when refactoring a docs site. A UI message requires visual conformation and is easy to miss when moving or renaming directories. Throwing a compile error ensures the tech writer knows there is a problem.
With this modification, the default behavior is to throw a compile error:
Alternately, the user can display a message on the page instead of having Hugo throw a compile error (this implements deining's suggestion)