Support for generating SVG components without .defaultProps
#129
+111
−25
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -25,30 +25,51 @@ export default declare(({ | |||||
| SVG_NAME, | ||||||
| SVG_CODE, | ||||||
| SVG_DEFAULT_PROPS_CODE, | ||||||
| EMIT_DEPRECATED_DEFAULT_PROPS, | ||||||
| }) => { | ||||||
| const defaultProps = SVG_DEFAULT_PROPS_CODE | ||||||
| ? 'var props = objectAssignPolyfill()({}, SVG_DEFAULT_PROPS_CODE, overrides);' | ||||||
| : ''; | ||||||
| const PROPS_NAME = SVG_DEFAULT_PROPS_CODE ? 'overrides' : 'props'; | ||||||
|
|
||||||
| const namedTemplate = ` | ||||||
| var SVG_NAME = function SVG_NAME(PROPS_NAME) { ${defaultProps} return SVG_CODE; }; | ||||||
| ${SVG_DEFAULT_PROPS_CODE && EMIT_DEPRECATED_DEFAULT_PROPS ? 'SVG_NAME.defaultProps = SVG_DEFAULT_PROPS_CODE;' : ''} | ||||||
| ${IS_EXPORT ? 'export { SVG_NAME };' : ''} | ||||||
| `; | ||||||
| const anonymousTemplate = ` | ||||||
| var Component = function (PROPS_NAME) { ${defaultProps}; return SVG_CODE; }; | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| ${SVG_DEFAULT_PROPS_CODE && EMIT_DEPRECATED_DEFAULT_PROPS ? 'Component.defaultProps = SVG_DEFAULT_PROPS_CODE;' : ''} | ||||||
| Component.displayName = 'EXPORT_FILENAME'; | ||||||
| export default Component; | ||||||
| `; | ||||||
|
|
||||||
| if (SVG_NAME !== 'default') { | ||||||
| return template(namedTemplate)({ | ||||||
| SVG_NAME, | ||||||
| SVG_CODE, | ||||||
| SVG_DEFAULT_PROPS_CODE, | ||||||
| PROPS_NAME, | ||||||
| }); | ||||||
| } | ||||||
| return template(anonymousTemplate)({ | ||||||
| SVG_CODE, | ||||||
| SVG_DEFAULT_PROPS_CODE, | ||||||
| EXPORT_FILENAME, | ||||||
| PROPS_NAME, | ||||||
| }); | ||||||
| }; | ||||||
|
|
||||||
| function applyPlugin(importIdentifier, importPath, path, state, isExport, exportFilename) { | ||||||
| if (typeof importPath !== 'string') { | ||||||
| throw new TypeError('`applyPlugin` `importPath` must be a string'); | ||||||
| } | ||||||
| const { | ||||||
| ignorePattern, | ||||||
| caseSensitive, | ||||||
| filename: providedFilename, | ||||||
| emitDeprecatedDefaultProps = false, | ||||||
|
There was a problem hiding this comment. @ljharb I mentioned in the PR description, but JIC, this is a breaking change if this is default I think that since react went with the warnings this is a good thing (no warnings out of the box experience), but as a lib consumer I also don't love breaking changes 😞 though IMO, just reading the change log should do it 🤷 |
||||||
| } = state.opts; | ||||||
| const { file, filename } = state; | ||||||
| let newPath; | ||||||
| if (ignorePattern) { | ||||||
|
|
@@ -93,6 +114,8 @@ export default declare(({ | |||||
| SVG_CODE: svgCode, | ||||||
| IS_EXPORT: isExport, | ||||||
| EXPORT_FILENAME: exportFilename, | ||||||
| // https://github.com/facebook/react/pull/16210 | ||||||
| EMIT_DEPRECATED_DEFAULT_PROPS: emitDeprecatedDefaultProps, | ||||||
| }; | ||||||
|
|
||||||
| // Move props off of element and into defaultProps | ||||||
|
|
@@ -124,6 +147,8 @@ export default declare(({ | |||||
|
|
||||||
| file.get('ensureReact')(); | ||||||
| file.set('ensureReact', () => {}); | ||||||
| file.get('ensureObjectAssign')(); | ||||||
| file.set('ensureObjectAssign', () => {}); | ||||||
| } | ||||||
| return newPath; | ||||||
| } | ||||||
|
|
@@ -138,6 +163,20 @@ export default declare(({ | |||||
| if (typeof filename === 'undefined' && typeof opts.filename !== 'string') { | ||||||
| throw new TypeError('the "filename" option is required when transforming code'); | ||||||
| } | ||||||
|
|
||||||
| if (!path.scope.hasBinding('object.assign/polyfill')) { | ||||||
| const assignDeclaration = t.importDeclaration([ | ||||||
| t.importDefaultSpecifier(t.identifier('objectAssignPolyfill')), | ||||||
| ], t.stringLiteral('object.assign/polyfill')); | ||||||
|
|
||||||
| file.set('ensureObjectAssign', () => { | ||||||
| const [newPath] = path.unshiftContainer('body', assignDeclaration); | ||||||
| newPath.get('specifiers').forEach((specifier) => { path.scope.registerBinding('module', specifier); }); | ||||||
| }); | ||||||
| } else { | ||||||
| file.set('ensureObjectAssign', () => {}); | ||||||
| } | ||||||
|
|
||||||
| if (!path.scope.hasBinding('React')) { | ||||||
| const reactImportDeclaration = t.importDeclaration([ | ||||||
| t.importDefaultSpecifier(t.identifier('React')), | ||||||
|
|
||||||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import SVG from './close.svg'; | ||
|
|
||
| export function MyFunctionIcon() { | ||
| return <SVG />; | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where does "overrides" come from? is that a react thing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nop, thats just renamed props, I didn't want to change the body (
SVG_CODE) so I made a little rename here, the final function will be