feature: @putout/plugin-apply-shorthand-properties: rename

Author: coderaiser

packages/plugin-apply-shorthand-properties/.eslintrc.json

@@ -1,4 +1,10 @@
 {
+    "overrides": [{
+        "files": ["*.md{js}"],
+        "rules": {
+            "no-useless-rename": "off"
+        }
+    }],
     "extends": [
         "plugin:n/recommended",
         "plugin:putout/recommended"

packages/plugin-apply-shorthand-properties/README.md

@@ -17,7 +17,8 @@ npm i @putout/plugin-apply-shorthand-properties -D
 {
     "rules": {
         "apply-shorthand-properties": ["on", {
-            "ignore": []
+            "ignore": [],
+            "rename": false
         }]
     },
     "plugins": [
@@ -26,7 +27,23 @@ npm i @putout/plugin-apply-shorthand-properties -D
 }
 ```
 
-## ❌ Example of incorrect code
+## With default options
+
+### ❌ Example of incorrect code
+
+```js
+const {a: a} = b;
+```
+
+### ✅ Example of correct code
+
+```js
+const {a} = b;
+```
+
+## When `rename` enabled
+
+### ❌ Example of incorrect code
 
 ```js
 const AUTH_SESSION = 'xx';
@@ -37,7 +54,7 @@ export const setSession = (session) => ({
 });
 ```
 
-## ✅ Example of correct code
+### ✅ Example of correct code
 
 ```js
 const type = 'xx';
@@ -48,6 +65,13 @@ export const setSession = (payload) => ({
 });
 ```
 
+## Comparison
+
+Linter | Rule | Fix
+--------|-------|------------|
+🐊 **Putout** | [`apply-shorthand-properties`](https://github.com/coderaiser/putout/tree/master/packages/plugin-apply-shorthand-properties#readme) | ✅
+⏣ **ESLint** | [`no-useless-rename`](https://eslint.org/docs/rules/no-useless-rename) | ❌
+
 ## License
 
 MIT

packages/plugin-apply-shorthand-properties/lib/apply-shorthand-properties.js

@@ -4,8 +4,10 @@ const {findBinding, rename} = operator;
 
 export const report = () => `Use shorthand properties`;
 
-export const fix = ({path, from, to}) => {
-    rename(path, from, to);
+export const fix = ({path, from, to, toRename}) => {
+    if (toRename)
+        rename(path, from, to);
+    
     path.node.shorthand = true;
 };
 
@@ -20,7 +22,7 @@ export const traverse = ({push, options}) => ({
             const valuePath = propPath.get('value');
             const keyPath = propPath.get('key');
 
-            const {ignore = []} = options;
+            const {rename, ignore = []} = options;
 
             const from = getName(valuePath);
             const to = getName(keyPath);
@@ -34,6 +36,17 @@ export const traverse = ({push, options}) => ({
             if (/^[A-Z].+$/.test(from))
                 continue;
 
+            if (!rename) {
+                if (from === to)
+                    push({
+                        path: propPath,
+                        from,
+                        to,
+                    });
+                
+                continue;
+            }
+            
             const bindingFrom = findBinding(propPath, from);
             const bindingTo = findBinding(propPath, to);
 
@@ -52,6 +65,7 @@ export const traverse = ({push, options}) => ({
                 path: propPath,
                 from,
                 to,
+                toRename: true,
             });
         }
     },

packages/plugin-apply-shorthand-properties/package.json

@@ -28,10 +28,8 @@
   "keywords": [
     "putout",
     "putout-plugin",
-    "putout-plugin-remove",
-    "plugin",
-    "remove",
-    "only"
+    "putout-plugin-apply",
+    "apply-shorthand-properties"
   ],
   "devDependencies": {
     "@putout/plugin-remove-unused-variables": "*",

packages/plugin-apply-shorthand-properties/test/apply-shorthand-properties.js

@@ -9,8 +9,18 @@ const test = createTest(import.meta.url, {
     ],
 });
 
+const testWithRemove = createTest(import.meta.url, {
+    printer: 'putout',
+    plugins: [
+        ['apply-shorthand-properties', applyShorthandProperties],
+        ['rm-unused-vars', removeUnusedVariables],
+    ],
+});
+
 test('plugin-apply-shorthand-properties: report', (t) => {
-    t.report('object', 'Use shorthand properties');
+    t.reportWithOptions('object', 'Use shorthand properties', {
+        rename: true,
+    });
     t.end();
 });
 
@@ -20,7 +30,19 @@ test('plugin-apply-shorthand-properties: no report: shorthand', (t) => {
 });
 
 test('plugin-apply-shorthand-properties: transform', (t) => {
-    t.transform('object');
+    t.transformWithOptions('object', {
+        rename: true,
+    });
+    t.end();
+});
+
+test('plugin-apply-shorthand-properties: transform: destructuring', (t) => {
+    t.transform('destructuring');
+    t.end();
+});
+
+test('plugin-apply-shorthand-properties: transform: rename-and-destructuring', (t) => {
+    t.transform('rename-and-destructuring');
     t.end();
 });
 
@@ -42,22 +64,30 @@ test('plugin-apply-shorthand-properties: no transform: not-valid', (t) => {
 });
 
 test('plugin-apply-shorthand-properties: no transform: destructuring', (t) => {
-    t.noTransform('destr');
+    t.noTransformWithOptions('destr', {
+        rename: true,
+    });
     t.end();
 });
 
 test('plugin-apply-shorthand-properties: no transform: import', (t) => {
-    t.noTransform('import');
+    t.noTransformWithOptions('import', {
+        rename: true,
+    });
     t.end();
 });
 
 test('plugin-apply-shorthand-properties: no transform: name exists', (t) => {
-    t.noTransform('name-exists');
+    t.noTransformWithOptions('name-exists', {
+        rename: true,
+    });
     t.end();
 });
 
 test('plugin-apply-shorthand-properties: no transform: names overlap', (t) => {
-    t.noTransform('overlap');
+    t.noTransformWithOptions('overlap', {
+        rename: true,
+    });
     t.end();
 });
 
@@ -71,9 +101,9 @@ test('plugin-apply-shorthand-properties: no transform: import declaration', (t)
     t.end();
 });
 
-test('plugin-apply-shorthand-properties: transform: assign', (t) => {
-    t.transform('assign', {
-        'rm-unused-vars': removeUnusedVariables,
+testWithRemove('plugin-apply-shorthand-properties: transform: assign', (t) => {
+    t.transformWithOptions('assign', {
+        rename: true,
     });
     t.end();
 });

packages/plugin-apply-shorthand-properties/test/fixture/destructuring-fix.js

@@ -0,0 +1,3 @@
+function x({b}) {
+    return b;
+}

packages/plugin-apply-shorthand-properties/test/fixture/destructuring.js

@@ -0,0 +1,3 @@
+function x({b: b}) {
+    return b;
+}

packages/plugin-apply-shorthand-properties/test/fixture/rename-and-destructuring-fix.js

@@ -0,0 +1,7 @@
+const authSession = 'xx';
+
+export const setSession = (session) => ({
+    type: authSession,
+    payload: session,
+    a,
+});

packages/plugin-apply-shorthand-properties/test/fixture/rename-and-destructuring.js

@@ -0,0 +1,7 @@
+const authSession = 'xx';
+
+export const setSession = (session) => ({
+    type: authSession,
+    payload: session,
+    a: a,
+});