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

fix(father-build): babel runtime resolve logic #484

Merged
merged 5 commits into from
May 25, 2022
Merged

fix(father-build): babel runtime resolve logic #484

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
260e8ab
fix(father-build): babel runtime resolve logic
PeachScript May 24, 2022
fb2430e
test(father-build): add case for local babel runtime
PeachScript May 24, 2022
63c7e44
refactor(father-build): use real cwd for babel runtime
PeachScript May 24, 2022
532e7dd
refactor(father-build): use babel runtime version from project deps
PeachScript May 24, 2022
5d616a4
refactor(father-build): correct babel runtime for rollup mode
PeachScript May 24, 2022
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 packages/father-build/src/babel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@ export default async function (opts: IBabelOpts) {
nodeVersion,
lazy: cjs && cjs.lazy,
lessInBabelMode,
cwd,
});
if (importLibToEs && type === "esm") {
babelOpts.plugins.push(require.resolve("../lib/importLibToEs"));
Expand Down
6 changes: 6 additions & 0 deletions packages/father-build/src/fixtures/build/babel-runtime-local/.fatherrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

export default {
runtimeHelpers: true,
esm: { type: 'babel' },
cjs: { type: 'babel' },
}
25 changes: 25 additions & 0 deletions packages/father-build/src/fixtures/build/babel-runtime-local/expected/es/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import _defineProperty from "@babel/runtime/helpers/esm/defineProperty";
import _classCallCheck from "@babel/runtime/helpers/esm/classCallCheck";
import _createClass from "@babel/runtime/helpers/esm/createClass";

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

var A = /*#__PURE__*/function () {
function A() {
_classCallCheck(this, A);
}

_createClass(A, [{
key: "foo",
value: function foo() {}
}]);

return A;
}();

new A().foo();
var a = {};

var b = _objectSpread({}, a);
30 changes: 30 additions & 0 deletions packages/father-build/src/fixtures/build/babel-runtime-local/expected/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
"use strict";

var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");

var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));

var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));

var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2.default)(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

var A = /*#__PURE__*/function () {
function A() {
(0, _classCallCheck2.default)(this, A);
}

(0, _createClass2.default)(A, [{
key: "foo",
value: function foo() {}
}]);
return A;
}();

new A().foo();
var a = {};

var b = _objectSpread({}, a);
5 changes: 5 additions & 0 deletions packages/father-build/src/fixtures/build/babel-runtime-local/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"@babel/runtime": "7.0.0"
}
}
9 changes: 9 additions & 0 deletions packages/father-build/src/fixtures/build/babel-runtime-local/src/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@

class A {
foo() {}
}

(new A()).foo();

const a = {};
const b = {...a};
2 changes: 1 addition & 1 deletion packages/father-build/src/fixtures/build/rollup-runtimeHelpers/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"dependencies": {
"@babel/runtime": "0.1.0"
"@babel/runtime": "7.10.4"
}
}
4 changes: 3 additions & 1 deletion packages/father-build/src/getBabelConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ interface IGetBabelConfigOpts {
paths?: any[];
plugins?: any[];
};
cwd?: string;
}

function transformImportLess2Css() {
Expand Down Expand Up @@ -81,7 +82,8 @@ export default function(opts: IGetBabelConfigOpts) {
...(runtimeHelpers
? [[require.resolve('@babel/plugin-transform-runtime'), {
useESModules: isBrowser && (type === 'esm'),
version: require('@babel/runtime/package.json').version,
// use @babel/runtime version from project dependencies
version: require(`${opts.cwd}/package.json`).dependencies['@babel/runtime'],
Copy link

Choose a reason for hiding this comment

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

I suggest using try-catch with a fallback to undefined:

function getBabelRuntimeVersion(cwd) {
  try {
    return require(`${cwd}/package.json`).dependencies['@babel/runtime']
  } catch {}
}

This is because that require call might fail, for example if the user as an uncommon setup or if for some reason they put @babel/runtime in a different package.json.

By returning undefined in the error case, Babel will automatically output code that is compatible with every version starting from 7.0.0.

Copy link
Member Author

@PeachScript PeachScript May 24, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

It was removed on purpose, because there has a validation logic before this and I forgot just now, at:

father/packages/father-build/src/build.ts

Lines 50 to 55 in e38134e

assert.ok(existsSync(pkgPath), `@babel/runtime dependency is required to use runtimeHelpers`);
const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
assert.ok(
(pkg.dependencies || {})['@babel/runtime'],
`@babel/runtime dependency is required to use runtimeHelpers`
);

Copy link
Member Author

Choose a reason for hiding this comment

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

Thank you very much for your detailed comment ❤️

Copy link

Choose a reason for hiding this comment

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

Oh ok, that's good!

Thank you very much for your detailed comment ❤️

I'm happy to help 😄

}]]
: []),
...(process.env.COVERAGE
Expand Down
1 change: 1 addition & 0 deletions packages/father-build/src/getRollupConfig.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ export default function(opts: IGetRollupConfigOpts): RollupOptions[] {
typescript: true,
runtimeHelpers,
nodeVersion,
cwd,
}).opts),
// ref: https://github.com/rollup/plugins/tree/master/packages/babel#babelhelpers
babelHelpers: (runtimeHelpers ? 'runtime' : 'bundled') as RollupBabelInputPluginOptions['babelHelpers'],
Expand Down