@putout/plugin-putout 29.24.0 → 29.26.0

package/README.md

@@ -27,6 +27,7 @@ npm i @putout/plugin-putout -D
 - ✅ [apply-async-formatter](#apply-async-formatter);
 - ✅ [apply-get-binding](#apply-get-binding);
 - ✅ [apply-create-test](#apply-create-test);
+- ✅ [apply-string-to-property-key](#apply-string-to-property-key);
 - ✅ [apply-create-nested-directory](#apply-create-nested-directory);
 - ✅ [apply-declare](#apply-declare);
 - ✅ [apply-destructuring](#apply-destructuring);
@@ -101,6 +102,10 @@ npm i @putout/plugin-putout -D
 - ✅ [shorten-imports](#shorten-imports);
 - ✅ [simplify-replace-template](#simplify-replace-template);
 
+## File rules
+
+- ✅ [sort-readme-file](#sort-readme-file);
+
 ## Config
 
 ```json
@@ -117,9 +122,9 @@ npm i @putout/plugin-putout -D
         "putout/add-crawl-file": "on",
         "putout/add-track-file": "on",
         "putout/add-await-to-progress": "on",
+        "putout/apply-async-formatter": "on",
         "putout/apply-create-test": "on",
         "putout/apply-create-nested-directory": "on",
-        "putout/apply-async-formatter": "on",
         "putout/apply-declare": "on",
         "putout/apply-destructuring": "on",
         "putout/apply-destructuring-to-options": "on",
@@ -134,6 +139,7 @@ npm i @putout/plugin-putout -D
         "putout/apply-rename": "on",
         "putout/apply-parens": "on",
         "putout/apply-remove": "on",
+        "putout/apply-string-to-property-key": "on",
         "putout/apply-transform-with-options": "on",
         "putout/apply-insert-before": "on",
         "putout/apply-traverser-to-ignore": "on",
@@ -178,7 +184,6 @@ npm i @putout/plugin-putout -D
         "putout/convert-plugins-element-to-tuple": "on",
         "putout/convert-push-object-to-push-path": "on",
         "putout/create-test": "on",
-        "putout/shorten-imports": "on",
         "putout/declare": "on",
         "putout/declare-template-variables": "on",
         "putout/declare-path-variable": "on",
@@ -191,7 +196,9 @@ npm i @putout/plugin-putout -D
         "putout/remove-useless-printer-option": "on",
         "putout/remove-useless-source-argument": "on",
         "putout/remove-message-from-no-report-after-transform": "on",
-        "putout/simplify-replace-template": "on"
+        "putout/simplify-replace-template": "on",
+        "putout/shorten-imports": "on",
+        "putout/sort-readme-file": "on"
     }
 }
 ```
@@ -260,6 +267,32 @@ t.report('a', 'Use b');
 t.noReport('a');
 ```
 
+## apply-string-to-property-key
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/46e3930cbdf32d316c0c6cb21eb59f5a/aecd754638d0bac8252048a4f4b3131c15ef6c6f).
+
+### ❌ Example of incorrect code
+
+```js
+export const replace = {
+    [`section('@select', select(__args))`]: ({__args}, path) => {
+        __args.unshift(identifier('id'));
+        return path;
+    },
+};
+```
+
+### ✅ Example of correct code
+
+```js
+export const replace = {
+    'section("@select", select(__args))"': ({__args}, path) => {
+        __args.unshift(identifier('id'));
+        return path;
+    },
+};
+```
+
 ## apply-transform-with-options
 
 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/92d40d40c75481816a5b5507e01d8315/bb54e932b4fff4bc0b453d723c72c7a9ed796b98).
@@ -1189,6 +1222,23 @@ const parseOptions = require('putout/lib/parse-options');
 const parseOptions = require('putout/parse-options');
 ```
 
+## sort-readme-file
+
+Checkout in 🐊**Putout Editor**:
+
+- ✅ [`sort-contents`](https://putout.cloudcmd.io/#/gist/647bcc98ba9eeaa619dfa90d129ee0ec/a19ba868e8c2f97292e763675de65cc1ec98ff66);
+- ✅ [`sort-readme-file`](https://putout.cloudcmd.io/#/gist/ac5f8b64383dabd025f38f177b18b5d2/09751fd2e6659445ed8d8d2102f1d23090a18f49);
+
+### ❌ Example of incorrect code
+
+```diff
+## Rules
+-- ✅ [remove-illegal-strict-mode](#remove-useless-strict-mode);
+-- ✅ [add-node-prefix](#add-node-prefix);
++- ✅ [add-node-prefix](#add-node-prefix);
++- ✅ [remove-illegal-strict-mode](#remove-useless-strict-mode);
+```
+
 ## convert-include-to-traverse
 
 Checkout in 🐊[**Putout Editor*](https://putout.cloudcmd.io/#/gist/a41b5c943a74b59a6c18f31fc6d31937/d79c6084f49b6444536840bc2fc1fba725ba83f8).

package/lib/add-traverse-args/index.js

@@ -88,7 +88,7 @@ const checkArgs = (names, push) => (path) => {
                 name,
             });
         },
-        [`__a(__args)`]: (path) => {
+        '__a(__args)': (path) => {
             const {callee} = path.node;
             const {name} = callee;
             

package/lib/apply-string-to-property-key/index.js

@@ -0,0 +1,34 @@
+import {operator, types} from 'putout';
+
+const {
+    isTemplateLiteral,
+    stringLiteral,
+} = types;
+
+const {replaceWith} = operator;
+
+export const report = () => `Use 'string' instead of 'template' in property key`;
+
+export const fix = (path) => {
+    const {quasis} = path.node;
+    const [first] = quasis;
+    const value = first.value.cooked.replaceAll(`'`, '"');
+    
+    replaceWith(path, stringLiteral(value));
+};
+
+export const traverse = ({push}) => ({
+    ObjectProperty(path) {
+        const keyPath = path.get('key');
+        
+        if (!isTemplateLiteral(keyPath))
+            return;
+        
+        const {quasis} = keyPath.node;
+        
+        if (quasis.length > 1)
+            return;
+        
+        push(keyPath);
+    },
+});

package/lib/index.js

@@ -1,3 +1,5 @@
+import * as sortReadmeFile from './sort-readme-file/index.js';
+import * as applyStringToPropertyKey from './apply-string-to-property-key/index.js';
 import * as convertTraverseToSuperTraverse from './convert-traverse-to-super-traverse/index.js';
 import * as applyDestructuringToOptions from './apply-destructuring-to-options/index.js';
 import * as applyGetBinding from './apply-get-binding/index.js';
@@ -174,4 +176,6 @@ export const rules = {
     'apply-get-binding': applyGetBinding,
     'apply-destructuring-to-options': applyDestructuringToOptions,
     'convert-traverse-to-super-traverse': convertTraverseToSuperTraverse,
+    'apply-string-to-property-key': applyStringToPropertyKey,
+    'sort-readme-file': sortReadmeFile,
 };

package/lib/sort-readme-file/index.js

@@ -0,0 +1,28 @@
+import {operator} from 'putout';
+import * as sortContents from './sort-contents/index.js';
+
+const {
+    matchFiles,
+    getFilename,
+    getParentDirectory,
+} = operator;
+
+export const {
+    report,
+    scan,
+    fix,
+} = matchFiles({
+    files: {
+        'README.md': {
+            plugins: [
+                ['sort-contents', sortContents],
+            ],
+        },
+    },
+    exclude: (file) => {
+        const dir = getParentDirectory(file);
+        const dirname = getFilename(dir);
+        
+        return !/plugin-.*$/.test(dirname);
+    },
+});

package/lib/sort-readme-file/sort-contents/index.js

@@ -0,0 +1,69 @@
+import {operator} from 'putout';
+
+const {compareAny} = operator;
+const {entries} = Object;
+
+export const report = () => `Sort 'contents'`;
+
+export const fix = ({path, list}) => {
+    path.node.arguments = list;
+};
+
+export const traverse = ({listStore, push}) => ({
+    'li("✅ ", link(__b, __c), ";")': (path) => {
+        const {parentPath} = path;
+        const prev = parentPath.getPrevSibling();
+        
+        if (!compareAny(prev, [
+            `heading(2, 'Rules')`,
+            `heading(2, 'File rules')`,
+        ]))
+            return;
+        
+        listStore(path);
+    },
+    'Program': {
+        exit() {
+            const list = {};
+            const ids = {};
+            
+            for (const {node, parentPath} of listStore()) {
+                const {line} = parentPath.node.loc.start;
+                
+                ids[line] = parentPath;
+                
+                list[line] = list[line] || [];
+                list[line].push(node);
+            }
+            
+            const sortedList = {};
+            const resultList = [];
+            
+            for (const [ul, currentList] of entries(list)) {
+                sortedList[ul] = currentList.toSorted(asc);
+                
+                for (const [i, current] of sortedList[ul].entries()) {
+                    if (current !== currentList[i]) {
+                        resultList[ul] = sortedList[ul];
+                        break;
+                    }
+                }
+            }
+            
+            for (const [id, list] of entries(resultList)) {
+                push({
+                    path: ids[id],
+                    list,
+                });
+            }
+        },
+    },
+});
+
+function asc(a, b) {
+    return getValue(a).charCodeAt(0) - getValue(b).charCodeAt(0);
+}
+
+function getValue(node) {
+    return node.arguments[1].arguments[0].value;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/plugin-putout",
-  "version": "29.24.0",
+  "version": "29.26.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "🐊Putout plugin helps with plugins development",