Introduce React Scanner for component usage stats #65463
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
|
Size Change: 0 B Total Size: 1.81 MB ℹ️ View Unchanged
|
tyxla
changed the title
tyxla
force-pushed
the
try/react-scanner
branch
2 times, most recently
from
6ecd093
to
78cd111
Compare
tyxla
force-pushed
the
try/react-scanner
branch
from
78cd111
to
4116e4e
Compare
|
Flaky tests detected in f0d1022. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/11593170963
|
tyxla
changed the title
|
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. |
tyxla
force-pushed
the
try/react-scanner
branch
from
4116e4e
to
311ef37
Compare
ciampo
reviewed
Oct 23, 2024
| crawlFrom: './', | ||
| // Needed for properly reporting components with dot notation | ||
| includeSubComponents: true, | ||
| // Exclude usage in tests, stories, and React Native files. |
There was a problem hiding this comment.
I ran the command on my machine and it looks like the report is including some React Native usage information. I don't think that's expected?
There was a problem hiding this comment.
Ah, good catch. Seems like the globs doesn't work as expected. Seems like under the hood it uses a custom tool for the globbing part with different syntax - I'll fine-tune it next week to make it work.
There was a problem hiding this comment.
This should be fixed in a39d4db.
tyxla
force-pushed
the
try/react-scanner
branch
from
280a473
to
a39d4db
Compare
|
Ready for a last review when you get a chance @ciampo. Thanks! |
ciampo
reviewed
Oct 30, 2024
ciampo
approved these changes
Oct 30, 2024
|
Thanks @ciampo!
Potentially, as you recognized earlier.
Maybe in the future. I think limiting to component exports sounds good for a first pass. |
|
I'll proceed and ship, we can always tweak it further if necessary. |
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?
This PR introduces
react-scannerto keep an eye on component usage stats.Why?
It can be useful to track the adoption of our components over time.
How?
Running
react-scannerwith the default config to count components and props yields a result like this:{ "LinkPicker": { "instances": [ { "importInfo": { "imported": "LinkPicker", "local": "LinkPicker", "moduleName": "@wordpress/components", "importType": "ImportSpecifier" }, "props": { "value": "(Identifier)", "onLinkPicked": "(Identifier)", "onCancel": "(Identifier)" }, "propsSpread": false, "location": { "file": "gutenberg/packages/format-library/src/link/modal-screens/link-picker-screen.native.js", "start": { "line": 52, "column": 4 } } } ] }, "CardHeader": { "instances": [ { "importInfo": { "imported": "CardHeader", "local": "CardHeader", "moduleName": "@wordpress/components", "importType": "ImportSpecifier" }, "props": { "isBorderless": false, "justify": "left", "size": "small", "gap": "6" }, "propsSpread": false, "location": { "file": "gutenberg/packages/preferences/src/components/preferences-modal-tabs/index.js", "start": { "line": 142, "column": 10 } } } ] } }Testing Instructions
npm installnpm run component-usage-statsTesting Instructions for Keyboard
Same
Screenshots or screencast
None