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

Jump to bottom

Detect and apply stripping flow types #1864

Merged
merged 9 commits into from Aug 23, 2018
Merged

Detect and apply stripping flow types #1864

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
98dbe99
detect and apply stripping flow types
DeMoorJasper Aug 8, 2018
9511e97
add test
DeMoorJasper Aug 8, 2018
9301f5e
improve test
DeMoorJasper Aug 8, 2018
48bff7e
performance improvement
DeMoorJasper Aug 8, 2018
3e5a158
using Reg.test and also use on source
DeMoorJasper Aug 23, 2018
d10df94
merge
DeMoorJasper Aug 23, 2018
ac94de4
merge configs
DeMoorJasper Aug 23, 2018
73c46c0
reorder flow check
DeMoorJasper Aug 23, 2018
e74e92e
fix missing dep
DeMoorJasper Aug 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Expand Up @@ -20,6 +20,7 @@
"babel-core": "^6.25.0",
"babel-generator": "^6.25.0",
"babel-plugin-transform-es2015-modules-commonjs": "^6.26.0",
"babel-plugin-transform-flow-strip-types": "^6.22.0",
"babel-plugin-transform-react-jsx": "^6.24.1",
"babel-preset-env": "^1.7.0",
"babel-template": "^6.26.0",
Expand Down
23 changes: 23 additions & 0 deletions src/transforms/babel.js
View file
Open in desktop
Expand Up @@ -103,6 +103,7 @@ async function getBabelConfig(asset) {

let envConfig = await getEnvConfig(asset, isSource);
let jsxConfig = await getJSXConfig(asset, isSource);
let flowConfig = getFlowConfig(asset, isSource);

// Merge the babel-preset-env config and the babelrc if needed
if (babelrc && !shouldIgnoreBabelrc(asset.name, babelrc)) {
Expand Down Expand Up @@ -148,6 +149,11 @@ async function getBabelConfig(asset) {
return jsxConfig;
}

// If there is a Flow config, return that
if (flowConfig) {
Copy link
Member

Choose a reason for hiding this comment

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

I guess we also need to merge the flow config with the generated env/jsx configs above right?

Copy link
Member Author

Choose a reason for hiding this comment

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

Probably, fixed it

return flowConfig;
}

// Otherwise, don't run babel at all
return null;
}
Expand Down Expand Up @@ -301,3 +307,20 @@ async function getJSXConfig(asset, isSourceModule) {
};
}
}

/**
* Generates a babel config for stripping away Flow types.
*/
function getFlowConfig(asset, isSourceModule) {
if (
!isSourceModule &&
Copy link
Member

Choose a reason for hiding this comment

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

Should this be the inverse? Wouldn't we want to enable flow on app code and locally linked modules? I'm not sure enabling it on published node_modules is a good idea. WDYT?

Copy link
Member Author

Choose a reason for hiding this comment

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

The issue is published code, as they shouldn't ship with flow types, local code should follow babelrc.

Shipped code should probably use flow comments or seperate .flow files

Copy link
Member

Choose a reason for hiding this comment

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

I think it would be a nice feature to enable flow automatically on source code just like we do for JSX.

Shipped code should generally be pre-transpiled to remove the types I thought... Not sure, I guess it doesn't hurt to automatically do it for everything.

Copy link
Member Author

Choose a reason for hiding this comment

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

It should, but apparently not every module does it as you can see in the linked issue

asset.contents.substring(0, 20).indexOf('@flow') > -1
Copy link
Member Author

Choose a reason for hiding this comment

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

https://jsperf.com/includes-vs-substring-includes-vs-indexof/1 Performance test for this line

Copy link
Member

Choose a reason for hiding this comment

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

Should we ensure that this is inside a comment? like look for // @flow or something?

Copy link
Member Author

Choose a reason for hiding this comment

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

The issue is that it can be // @flow or /* @flow */ or any other variation of comment. So either we'd have to use a regex or do a babel walk to just detect this. Which would probably slow things down.

I can change it to a regex or babel walk just not sure about performance (Probably regex).

Copy link
Member

Choose a reason for hiding this comment

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

Yeah a regex would be ok (on the substring). Should be fast enough.

) {
return {
plugins: [[require('babel-plugin-transform-flow-strip-types')]],
internal: true
};
}

return null;
}
5 changes: 5 additions & 0 deletions test/integration/babel-strip-flow-types/index.js
View file
Open in desktop
@@ -0,0 +1,5 @@
const flowModule = require('flow-typed');

module.exports = function() {
return flowModule();
}
4 changes: 4 additions & 0 deletions test/integration/babel-strip-flow-types/node_modules/flow-typed/index.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 13 additions & 0 deletions test/javascript.js
View file
Open in desktop
Expand Up @@ -1346,4 +1346,17 @@ describe('javascript', function() {
assert(output.includes('<html>'));
assert(output.includes('Other page'));
});

it('should strip away flow types of node modules', async function() {
let b = await bundle(
__dirname + '/integration/babel-strip-flow-types/index.js'
);

let output = await run(b);
assert.equal(typeof output, 'function');
assert.equal(output(), 'hello world');

let file = await fs.readFile(__dirname + '/dist/index.js', 'utf8');
assert(!file.includes('OptionsType'));
});
});
11 changes: 11 additions & 0 deletions yarn.lock
View file
Open in desktop
Expand Up @@ -539,6 +539,10 @@ babel-plugin-syntax-exponentiation-operator@^6.8.0:
version "6.13.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-exponentiation-operator/-/babel-plugin-syntax-exponentiation-operator-6.13.0.tgz#9ee7e8337290da95288201a6a57f4170317830de"

babel-plugin-syntax-flow@^6.18.0:
version "6.18.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-flow/-/babel-plugin-syntax-flow-6.18.0.tgz#4c3ab20a2af26aa20cd25995c398c4eb70310c8d"

babel-plugin-syntax-jsx@^6.8.0:
version "6.18.0"
resolved "https://registry.yarnpkg.com/babel-plugin-syntax-jsx/-/babel-plugin-syntax-jsx-6.18.0.tgz#0af32a9a6e13ca7a3fd5069e62d7b0f58d0d8946"
Expand Down Expand Up @@ -737,6 +741,13 @@ babel-plugin-transform-exponentiation-operator@^6.22.0:
babel-plugin-syntax-exponentiation-operator "^6.8.0"
babel-runtime "^6.22.0"

babel-plugin-transform-flow-strip-types@^6.22.0:
version "6.22.0"
resolved "https://registry.yarnpkg.com/babel-plugin-transform-flow-strip-types/-/babel-plugin-transform-flow-strip-types-6.22.0.tgz#84cb672935d43714fdc32bce84568d87441cf7cf"
dependencies:
babel-plugin-syntax-flow "^6.18.0"
babel-runtime "^6.22.0"

babel-plugin-transform-react-jsx@^6.24.1:
version "6.24.1"
resolved "https://registry.yarnpkg.com/babel-plugin-transform-react-jsx/-/babel-plugin-transform-react-jsx-6.24.1.tgz#840a028e7df460dfc3a2d29f0c0d91f6376e66a3"
Expand Down