docs: update jsdoc for ignore-prefix to clarify ignored files #27065
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
|
|
manniL
requested changes
May 5, 2024
manniL
reviewed
May 5, 2024
packages/schema/src/config/common.ts
Outdated
| @@ -397,8 +442,10 @@ export default defineUntypedSchema({ | |||
| ignoreOptions: undefined, | |||
|
|
|||
| /** | |||
| * Any file in `pages/`, `layouts/`, `middleware/` or `store/` will be ignored during | |||
| * building if its filename starts with the prefix specified by `ignorePrefix`. | |||
| * Any file in `pages/`, `layouts/`, `middleware/`, `store/`, and `public/` directories will be ignored during | |||
There was a problem hiding this comment.
I think store can be removed here (was Nuxt 2 specific).
Besides that, it'd be good to check in the code which other parts are affected
There was a problem hiding this comment.
@manniL oh. I'm sorry. I ran lint:fix to see if stylistic changes are allowed.
There was a problem hiding this comment.
Oh, if they are from lint:fix that that's fine 馃檲
danielroe
approved these changes
May 7, 2024
Draft
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.
馃敆 Linked issue
#27064
馃摎 Description
This commit updates the JSDoc comments to clarify the behavior of the
ignorePrefixsetting in the configuration. The updated documentation now explicitly states that any file inpages/,layouts/,middleware/,store/, andpublic/directories will be ignored during the build process if its filename starts with the prefix specified byignorePrefix.