feature: @putout/plugin-printer: add

coderaiser · coderaiser · commit 2821594aab84 · 2023-04-24T15:52:35.000+03:00
diff --git a/README.md b/README.md
@@ -2004,6 +2004,7 @@ Next packages not bundled with 🐊**Putout** but can be installed separately.
 | [`@putout/plugin-jest`](/packages/plugin-jest#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-jest.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-jest) |
 | [`@putout/plugin-travis`](/packages/plugin-travis#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-travis.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-travis) |
 | [`@putout/plugin-convert-throw`](/packages/plugin-convert-throw#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-convert-throw.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-convert-throw) |
+| [`@putout/plugin-printer`](/packages/plugin-printer#readme) | [![npm](https://img.shields.io/npm/v/@putout/plugin-printer.svg?maxAge=86400)](https://www.npmjs.com/package/@putout/plugin-printer) |
 
 ## 🦚 Formatters
 
diff --git a/packages/plugin-printer/.eslintrc.json b/packages/plugin-printer/.eslintrc.json
@@ -0,0 +1,10 @@
+{
+    "extends": [
+        "plugin:n/recommended",
+        "plugin:putout/safe+align"
+    ],
+    "plugins": [
+        "putout",
+        "n"
+    ]
+}
diff --git a/packages/plugin-printer/.madrun.mjs b/packages/plugin-printer/.madrun.mjs
@@ -0,0 +1,14 @@
+import {run} from 'madrun';
+
+export default {
+    'wisdom': () => run(['lint', 'coverage']),
+    'test': () => `tape 'lib/**/*.spec.js' test/*.js 'rules/**/*.spec.js'`,
+    'watch:test': async () => `nodemon -w lib -w test -x ${await run('test')}`,
+    'lint': () => `putout .`,
+    'fresh:lint': () => run('lint', '--fresh'),
+    'lint:fresh': () => run('lint', '--fresh'),
+    'fix:lint': () => run('lint', '--fix'),
+    'coverage': async () => `c8 ${await run('test')}`,
+    'coverage:html': async () => `c8 --reporter=lcov ${await run('test')}`,
+    'report': () => 'c8 report --reporter=lcov',
+};
diff --git a/packages/plugin-printer/.npmignore b/packages/plugin-printer/.npmignore
@@ -0,0 +1,9 @@
+.*
+*.spec.js
+test
+yarn-error.log
+
+coverage
+fixture
+fixture.js
+rules
diff --git a/packages/plugin-printer/.nycrc.json b/packages/plugin-printer/.nycrc.json
@@ -0,0 +1,14 @@
+{
+    "check-coverage": true,
+    "all": true,
+    "exclude": [
+        "**/*.spec.*",
+        "**/fixture",
+        "test",
+        ".*.*"
+    ],
+    "branches": 100,
+    "lines": 100,
+    "functions": 100,
+    "statements": 100
+}
diff --git a/packages/plugin-printer/.putout.json b/packages/plugin-printer/.putout.json
@@ -0,0 +1,6 @@
+{
+    "printer": "putout",
+    "rules": {
+        "putout": "on"
+    }
+}
diff --git a/packages/plugin-printer/README.md b/packages/plugin-printer/README.md
@@ -0,0 +1,85 @@
+# @putout/plugin-printer [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-printer.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/plugin-printer "npm"
+
+🐊[**Putout**](https://github.com/coderaiser/putout) adds support of transformations for [`@putout/printer`](https://github.com/putoutjs/printer).
+
+## Install
+
+```
+npm i @putout/plugin-printer -D
+```
+
+## Rules
+
+```json
+{
+    "rules": {
+        "printer/add-args": "on",
+        "printer/apply-breakline": "on",
+        "printer/apply-linebreak": "on",
+        "printer/apply-computed-print": "on"
+    }
+}
+```
+
+## apply-breakline
+
+```diff
+-print.newline();
+-indent();
+print.breakline();
+```
+
+## apply-linebreak;
+
+```diff
+-indent();
+-print.newline();
+print.linebreak();
+```
+
+## add-args
+
+### ❌ Example of incorrect code
+
+```js
+module.exports = {
+    TSPropertySignature(path) {
+        const {optional} = path.node;
+        print('__key');
+        maybe.print(optional, '?');
+    },
+};
+```
+
+### ✅ Example of correct code
+
+```js
+module.exports = {
+    TSPropertySignature(path, {print, maybe}) {
+        const {optional} = path.node;
+        print('__key');
+        maybe.print(optional, '?');
+    },
+};
+```
+
+## apply-computed-print
+
+### ❌ Example of incorrect code
+
+```js
+print(path.get('block'));
+```
+
+### ✅ Example of correct code
+
+```js
+print('__block');
+```
+
+## License
+
+MIT
diff --git a/packages/plugin-printer/lib/add-args/fixture/add-args-fix.js b/packages/plugin-printer/lib/add-args/fixture/add-args-fix.js
@@ -0,0 +1,7 @@
+module.exports = {
+    TSPropertySignature(path, {print, maybe}) {
+        const {optional} = path.node;
+        print('__key');
+        maybe.print(optional, '?');
+    },
+};
diff --git a/packages/plugin-printer/lib/add-args/fixture/add-args.js b/packages/plugin-printer/lib/add-args/fixture/add-args.js
@@ -0,0 +1,7 @@
+module.exports = {
+    TSPropertySignature(path, {print}) {
+        const {optional} = path.node;
+        print('__key');
+        maybe.print(optional, '?');
+    },
+};
diff --git a/packages/plugin-printer/lib/add-args/fixture/const-fix.js b/packages/plugin-printer/lib/add-args/fixture/const-fix.js
@@ -0,0 +1,5 @@
+const CallExpression = {
+    print(path, {indent, print, maybe, traverse}) {
+        traverse(path.get('callee'));
+    },
+};
diff --git a/packages/plugin-printer/lib/add-args/fixture/const.js b/packages/plugin-printer/lib/add-args/fixture/const.js
@@ -0,0 +1,5 @@
+const CallExpression = {
+    print(path, {indent, print, maybe}) {
+        traverse(path.get('callee'));
+    }
+};
diff --git a/packages/plugin-printer/lib/add-args/fixture/store-fix.js b/packages/plugin-printer/lib/add-args/fixture/store-fix.js
@@ -0,0 +1,5 @@
+module.exports.ForOfStatement = {
+    print(path, {indent, print, maybe, store}) {
+        store();
+    },
+};
diff --git a/packages/plugin-printer/lib/add-args/fixture/store.js b/packages/plugin-printer/lib/add-args/fixture/store.js
@@ -0,0 +1,5 @@
+module.exports.ForOfStatement = {
+    print(path, {indent, print, maybe}) {
+        store();
+    }
+}
diff --git a/packages/plugin-printer/lib/add-args/fixture/traverse-fix.js b/packages/plugin-printer/lib/add-args/fixture/traverse-fix.js
@@ -0,0 +1,9 @@
+module.exports.ForOfStatement = {
+    print(path, {indent, print, maybe, traverse}) {
+        const bodyPath = path.get('body');
+        
+        if (bodyPath.isExpressionStatement()) {
+            traverse(bodyPath);
+        }
+    },
+};
diff --git a/packages/plugin-printer/lib/add-args/fixture/traverse.js b/packages/plugin-printer/lib/add-args/fixture/traverse.js
@@ -0,0 +1,9 @@
+module.exports.ForOfStatement = {
+    print(path, {indent, print, maybe}) {
+        const bodyPath = path.get('body');
+        
+        if (bodyPath.isExpressionStatement()) {
+            traverse(bodyPath);
+        }
+    }
+}
diff --git a/packages/plugin-printer/lib/add-args/index.js b/packages/plugin-printer/lib/add-args/index.js
@@ -0,0 +1,24 @@
+'use strict';
+
+const {operator} = require('putout');
+const {addArgs} = operator;
+
+const parents = [
+    '__ = __',
+    'const __ = __',
+    'module.exports.__a = (path, __object) => __body',
+    'module.exports.__a = (path) => __body',
+    'function __(path) {}',
+    'function __(path, __object) {}',
+];
+
+module.exports = addArgs({
+    path: ['path', 'module.exports.__a = () => __body'],
+    maybe: ['{maybe}', parents],
+    write: ['{write}', parents],
+    print: ['{print}', parents],
+    indent: ['{indent}', parents],
+    compute: ['{compute}', parents],
+    traverse: ['{traverse}', parents],
+    store: ['{store}', parents],
+});
diff --git a/packages/plugin-printer/lib/add-args/index.spec.js b/packages/plugin-printer/lib/add-args/index.spec.js
@@ -0,0 +1,31 @@
+'use strict';
+
+const {createTest} = require('@putout/test');
+const declare = require('.');
+
+const test = createTest(__dirname, {
+    printer: 'putout',
+    plugins: [
+        ['printer/add-args', declare],
+    ],
+});
+
+test('rule: add-args: transform', (t) => {
+    t.transform('add-args');
+    t.end();
+});
+
+test('rule: add-args: transform: traverse', (t) => {
+    t.transform('traverse');
+    t.end();
+});
+
+test('rule: add-args: transform: store', (t) => {
+    t.transform('store');
+    t.end();
+});
+
+test('rule: add-args: transform: const', (t) => {
+    t.transform('const');
+    t.end();
+});
diff --git a/packages/plugin-printer/lib/apply-breakline/fixture/apply-breakline-fix.js b/packages/plugin-printer/lib/apply-breakline/fixture/apply-breakline-fix.js
@@ -0,0 +1 @@
+print.breakline();
diff --git a/packages/plugin-printer/lib/apply-breakline/fixture/apply-breakline.js b/packages/plugin-printer/lib/apply-breakline/fixture/apply-breakline.js
@@ -0,0 +1,2 @@
+print.newline();
+print.indent();
diff --git a/packages/plugin-printer/lib/apply-breakline/index.js b/packages/plugin-printer/lib/apply-breakline/index.js
@@ -0,0 +1,29 @@
+'use strict';
+
+const {
+    operator,
+    template,
+} = require('putout');
+
+const {
+    compare,
+    replaceWith,
+    remove,
+} = operator;
+
+module.exports.report = () => `breakline = newline + indent`;
+
+const next = (path) => path.parentPath.getNextSibling();
+
+module.exports.fix = (path) => {
+    remove(next(path));
+    replaceWith(path, template.ast('print.breakline()'));
+};
+
+module.exports.filter = (path) => {
+    return compare(next(path), 'print.indent()');
+};
+
+module.exports.include = () => [
+    'print.newline()',
+];
diff --git a/packages/plugin-printer/lib/apply-breakline/index.spec.js b/packages/plugin-printer/lib/apply-breakline/index.spec.js
@@ -0,0 +1,21 @@
+'use strict';
+
+const {createTest} = require('@putout/test');
+const plugin = require('.');
+
+const test = createTest(__dirname, {
+    printer: 'putout',
+    plugins: [
+        ['printer/apply-breakline', plugin],
+    ],
+});
+
+test('rule: apply-breakline: report', (t) => {
+    t.report('apply-breakline', `breakline = newline + indent`);
+    t.end();
+});
+
+test('rule: apply-breakline: transform', (t) => {
+    t.transform('apply-breakline');
+    t.end();
+});
diff --git a/packages/plugin-printer/lib/apply-computed-print/fixture/apply-computed-print-fix.js b/packages/plugin-printer/lib/apply-computed-print/fixture/apply-computed-print-fix.js
@@ -0,0 +1,2 @@
+print('__block');
+print('__handler');
diff --git a/packages/plugin-printer/lib/apply-computed-print/fixture/apply-computed-print.js b/packages/plugin-printer/lib/apply-computed-print/fixture/apply-computed-print.js
@@ -0,0 +1,2 @@
+print(path.get('block'));
+print(path.get('handler'));
diff --git a/packages/plugin-printer/lib/apply-computed-print/index.js b/packages/plugin-printer/lib/apply-computed-print/index.js
@@ -0,0 +1,21 @@
+'use strict';
+
+const {assign} = Object;
+
+module.exports.report = () => `Use print('__path') instead of path.get(__path)`;
+
+module.exports.replace = () => ({
+    'print(path.get(__a))': ({__a}) => {
+        const {
+            raw,
+            value,
+        } = __a;
+        
+        assign(__a, {
+            value: `__${value}`,
+            raw: raw.replace(value, `__${value}`),
+        });
+        
+        return 'print(__a)';
+    },
+});
diff --git a/packages/plugin-printer/lib/apply-computed-print/index.spec.js b/packages/plugin-printer/lib/apply-computed-print/index.spec.js
@@ -0,0 +1,21 @@
+'use strict';
+
+const {createTest} = require('@putout/test');
+const plugin = require('.');
+
+const test = createTest(__dirname, {
+    printer: 'putout',
+    plugins: [
+        ['printer/apply-computed-print', plugin],
+    ],
+});
+
+test('rule: apply-computed-print: report', (t) => {
+    t.report('apply-computed-print', `Use print('__path') instead of path.get(__path)`);
+    t.end();
+});
+
+test('rule: apply-computed-print: transform', (t) => {
+    t.transform('apply-computed-print');
+    t.end();
+});
diff --git a/packages/plugin-printer/lib/apply-linebreak/fixture/apply-linebreak-fix.js b/packages/plugin-printer/lib/apply-linebreak/fixture/apply-linebreak-fix.js
@@ -0,0 +1 @@
+print.linebreak();
diff --git a/packages/plugin-printer/lib/apply-linebreak/fixture/apply-linebreak.js b/packages/plugin-printer/lib/apply-linebreak/fixture/apply-linebreak.js
@@ -0,0 +1,2 @@
+print.indent();
+print.newline();
diff --git a/packages/plugin-printer/lib/apply-linebreak/index.js b/packages/plugin-printer/lib/apply-linebreak/index.js
diff --git a/packages/plugin-printer/lib/apply-linebreak/index.spec.js b/packages/plugin-printer/lib/apply-linebreak/index.spec.js
diff --git a/packages/plugin-printer/lib/index.js b/packages/plugin-printer/lib/index.js
diff --git a/packages/plugin-printer/package.json b/packages/plugin-printer/package.json
diff --git a/packages/plugin-printer/test/fixture/add-args-fix.js b/packages/plugin-printer/test/fixture/add-args-fix.js
diff --git a/packages/plugin-printer/test/fixture/add-args.js b/packages/plugin-printer/test/fixture/add-args.js
diff --git a/packages/plugin-printer/test/fixture/apply-breakline-fix.js b/packages/plugin-printer/test/fixture/apply-breakline-fix.js
diff --git a/packages/plugin-printer/test/fixture/apply-breakline.js b/packages/plugin-printer/test/fixture/apply-breakline.js
diff --git a/packages/plugin-printer/test/fixture/apply-computed-print-fix.js b/packages/plugin-printer/test/fixture/apply-computed-print-fix.js
diff --git a/packages/plugin-printer/test/fixture/apply-computed-print.js b/packages/plugin-printer/test/fixture/apply-computed-print.js
diff --git a/packages/plugin-printer/test/fixture/apply-linebreak-fix.js b/packages/plugin-printer/test/fixture/apply-linebreak-fix.js
diff --git a/packages/plugin-printer/test/fixture/apply-linebreak.js b/packages/plugin-printer/test/fixture/apply-linebreak.js
diff --git a/packages/plugin-printer/test/printer.js b/packages/plugin-printer/test/printer.js
