babel-plugin-transform-replace-object-assign - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0-beta.0

CHANGELOG.md

@@ -5,2 +5,13 @@ # Changelog
 
+## 2.0.0-beta.0
+
+* Via [#3](https://github.com/newoga/babel-plugin-transform-replace-object-assign/pull/3):
+  * Updated dependencies.
+  * New plugin implementation for Babel v7.
+  * Use [@babel/helper-module-imports](https://npm.im/@babel/helper-module-imports) so the output is either ESM or CJS depending if `sourceType` is `module` or `script`, fixing [#1](https://github.com/newoga/babel-plugin-transform-replace-object-assign/issues/1).
+  * Added [`@babel/core`](https://npm.im/@babel/core) peer dependency, as Babel does for official plugins.
+  * Disabled and ignored `package-lock.json`.
+  * Replaced `lodash.assign` in readme examples with `object-assign` to demo defaults.
+  * New way to register Babel for Mocha tests.
+
 ## 1.0.0
@@ -11,9 +22,9 @@
   **This will replace `Object.assign` with `object-assign`:**
+
   ```json
   {
-    "plugins": [
-      ["transform-replace-object-assign"]
-    ]
+    "plugins": [["transform-replace-object-assign"]]
   }
   ```
+
 * **Breaking change:** The plugin configuration no longer supports passing a `string` module name. If you want to provide a custom `Object.assign` implementation, you must provide an `object` config with the name of the module specified in the `moduleSpecifier` key.
@@ -25,7 +36,6 @@
   {
-    "plugins": [
-      ["transform-replace-object-assign", "custom-module"]
-    ]
+    "plugins": [["transform-replace-object-assign", "custom-module"]]
   }
   ```
+
   **Should be changed to this:**
@@ -36,3 +46,6 @@
     "plugins": [
-      ["transform-replace-object-assign", { "moduleSpecifier": "custom-module}" }]
+      [
+        "transform-replace-object-assign",
+        { "moduleSpecifier": "custom-module" }
+      ]
     ]
@@ -39,0 +52,0 @@ }

lib/index.js

@@ -1,2 +0,2 @@
-'use strict';
+"use strict";
 
@@ -6,46 +6,21 @@ Object.defineProperty(exports, "__esModule", {
 });
+exports.default = _default;
 
-exports.default = function (_ref) {
+var _helperModuleImports = require("@babel/helper-module-imports");
+
+function _default(_ref) {
   var t = _ref.types;
-
   return {
     visitor: {
-      Program: {
-        enter: function enter(path, _ref2) {
-          var file = _ref2.file;
+      CallExpression: function CallExpression(path, _ref2) {
+        var file = _ref2.file,
+            opts = _ref2.opts;
 
-          file.set(OBJECT_ASSIGN, false);
-        },
-        exit: function exit(path, _ref3) {
-          var file = _ref3.file,
-              opts = _ref3.opts;
-
-          if (typeof opts === 'string') {
-            throw new Error('Configuring module specifier with a string is no longer supported. Configure with { "moduleSpecifier": "' + opts + '" } instead of "' + opts + '".');
-          }
-
-          var _opts$moduleSpecifier = opts.moduleSpecifier,
-              moduleSpecifier = _opts$moduleSpecifier === undefined ? 'object-assign' : _opts$moduleSpecifier;
-
-
-          if (!file.get(OBJECT_ASSIGN) && !path.scope.hasBinding(moduleSpecifier)) {
-            return;
-          }
-
-          var declar = t.importDeclaration([t.importDefaultSpecifier(file.get(OBJECT_ASSIGN))], t.stringLiteral(moduleSpecifier));
-
-          path.node.body.unshift(declar);
-        }
-      },
-
-      CallExpression: function CallExpression(path, _ref4) {
-        var file = _ref4.file;
-
         if (path.get('callee').matchesPattern('Object.assign')) {
-
-          if (!file.get(OBJECT_ASSIGN)) {
-            file.set(OBJECT_ASSIGN, path.scope.generateUidIdentifier('objectAssign'));
+          if (this.importCache) path.node.callee = t.cloneNode(this.importCache);else {
+            var _opts$moduleSpecifier = opts.moduleSpecifier,
+                moduleSpecifier = _opts$moduleSpecifier === void 0 ? 'object-assign' : _opts$moduleSpecifier;
+            this.importCache = (0, _helperModuleImports.addDefault)(file.path, moduleSpecifier);
+            path.node.callee = this.importCache;
           }
-
-          path.node.callee = file.get(OBJECT_ASSIGN);
         }
@@ -55,4 +30,2 @@ }
   };
-};
-
-var OBJECT_ASSIGN = 'ObjectAssign';
+}

package.json

 {
   "name": "babel-plugin-transform-replace-object-assign",
-  "version": "1.0.0",
+  "version": "2.0.0-beta.0",
   "description": "Allows you to provide custom implementation of Object.assign in babel builds",
@@ -13,2 +13,4 @@ "repository": {
   "scripts": {
+    "contributors:add": "all-contributors add",
+    "contributors:generate": "all-contributors generate",
     "build": "babel src --out-dir lib",
@@ -27,10 +29,17 @@ "bump-changelog": "./bump-changelog",
   ],
+  "peerDependencies": {
+    "@babel/core": "^7.0.0-beta.42"
+  },
+  "dependencies": {
+    "@babel/helper-module-imports": "^7.0.0-beta.42"
+  },
   "devDependencies": {
-    "babel-cli": "^6.4.5",
-    "babel-core": "^6.4.5",
-    "babel-preset-es2015": "^6.3.13",
+    "all-contributors-cli": "^4.11.1",
+    "@babel/cli": "^7.0.0-beta.42",
+    "@babel/core": "^7.0.0-beta.42",
+    "@babel/preset-es2015": "^7.0.0-beta.42",
+    "@babel/register": "^7.0.0-beta.42",
     "istanbul": "^0.4.2",
-    "mocha": "^2.4.5",
-    "simple-assign": "0.1.0"
+    "mocha": "^5.0.4"
   }
 }

README.md

 ## babel-plugin-transform-replace-object-assign
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors)
 [![Build Status](https://travis-ci.org/newoga/babel-plugin-transform-replace-object-assign.svg?branch=master)](https://travis-ci.org/newoga/babel-plugin-transform-replace-object-assign)
@@ -15,2 +16,3 @@ [![npm version](https://img.shields.io/npm/v/babel-plugin-transform-replace-object-assign.svg?style=flat-square)](https://www.npmjs.com/package/babel-plugin-transform-replace-object-assign)
 #### ⚠️ Important note on the use of this project:
+
 Most likely you do not and should not use this plugin! I initially wrote this plugin due to a [bug](https://bugs.chromium.org/p/v8/issues/detail?id=4118) in Chrome where key order was not gaurenteed to be correct for objects mutated with `Object.assign` (the issue is also described at [sindresorhus/object-assign#22](https://github.com/sindresorhus/object-assign/issues/22)).
@@ -33,3 +35,3 @@
 # Install an assign implementation
-$ npm install lodash.assign
+$ npm install object-assign
 ```
@@ -39,3 +41,3 @@
 
-When you provide the plugin, also specify which package you would like imported and used when replacing `Object.assign`.
+When you provide the plugin, use the `moduleSpecifier` option to specify which package you would like imported and used when replacing `Object.assign`.
 
@@ -47,3 +49,3 @@ **.babelrc**
   "plugins": [
-    ["transform-replace-object-assign", { "moduleSpecifier": "lodash.assign" }]
+    ["transform-replace-object-assign", { "moduleSpecifier": "object-assign" }]
   ]
@@ -53,2 +55,10 @@ }
 
+To use defaults (which is the same as above):
+
+```json
+{
+  "plugins": ["transform-replace-object-assign"]
+}
+```
+
 #### Result
@@ -65,6 +75,17 @@
 ```js
-import _lodash from 'lodash.assign';
+import _objectAssign from 'object-assign';
 
-_lodash(a, b)
+_objectAssign(a, b);
+```
 
-```
+## Contributors
+
+Thanks goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore -->
+| [<img src="https://avatars2.githubusercontent.com/u/344018?v=4" width="100px;"/><br /><sub><b>Neil Gabbadon</b></sub>](https://github.com/newoga)<br />[💻](https://github.com/newoga/babel-plugin-transform-replace-object-assign/commits?author=newoga "Code") [📖](https://github.com/newoga/babel-plugin-transform-replace-object-assign/commits?author=newoga "Documentation") | [<img src="https://avatars3.githubusercontent.com/u/389286?v=4" width="100px;"/><br /><sub><b>Ivan Nikolić</b></sub>](http://ivannikolic.com)<br />[🐛](https://github.com/newoga/babel-plugin-transform-replace-object-assign/issues?q=author%3Aniksy "Bug reports") | [<img src="https://avatars1.githubusercontent.com/u/45469?v=4" width="100px;"/><br /><sub><b>Jordan Harband</b></sub>](https://twitter.com/ljharb)<br />[🤔](#ideas-ljharb "Ideas, Planning, & Feedback") | [<img src="https://avatars0.githubusercontent.com/u/1754873?v=4" width="100px;"/><br /><sub><b>Jayden Seric</b></sub>](https://jaydenseric.com)<br />[💻](https://github.com/newoga/babel-plugin-transform-replace-object-assign/commits?author=jaydenseric "Code") [📖](https://github.com/newoga/babel-plugin-transform-replace-object-assign/commits?author=jaydenseric "Documentation") |
+| :---: | :---: | :---: | :---: |
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind welcome!

src/index.js

@@ -1,38 +0,15 @@
-const OBJECT_ASSIGN = 'ObjectAssign';
+import { addDefault } from '@babel/helper-module-imports';
 
-export default function ({types: t}) {
+export default function({ types: t }) {
   return {
     visitor: {
-      Program: {
-        enter(path, {file}) {
-          file.set(OBJECT_ASSIGN, false);
-        },
-
-        exit(path, {file, opts}) {
-          if (typeof opts === 'string') {
-            throw new Error(`Configuring module specifier with a string is no longer supported. Configure with { "moduleSpecifier": "${opts}" } instead of "${opts}".`);
-          }
-
-          const { moduleSpecifier = 'object-assign' } = opts;
-
-          if (!file.get(OBJECT_ASSIGN) && !path.scope.hasBinding(moduleSpecifier)) {
-            return;
-          }
-
-          const declar = t.importDeclaration([
-            t.importDefaultSpecifier(file.get(OBJECT_ASSIGN)),
-          ], t.stringLiteral(moduleSpecifier));
-
-          path.node.body.unshift(declar);
-        }
-      },
-
-      CallExpression(path, {file}) {
+      CallExpression(path, { file, opts }) {
         if (path.get('callee').matchesPattern('Object.assign')) {
-
-          if (!file.get(OBJECT_ASSIGN)) {
-            file.set(OBJECT_ASSIGN, path.scope.generateUidIdentifier('objectAssign'));
+          if (this.importCache)
+            path.node.callee = t.cloneNode(this.importCache);
+          else {
+            const { moduleSpecifier = 'object-assign' } = opts;
+            this.importCache = addDefault(file.path, moduleSpecifier);
+            path.node.callee = this.importCache;
           }
-
-          path.node.callee = file.get(OBJECT_ASSIGN);
         }
@@ -39,0 +16,0 @@ }

test/fixtures/not-import-impl-when-no-object-assign/expected.js

@@ -6,3 +6,2 @@ "use strict";
   b: 2
-};
-
+};

test/fixtures/not-replace-non-call-expression/actual.js

@@ -1,3 +0,3 @@
-import assign from "simple-assign";
+import assign from 'simple-assign';
 
 export default Object.assign || assign;

test/fixtures/not-replace-non-call-expression/expected.js

@@ -6,9 +6,10 @@ "use strict";
 });
+exports.default = void 0;
 
-var _simpleAssign = require("simple-assign");
+var _simpleAssign = _interopRequireDefault(require("simple-assign"));
 
-var _simpleAssign2 = _interopRequireDefault(_simpleAssign);
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-exports.default = Object.assign || _simpleAssign2.default;
+var _default = Object.assign || _simpleAssign.default;
+
+exports.default = _default;

test/fixtures/replace-multiple-object-assign-calls/actual.js

@@ -1,2 +0,3 @@
-Object.assign({a: 1}, {b: 2});
-Object.assign({c: 3}, {d: 4});
+Object.assign({ a: 1 }, { b: 2 });
+Object.assign({ c: 3 }, { d: 4 });
+Object.assign({ e: 5 }, { f: 6 });

test/fixtures/replace-multiple-object-assign-calls/expected.js

 "use strict";
 
-var _simpleAssign = require("simple-assign");
+var _simpleAssign = _interopRequireDefault(require("simple-assign"));
 
-var _simpleAssign2 = _interopRequireDefault(_simpleAssign);
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-(0, _simpleAssign2.default)({ a: 1 }, { b: 2 });
-(0, _simpleAssign2.default)({ c: 3 }, { d: 4 });
+(0, _simpleAssign.default)({
+  a: 1
+}, {
+  b: 2
+});
+(0, _simpleAssign.default)({
+  c: 3
+}, {
+  d: 4
+});
+(0, _simpleAssign.default)({
+  e: 5
+}, {
+  f: 6
+});

test/fixtures/replace-single-object-assign-calls/actual.js

@@ -1,1 +0,1 @@
-Object.assign({'a': 1}, {'b': 2});
+Object.assign({ a: 1 }, { b: 2 });

test/fixtures/replace-single-object-assign-calls/expected.js

@@ -1,9 +0,11 @@
-'use strict';
+"use strict";
 
-var _simpleAssign = require('simple-assign');
+var _simpleAssign = _interopRequireDefault(require("simple-assign"));
 
-var _simpleAssign2 = _interopRequireDefault(_simpleAssign);
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-(0, _simpleAssign2.default)({ 'a': 1 }, { 'b': 2 });
+(0, _simpleAssign.default)({
+  a: 1
+}, {
+  b: 2
+});

test/fixtures/use-default-config/actual.js

@@ -1,1 +0,1 @@
-Object.assign({'a': 1}, {'b': 2});
+Object.assign({ a: 1 }, { b: 2 });

test/fixtures/use-default-config/expected.js

@@ -1,9 +0,11 @@
-'use strict';
+"use strict";
 
-var _objectAssign2 = require('object-assign');
+var _objectAssign = _interopRequireDefault(require("object-assign"));
 
-var _objectAssign3 = _interopRequireDefault(_objectAssign2);
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-(0, _objectAssign3.default)({ 'a': 1 }, { 'b': 2 });
+(0, _objectAssign.default)({
+  a: 1
+}, {
+  b: 2
+});

test/fixtures/use-existing-import/actual.js

@@ -1,3 +0,3 @@
-import assign from "simple-assign";
+import assign from 'simple-assign';
 
-Object.assign({a: 1}, {b: 2});
+Object.assign({ a: 1 }, { b: 2 });

test/fixtures/use-existing-import/expected.js

 "use strict";
 
-var _simpleAssign = require("simple-assign");
+var _simpleAssign = _interopRequireDefault(require("simple-assign"));
 
-var _simpleAssign2 = _interopRequireDefault(_simpleAssign);
-
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
-(0, _simpleAssign2.default)({ a: 1 }, { b: 2 });
+(0, _simpleAssign.default)({
+  a: 1
+}, {
+  b: 2
+});

test/index.js

 import path from 'path';
 import fs from 'fs';
 import assert from 'assert';
-import {transformFileSync} from 'babel-core';
+import { transformFileSync } from '@babel/core';
 import plugin from '../src/index';
@@ -13,3 +13,3 @@
   const fixturesDir = path.join(__dirname, 'fixtures');
-  fs.readdirSync(fixturesDir).map((caseName) => {
+  fs.readdirSync(fixturesDir).map(caseName => {
     it(`should ${caseName.split('-').join(' ')}`, () => {
@@ -22,7 +22,7 @@ const fixtureDir = path.join(fixturesDir, caseName);
       const actual = transformFileSync(path.join(fixtureDir, 'actual.js'), {
-        plugins: [
-          pluginConfig
-        ]
+        plugins: [pluginConfig]
       }).code;
-      const expected = fs.readFileSync(path.join(fixtureDir, 'expected.js')).toString();
+      const expected = fs
+        .readFileSync(path.join(fixtureDir, 'expected.js'))
+        .toString();
 
@@ -29,0 +29,0 @@ assert.equal(trim(actual), trim(expected));

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16425

increased by21.61%

Number of package files

24

increased by4.35%

Number of lines in readme file

85

increased by30.77%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

7

increased by16.67%

Lines of code

133

decreased by-8.9%

Number of low quality alerts

2

increased by100%

Dependency changes

• + Added@babel/helper-module-imports@^7.0.0-beta.42

• + Added@ampproject/remapping@2.3.0(transitive)

• + Added@babel/code-frame@7.26.2(transitive)

• + Added@babel/compat-data@7.26.5(transitive)

• + Added@babel/core@7.26.0(transitive)

• + Added@babel/generator@7.26.5(transitive)

• + Added@babel/helper-compilation-targets@7.26.5(transitive)

• + Added@babel/helper-module-imports@7.25.9(transitive)

• + Added@babel/helper-module-transforms@7.26.0(transitive)

• + Added@babel/helper-string-parser@7.25.9(transitive)

• + Added@babel/helper-validator-identifier@7.25.9(transitive)

• + Added@babel/helper-validator-option@7.25.9(transitive)

• + Added@babel/helpers@7.26.0(transitive)

• + Added@babel/parser@7.26.5(transitive)

• + Added@babel/template@7.25.9(transitive)

• + Added@babel/traverse@7.26.5(transitive)

• + Added@babel/types@7.26.5(transitive)

• + Added@jridgewell/gen-mapping@0.3.8(transitive)

• + Added@jridgewell/resolve-uri@3.1.2(transitive)

• + Added@jridgewell/set-array@1.2.1(transitive)

• + Added@jridgewell/sourcemap-codec@1.5.0(transitive)

• + Added@jridgewell/trace-mapping@0.3.25(transitive)

• + Addedbrowserslist@4.24.4(transitive)

• + Addedcaniuse-lite@1.0.30001695(transitive)

• + Addedconvert-source-map@2.0.0(transitive)

• + Addeddebug@4.4.0(transitive)

• + Addedelectron-to-chromium@1.5.83(transitive)

• + Addedescalade@3.2.0(transitive)

• + Addedgensync@1.0.0-beta.2(transitive)

• + Addedglobals@11.12.0(transitive)

• + Addedjs-tokens@4.0.0(transitive)

• + Addedjsesc@3.1.0(transitive)

• + Addedjson5@2.2.3(transitive)

• + Addedlru-cache@5.1.1(transitive)

• + Addedms@2.1.3(transitive)

• + Addednode-releases@2.0.19(transitive)

• + Addedpicocolors@1.1.1(transitive)

• + Addedsemver@6.3.1(transitive)

• + Addedupdate-browserslist-db@1.1.2(transitive)

• + Addedyallist@3.1.1(transitive)