Skip to content

Emit class components to circumvent defaultProps warnings #131

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Emit class components to circumvent defaultProps warnings #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40e9be1
refactor: emit class components
Grohden Feb 16, 2025
147de9c
refactor: use createReactClass instead
Grohden Feb 17, 2025
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
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
"dependencies": {
"@babel/helper-plugin-utils": "^7.0.0",
"@babel/parser": "^7.0.0",
"create-react-class": "^15.7.0",
"lodash.isplainobject": "^4.0.6",
"resolve": "^2.0.0-next.5",
"svgo": "^2.8.0"
Expand Down
30 changes: 25 additions & 5 deletions src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,18 @@ export default declare(({
SVG_DEFAULT_PROPS_CODE,
}) => {
const namedTemplate = `
var SVG_NAME = function SVG_NAME(props) { return SVG_CODE; };
${SVG_DEFAULT_PROPS_CODE ? 'SVG_NAME.defaultProps = SVG_DEFAULT_PROPS_CODE;' : ''}
var SVG_NAME = createReactClass({
render: function() { var props = this.props; return SVG_CODE; },
${SVG_DEFAULT_PROPS_CODE ? 'getDefaultProps: function() { return SVG_DEFAULT_PROPS_CODE; }' : ''}
});
${IS_EXPORT ? 'export { SVG_NAME };' : ''}
`;
const anonymousTemplate = `
var Component = function (props) { return SVG_CODE; };
${SVG_DEFAULT_PROPS_CODE ? 'Component.defaultProps = SVG_DEFAULT_PROPS_CODE;' : ''}
Component.displayName = 'EXPORT_FILENAME';
var Component = createReactClass({
displayName: EXPORT_FILENAME,
render: function() { var props = this.props; return SVG_CODE; },
${SVG_DEFAULT_PROPS_CODE ? 'getDefaultProps: function() { return SVG_DEFAULT_PROPS_CODE; }' : ''}
});
export default Component;
`;

Expand Down Expand Up @@ -124,6 +128,8 @@ export default declare(({

file.get('ensureReact')();
file.set('ensureReact', () => {});
file.get('ensureCreateReactClass')();
file.set('ensureCreateReactClass', () => {});
}
return newPath;
}
Expand All @@ -138,6 +144,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('create-react-class')) {
const assignDeclaration = t.importDeclaration([
t.importDefaultSpecifier(t.identifier('createReactClass')),
], t.stringLiteral('create-react-class'));

file.set('ensureCreateReactClass', () => {
const [newPath] = path.unshiftContainer('body', assignDeclaration);
newPath.get('specifiers').forEach((specifier) => { path.scope.registerBinding('module', specifier); });
});
} else {
file.set('ensureCreateReactClass', () => {});
}

if (!path.scope.hasBinding('React')) {
const reactImportDeclaration = t.importDeclaration([
t.importDefaultSpecifier(t.identifier('React')),
Expand Down
5 changes: 5 additions & 0 deletions test/fixtures/test-props.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import SVG from './close.svg';

export function MyFunctionIcon() {
return <SVG />;
}
73 changes: 55 additions & 18 deletions test/sanity.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,31 @@ import path from 'path';
import transformTs from '@babel/plugin-transform-typescript';
import inlineReactSvgPlugin from '../src';

function assertReactImport(result) {
const match = result.code.match(/import React from ['"]react['"]/g);
if (!match) {
throw new Error('no React import found');
function assertMatchImport(name, matchRegex) {
return (result) => {
const match = result.code.match(matchRegex());
if (!match) {
throw new Error(`no ${name} import found`);
}
if (match.length !== 1) {
throw new Error(`more or less than one match found: ${match}\n${result.code}`);
}
};
}

const assertReactImport = assertMatchImport('React', () => /import React from ['"]react['"]/g);

const assertCreateReactClassImport = assertMatchImport('createReactClass', () => /import createReactClass from ['"]create-react-class['"]/g);

function assertDefaultProps(shouldExist, result) {
const exists = (/getDefaultProps:/g).test(result.code);

if (!exists && shouldExist) {
throw new Error('getDefaultProps needs to be present');
}
if (match.length !== 1) {
throw new Error(`more or less than one match found: ${match}\n${result.code}`);

if (exists && !shouldExist) {
throw new Error('getDefaultProps shouldn\'t be present');
}
}

Expand All @@ -29,8 +47,10 @@ transformFile('test/fixtures/test-import.jsx', {
}, (err, result) => {
if (err) throw err;
assertReactImport(result);
assertCreateReactClassImport(result);
assertDefaultProps(true, result);
validateDefaultProps(result);
console.log('test/fixtures/test-import.jsx', result.code);
console.log('test/fixtures/test-import.jsx\n', result.code);
});

transformFile('test/fixtures/test-multiple-svg.jsx', {
Expand All @@ -42,8 +62,10 @@ transformFile('test/fixtures/test-multiple-svg.jsx', {
}, (err, result) => {
if (err) throw err;
assertReactImport(result);
assertCreateReactClassImport(result);
assertDefaultProps(true, result);
validateDefaultProps(result);
console.log('test/fixtures/test-multiple-svg.jsx', result.code);
console.log('test/fixtures/test-multiple-svg.jsx\n', result.code);
});

transformFile('test/fixtures/test-no-react.jsx', {
Expand All @@ -54,8 +76,10 @@ transformFile('test/fixtures/test-no-react.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-no-react.jsx', result.code);
console.log('test/fixtures/test-no-react.jsx\n', result.code);
assertReactImport(result);
assertCreateReactClassImport(result);
assertDefaultProps(true, result);
validateDefaultProps(result);
});

Expand All @@ -78,8 +102,10 @@ transformFile('test/fixtures/test-no-duplicate-react.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-no-duplicate-react.jsx', result.code);
console.log('test/fixtures/test-no-duplicate-react.jsx\n', result.code);
assertReactImport(result);
assertCreateReactClassImport(result);
assertDefaultProps(true, result);
validateDefaultProps(result);
});

Expand Down Expand Up @@ -111,7 +137,7 @@ transformFile('test/fixtures/test-no-svg-or-react.js', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-no-svg-or-react.js', result.code);
console.log('test/fixtures/test-no-svg-or-react.js\n', result.code);
if (/React/.test(result.code)) {
throw new Error('Test failed: React import was present');
}
Expand Down Expand Up @@ -145,7 +171,7 @@ transformFile('test/fixtures/test-dynamic-require.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-dynamic-require.jsx', result.code);
console.log('test/fixtures/test-dynamic-require.jsx\n', result.code);
});

const filename = 'test/fixtures/test-import-read-file.jsx';
Expand All @@ -156,7 +182,7 @@ transform(fs.readFileSync(filename), {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-import-read-file.jsx', result.code);
console.log('test/fixtures/test-import-read-file.jsx\n', result.code);
});

transformFile('test/fixtures/test-export-default.jsx', {
Expand All @@ -166,7 +192,7 @@ transformFile('test/fixtures/test-export-default.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-export-default.jsx', result.code);
console.log('test/fixtures/test-export-default.jsx\n', result.code);
});

transformFile('test/fixtures/test-export-default-as.jsx', {
Expand All @@ -182,7 +208,7 @@ transformFile('test/fixtures/test-export-default-as.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-export-default-as.jsx', result.code);
console.log('test/fixtures/test-export-default-as.jsx\n', result.code);
});

transformFile('test/fixtures/test-export-all-as.jsx', {
Expand All @@ -192,7 +218,7 @@ transformFile('test/fixtures/test-export-all-as.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-export-all-as.jsx', result.code);
console.log('test/fixtures/test-export-all-as.jsx\n', result.code);
});

transformFile('test/fixtures/test-root-styled.jsx', {
Expand All @@ -202,7 +228,7 @@ transformFile('test/fixtures/test-root-styled.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-root-styled.jsx', result.code);
console.log('test/fixtures/test-root-styled.jsx\n', result.code);
});

transformFile('test/fixtures/test-commented.jsx', {
Expand All @@ -212,7 +238,18 @@ transformFile('test/fixtures/test-commented.jsx', {
],
}, (err, result) => {
if (err) throw err;
console.log('test/fixtures/test-commented.jsx', result.code);
console.log('test/fixtures/test-commented.jsx\n', result.code);
});

transformFile('test/fixtures/test-props.jsx', {
presets: ['airbnb'],
plugins: [
[inlineReactSvgPlugin, { emitDeprecatedDefaultProps: true }],
],
}, (err, result) => {
if (err) throw err;
assertDefaultProps(true, result);
console.log('test/fixtures/test-props.jsx\n', result.code);
});

/* TODO: uncomment if babel fixes its parsing for SVGs
Expand Down