Enforce _snippets folder rules for includes
#190
Merged
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
Added validation to ensure `{include}` only supports files from `_snippets/` and detects cyclical references. Introduced `SnippetFile` and updated tests to reflect these changes. Renamed example snippet for clarity.
reakaleek
approved these changes
Jan 14, 2025
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.
Added validation to ensure
{include}only supports files from_snippets/and detects cyclical references. IntroducedSnippetFileand updated tests to reflect these changes. Renamed example snippet for clarity.Previously we were simply ignoring all files in
_*folders asExcludedFileinstances.Now files in
_snippetsfolders are of typeSnippetFilewhich participate better inDocumentationSet's mechanics.E.g they now contribute to
LastWriteso changes in snippets break incremental compilation correctly.Added more tests to ensure this new rules are enforced as well as a test to ensure snippets do not end up in
links.json