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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions packages/babel-plugin-import-jsx-pragma/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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 😅


## Options

As the `@babel/transform-react-jsx` plugin offers options to customize the `pragma` to which the transform references, there are equivalent options to assign for customizing the imports generated.
Expand Down
2 changes: 1 addition & 1 deletion packages/babel-preset-default/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
### Breaking Change

- Removed `babel-core` dependency acting as Babel 7 bridge ([#13922](https://github.com/WordPress/gutenberg/pull/13922). Ensure all references to `babel-core` are replaced with `@babel/core` .
- Preset updated to include `@wordpress/babel-plugin-import-jsx-pragma` plugin integration ([#13540](https://github.com/WordPress/gutenberg/pull/13540)).
- Preset updated to include `@wordpress/babel-plugin-import-jsx-pragma` plugin integration ([#13540](https://github.com/WordPress/gutenberg/pull/13540)). It should no longer be explicitly included in your Babel config.

### Bug Fix

Expand Down