Data collections and references #6850
Merged
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
🦋 Changeset detectedLatest commit: c8a715a The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
github-actions
bot
added
pkg: astro
bholmesdev
force-pushed
the
feat/data-collections
branch
from
4f5503b to
e34e28a
Compare
|
!preview data-collections |
|
This PR is blocked because it contains a |
bholmesdev
force-pushed
the
feat/data-collections
branch
from
573c4f0 to
a1abd14
Compare
|
!preview data-collections |
|
|
I'm concerned about the fact that each file format might become a new folder name is this the only folder for data that is not markdown? What about other files? |
I know you guys said you were going to support content collections. But I wonder what other formats are you going to support? I wonder whether or not other folders would be taken from people. I think from now on it's better to stop taking top level folders from people and instead just take folders in content collections. I'm saying this because with this PR four folders are taken from people. One of them being |
|
@louiss0 To clarify, we do not require or own an As for the proliferation of folders, that is a good concern to keep in mind. As we see it, there won't be further "collection" types beyond content and data, so I'd expect |
|
|
Oh, I'm pro moving the |
|
I'm also concerned about Markdoc. They are written here. |
bholmesdev
force-pushed
the
feat/data-collections
branch
from
fadee16 to
9cc4539
Compare
|
@louiss0 I'm also the active maintainer of |
That thing has problems I tried to file an issue but that was shut down by Matt. I think you are the one to solve the problems from that issue. He told me to spilt up each of the problems into different issues But I think they are too small. Here's the link to the issues #6829 (comment). |
Keep going bud. I'm in no rush to use Markdoc. I care more about Assets right now. I just decided to put my thoughts out there. I don't know how much you are going to extend it or if Remark is going to be involved but I just hope we don't lose the DX of using mdx too much. |
bholmesdev
force-pushed
the
feat/data-collections
branch
from
65aa7e1 to
b2b98b6
Compare
sarah11918
reviewed
May 16, 2023
There was a problem hiding this comment.
These error messages are super-nicely done, @bholmesdev! I would be honoured to make a mistake with my collections! Just a couple of thoughts for you to consider below!
Co-authored-by: Sarah Rainsberger <[email protected]>
Co-authored-by: Sarah Rainsberger <[email protected]>
bluwy
reviewed
May 17, 2023
ematipico
reviewed
May 17, 2023
There was a problem hiding this comment.
There are some TODO in the code, but I don't understand when you aim to address them. This PR? Next PR? Maybe a mention in the description of the PR could shed some light;
There are a few places where we need to catch errors:
- I/O operations, it's minor but you never the permissions of the file system
JSON.parse, very important. If the contents of a file are not a valid JSON object, the function will throw a runtime error.
| if (entryType !== 'content' && entryType !== 'data') return; | ||
|
|
||
| const collection = getEntryCollectionName({ contentDir, entry: pathToFileURL(filePath) }); | ||
| if (!collection) throw UnexpectedLookupMapError; |
There was a problem hiding this comment.
Learn from the best ❤️
matthewp
approved these changes
May 17, 2023
ematipico
approved these changes
May 17, 2023
Merged
ArmandPhilippot
added a commit
to ArmandPhilippot/astro-docs
that referenced
this pull request
Jul 29, 2024
* See withastro/astro#7607 for the most recent exported types * See withastro/astro#6850 for `reference()` * See `packages/astro/types/content.d.ts` for `schema` type (might need a refactor) * `getDataEntryById` is missing but since `getEntryBySlug` is announced as deprecated I don't know if we should add it (so no change here)
ArmandPhilippot
added a commit
to ArmandPhilippot/astro-docs
that referenced
this pull request
Jul 29, 2024
* See withastro/astro#7607 for the most recent exported types * See withastro/astro#6850 for `reference()` * See `packages/astro/types/content.d.ts` for `schema` type (might need a refactor) * `getDataEntryById` is missing but since `getEntryBySlug` is announced as deprecated I don't know if we should add it (so no change here)
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.
Demo
Visual.Studio.Code.-.config.ts.with-data.-.2.May.2023.mp4
Implementation for the data collection and collection reference RFCs: withastro/roadmap#569
Changes
Introducing data collections! These are JSON-based collections you can query throughout your app, and "reference" from existing content collections.
src/data/directory for storing collections of JSON entries. This uses the same file-based conventions as content collections.type: 'data'property todefineCollectionto configure a data collection from yoursrc/content/config.ts.getEntry(). Data collections do not have slugs, so we cannot use the existinggetEntryBySlug()helper.reference()extension function to any configured collection. This can be used like a table join in a database, referencing other collections by key.Testing
syncDocs
withastro/docs#3233