Move entity-provider.js exports into hooks/index.ts so they are added to the docs #63528
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
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
ryanwelcher
added
the
[Type] Developer Documentation
ryanwelcher
changed the title
ryanwelcher
changed the title
|
Size Change: +190 B (+0.01%) Total Size: 1.75 MB
ℹ️ View Unchanged
|
|
Maybe we should move the entity hooks into the |
|
Do we know why the file is not pulled into the README? AFAIK docgen documents all public exports no? |
Doc gen only pulls in files that are referenced in the tokens in the readme. There is a reference to the hooks.ts file but none for the entity-provider.js file and the hooks that files contains are not exported in hooks.ts so they are missed |
|
@ryanwelcher makes sense, so why are we not updating the README.md file's tokens instead? |
|
@youknowriad I did that at first but thought we should keep all of the hooks together in the code base. I'm fine either way so if we're concerned about moving imports that would be the approach with the least amount of risk. |
|
I don't mind, I was just trying to understand why it was not working. For me, we shouldn't be adapting the code to the docs but If these things (hooks/intex.ts and entity-provider.js) are considered similar, it would make sense to group them in the code as well. That said, it seems EntityProvider exposes more than just hooks. It also exposes a component. |
youknowriad
reviewed
Jul 16, 2024
i would say that they are related as they all work with entities. The useEntityRecord and useEntityRecord are in the hooks directory. |
|
I think @Mamaduka suggestion probably makes the most sense here. Unless you have any concerns with that @youknowriad , I'll update the PR |
|
I'm not sure I understand the suggestion. If it's about moving the hooks to Otherwise, I'm also ok with the current PR as it stands. |
|
Sounds good to me @youknowriad. To be clear, I was planning on moving the hooks in I'll get the PR updated now. |
ryanwelcher
requested review from
tellthemachines,
spacedmonkey,
desrosj,
ajitbohra,
peterwilsoncc,
gziolo,
ntwb,
draganescu,
adamziel,
kevin940726 and
ellatrix
as code owners
ryanwelcher
requested review from
geriux,
juanmaguitar,
fabiankaegy and
ndiego
as code owners
ryanwelcher
force-pushed
the
fix/add-use-entity-props-to-docs
branch
from
9a385a7 to
43ab67e
Compare
ryanwelcher
commented
Jul 16, 2024
| import { updateFootnotesFromMeta } from './footnotes'; | ||
|
|
||
| const EMPTY_ARRAY = []; | ||
| import { createContext, useContext, useMemo } from '@wordpress/element'; | ||
|
|
||
| const EntityContext = createContext( {} ); |
There was a problem hiding this comment.
@Mamaduka @youknowriad I just wanted to call this out as there was a single EntityContext being used across the hooks and to move the useEntityId hook into it's own file, I needed to create the same there.
I don't see any errors/failures but wanted to be sure that doing this won't cause any unexpected outcome.
There was a problem hiding this comment.
No, that's a mistake, it should use the exact same EntityContext in all the files. You can do so by creating an entity-context file and importing it in all the files.
There was a problem hiding this comment.
Updated with latest commit. Thanks for confirming, it felt like that was a bad idea :)
ryanwelcher
requested review from
Mamaduka
and removed request for
draganescu,
adamziel,
spacedmonkey,
desrosj,
peterwilsoncc,
ntwb,
ajitbohra,
nerrad,
ellatrix,
geriux,
artemiomorales,
kevin940726 and
tellthemachines
youknowriad
approved these changes
Jul 17, 2024
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Jul 18, 2024
… to the docs (WordPress#63528) * Reapply changes to fix bad rebase. * Update import for entity-provider.js tests. * Create a common EntityContext and import to appropriate places. Co-authored-by: ryanwelcher <welcher@git.wordpress.org> Co-authored-by: youknowriad <youknowriad@git.wordpress.org> Co-authored-by: Mamaduka <mamaduka@git.wordpress.org> Co-authored-by: Taigistal <silaskoehler@git.wordpress.org>
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.
What?
The hooks defined in
core-data/entity-provider.jsare not documented because the file is not being pulled into the README.md for docgen to generate.Closes: #63475.
Why?
These hooks should be documented under https://developer.wordpress.org/block-editor/reference-guides/packages/packages-core-data/#hooks
How?
I have move all of the hooks in
entity-provider.jsinto their own files inside thehooksdirectory and exported them from there. This will have them be picked up by the docgen tool and add them to the documentation.Testing Instructions
useEntityPropis still available on thewp.coreDataglobal and there are no errors in the block editor.