Add site.json properties for file exclusions #1328
Merged
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.
What is the purpose of this pull request? (put "X" next to an item, remove the rest)
• [X] Enhancement to an existing feature
Resolves #715
What is the rationale for this request?
With the usage of globs for defining pages to render, if there are any files or directories within the glob that the user wishes to exclude, there is no concise way for them to declare it. It would be better to have a dedicated file exclusion rule for this purpose.
What changes did you make? (Give an overview)
Added two new properties:
globExcludecan be used inside each entry ofpages, whose value is an array that contains glob patterns to be excluded. The exclusions will only affect files found for that particular entry.pagesExcludeis the global variant ofglobExclude, designed to be used on the root level and will affect all entries.Users can choose which property to use for their exclusions. If both are used at the same time, it will be combined into one.
Is there anything you'd like reviewers to focus on?
NA
Testing instructions:
npm run testProposed commit message: (wrap lines at 72 characters)
Add site.json properties for file exclusions
When using globs to define pages, there is no concise way for users to
declare files or directories to exclude within the glob.
Let's add new properties to site.json for containing file patterns to
exclude and incorporate these during site building.