fix(plugin-auto-nav-sidebar): Exclude config.route.exclude files from auto-generated sidebar #899
Conversation
This file contains 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
…exclude files from auto-generated sidebar
…ion, fixed globby import, fixed empty folder appearing in sidebars, fixed changeset
|
|
✅ Deploy Preview for aquamarine-blini-95325f ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
sanyuan0704
previously approved these changes
Apr 8, 2024
| @@ -32,7 +34,15 @@ export async function scanSideMeta( | |||
| sideMeta = (await fs.readJSON(metaFile, 'utf8')) as SideMeta; | |||
| } catch (e) { | |||
| // If the `_meta.json` file doesn't exist, we will generate the sidebar config from the directory structure. | |||
| const subItems = await fs.readdir(workDir); | |||
|
|
|||
| const includedFiles = globby.sync('**', { | |||
There was a problem hiding this comment.
Here globby.sync will traverse all the files and subdirectories under the directory but we only want to traverse the first level. You can change the params as follows:
globby.sync('*', {
cwd: workDir,
ignore: excludedFiles ?? [],
expandDirectories: false,
onlyFiles: false,
});There was a problem hiding this comment.
Hello @sanyuan0704
This doesn't work for the use case assets/**/* I used in my original issue. With assets/**/* it is necessary to match the files under the directory.
I will still add expandDirectories: false + my second method because I think users excluding assets/**/* will be fine excluding assets/**
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.
Summary
When no
_meta.jsonis found, instead of going through all children, useglobbyto exclude files defined inconfig.route.exclude.Related Issue
#848 [Bug]: Excluded routes still appear in the no-config sidebars
Checklist
pnpm run change.