Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update jsdoc for ignore-prefix to clarify ignored files #27065

Merged
merged 3 commits into from
May 7, 2024
Merged

docs: update jsdoc for ignore-prefix to clarify ignored files #27065

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ba80b1e
Update JSDoc for ignorePrefix to clarify ignored files
sossost May 5, 2024
aa1f379
Remove 'store/' from ignorePrefix in JSDoc and restore stylish change
sossost May 6, 2024
a301336
docs : add docs indentation
sossost May 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 4 additions & 2 deletions packages/schema/src/config/common.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,8 +397,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/`, and `public/` directories will be ignored during
* the build process if its filename starts with the prefix specified by `ignorePrefix`. This is intended to prevent
* certain files from being processed or served in the built application.
* By default, the `ignorePrefix` is set to '-', ignoring any files starting with '-'.
*/
ignorePrefix: {
$resolve: val => val ?? '-',
Expand Down