Add notes about glob()'s normalization of ids in upgrade guides#13704
Open
OverflowCat wants to merge 1 commit intowithastro:mainfrom
Open
Add notes about glob()'s normalization of ids in upgrade guides#13704OverflowCat wants to merge 1 commit intowithastro:mainfrom
glob()'s normalization of ids in upgrade guides#13704OverflowCat wants to merge 1 commit intowithastro:mainfrom
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
OverflowCat
changed the title
glob()'s normalization of ids in v6 upgrade guideglob()'s normalization of ids in upgrade guides
Member
ArmandPhilippot
left a comment
ArmandPhilippot
left a comment
There was a problem hiding this comment.
Thank you, I think this can be helpful! I left two suggestions: I think we have a more helpful link and, I'm not quite sure about the current format for the v5 guide.
| }); | ||
| ``` | ||
|
|
||
| Different from content collections, the `glob()` loader normalizes `id`s to kebab-cased slugs by default, so hard-coded `id`s including capital letters (like `getEntry("UpperCase")`) in your code may break. You can pass a custom [`generateID()` helper function](/en/reference/content-loader-reference/#generateid) to override this behavior. |
Member
There was a problem hiding this comment.
What about something like:
Suggested change
| Different from content collections, the `glob()` loader normalizes `id`s to kebab-cased slugs by default, so hard-coded `id`s including capital letters (like `getEntry("UpperCase")`) in your code may break. You can pass a custom [`generateID()` helper function](/en/reference/content-loader-reference/#generateid) to override this behavior. | |
| By default, the `glob()` loader generates an ID by converting all uppercase letters to lowercase. Therefore, you may need to check and update your calls to `getEntry()` or [use the `generateId()` helper to restore the old behavior](/en/guides/content-collections/#defining-custom-ids). |
- Unless I'm mistaken, what has changed is not really the slugs in kebab-case but the identifier in lowercase, so we should probably be more direct in drawing attention to this new behavior.
- We have an example in the content collections guide to restore the old behavior. So, it might be more helpful to use that link rather than the reference.
| 1. **Move the content config file**. This file no longer lives within the `src/content/` folder. This file should now exist at `src/content.config.ts`. | ||
|
|
||
| 2. **Edit the collection definition**. Your updated collection requires a `loader` which indicates both a folder for the location of your collection (`base`) and a `pattern` defining the collection entry filenames and extensions to match. (You may need to update the example below accordingly. You can use [globster.xyz](https://globster.xyz/) to check your glob pattern.) The option to select a collection `type` is no longer available. | ||
| 2. **Edit the collection definition**. Your updated collection requires a `loader` which indicates both a folder for the location of your collection (`base`) and a `pattern` defining the collection entry filenames and extensions to match. (You may need to update the example below accordingly. You can use [globster.xyz](https://globster.xyz/) to check your glob pattern.) The option to select a collection `type` is no longer available. Different from content collctions, the `glob()` loader normalizes `id`s to a kebab-cased slug by default, so hard-coded `id`s that contain capital letters (like `getEntry("UpperCase")`) in your code may break. You can pass a custom [`generateID()` helper function](/en/reference/content-loader-reference/#generateid) to override this behavior. |
Member
There was a problem hiding this comment.
This step is becoming very long and hard to parse. And, the code snippet below doesn't display generateId().
I wonder if it wouldn't be more readable to use the wording suggested for the v6 upgrade guide and place it below the code snippet.
ArmandPhilippot
added
the
improve or update documentation
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This PR updates the documentation to clarify that collection entry IDs are automatically lowercased when migrating legacy content collections to
glob(). In legacy content collections, file names with uppercase characters could be used directly as IDs, whileglob()normalizes them to kebab-case. This change is currently not clearly documented in the migration guide, which may lead to confusion for users.Related issues & labels