Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Include clarification about using @wordpress/babel-plugin-import-jsx-pragma with @wordpress/babel-preset-default #14482

Merged
merged 1 commit into from
Mar 18, 2019

Conversation

gziolo
Copy link
Member

@gziolo gziolo commented Mar 18, 2019

Description

Closes #14381. Improves our docs to make it easier to resolve potential conflicts when upgrading @wordpress/babel-preset-default from version < 4.0.0 to the latest version when using with @wordpress/babel-plugin-import-jsx-pragma.

…t-jsx-pragma with @wordpress/babel-preset-default
@gziolo gziolo merged commit 7748b8e into master Mar 18, 2019
@gziolo gziolo deleted the fix/14381-babel-preset branch March 18, 2019 08:31
@youknowriad youknowriad added this to the 5.3 (Gutenberg) milestone Mar 18, 2019
@@ -30,6 +30,8 @@ module.exports = {
};
```

_Note:_ `@wordpress/babel-plugin-import-jsx-pragma` is now included in `@wordpress/babel-preset-default` (default preset for WordPress development). If you are using it, you shouldn't need to include this plugin anymore in your Babel config.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This reads as a temporary note which won't age well. Do we have a planned schedule on if / when it would no longer be valuable to include?

Copy link
Member Author

@gziolo gziolo Mar 19, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't think about it initially. However, I agree with your point, we should remove it in a month or something like that. I added it to my todo list. Should I open PR with a related description?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't think about it initially. However, I agree with your point, we should remove it in a month or something like that. I added it to my todo list. Should I open PR with a related description?

I don't have a strong preference on timeline; I personally don't think the note was needed in the first place† 😅 A month can be fine. If we're soon to publish packages going into feature freeze, I suppose it could be merged immediately afterward, with the assumption the next publish wouldn't be for some time. Otherwise it becomes an issue of how do we keep the schedule.

† To me, the perfect scenario would be that the plugin gracefully handles the case that it's included twice. The next best thing would be a clear note that the preset and plugin cannot be used in combination. Re-reading this text, I think it's fairly clear. It may have just been that the phrases "now" and "anymore" caught my attention as sounding temporary and not associated with any sense of when "now" actually occurred. "As of vX.X.X" might have served as an alternative pinned to a specific point in time.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Another try in #14530 😅

@gziolo gziolo added the [Tool] Babel plugin import JSX pragma /packages/babel-plugin-import-jsx-pragma label Mar 20, 2019
youknowriad pushed a commit that referenced this pull request Mar 20, 2019
…t-jsx-pragma with @wordpress/babel-preset-default (#14482)
youknowriad pushed a commit that referenced this pull request Mar 20, 2019
…t-jsx-pragma with @wordpress/babel-preset-default (#14482)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Tool] Babel plugin import JSX pragma /packages/babel-plugin-import-jsx-pragma [Type] Developer Documentation Documentation for developers
Projects
None yet
4 participants