feat: sort when syncing by parent #973
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
kellyjosephprice
changed the title
kellyjosephprice
requested review from
erunion and
kanadgupta
and removed request for
erunion
kanadgupta
requested changes
Feb 12, 2024
src/lib/syncDocsPath.ts
Outdated
Comment on lines
138
to
142
| const doc = frontMatter(fsSync.readFileSync(filePath, 'utf8')); | ||
| const slug = path.basename(filePath).replace(extensionRegexp, ''); | ||
| const parentDocSlug = doc.data.parentDocSlug; | ||
|
|
||
| return { filePath, slug, parentDocSlug }; |
src/lib/syncDocsPath.ts
Outdated
|
|
||
| const dependencies = Object.values(filesBySlug).reduce( | ||
| (edges, obj) => { | ||
| if (obj.parentDocSlug) { |
There was a problem hiding this comment.
i know we have users that sync only parts of their docs using rdme, i think we should probably also ensure that the parent file actually exists
(also let me know if i'm misunderstanding how this works!)
Suggested change
| if (obj.parentDocSlug) { | |
| if (obj.parentDocSlug && filesBySlug[obj.parentDocSlug]) { |
src/lib/syncDocsPath.ts
Outdated
| @@ -127,6 +130,40 @@ async function pushDoc( | |||
| }); | |||
| } | |||
|
|
|||
| function sortFiles(files: string[], { allowedFileExtensions }: { allowedFileExtensions: string[] }): string[] { | |||
There was a problem hiding this comment.
this function appears to use parentDocSlug, is there any way we add basic support for parentDoc? i know it uses object IDs so there's no way for us to build a graph, but at the very least we could make it so docs that have a parentDoc attribute get synced after ones that lack one?
kellyjosephprice
force-pushed
the
feat/sort-sync-heirarchy
branch
from
afe367d
to
86e7ae1
Compare
kanadgupta
approved these changes
Feb 14, 2024
Comment on lines
-33
to
+36
| const { content, data, hash, slug } = readDoc(filePath); | ||
| const { content, data, filePath, hash, slug } = fileData; |
There was a problem hiding this comment.
this refactor (i.e., decoupling the readDoc so we can read the contents prior to sorting) is very clever!
Co-authored-by: Kanad Gupta <[email protected]>
Co-authored-by: Kanad Gupta <[email protected]>
kellyjosephprice
force-pushed
the
feat/sort-sync-heirarchy
branch
from
0d41b9a
to
5c95884
Compare
kanadgupta
pushed a commit
that referenced
this pull request
Feb 15, 2024
# [9.0.0-next.11](v9.0.0-next.10...v9.0.0-next.11) (2024-02-15) ### Features * sort when syncing by parent ([#973](#973)) ([9795840](9795840)) [skip ci]
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.
🧰 Changes
When syncing docs, it sorts them by their parents!
Users reported issues where if a parent document was in a directory, it could error out because it would get synced after one of its children.
🧬 QA & Testing
Not sure 😬.