@putout/plugin-putout

🐊Putout plugin helps with plugins development.

Install

npm i @putout/plugin-putout -D

Rules

• ✅ add-await-to-progress;
• ✅ add-places-to-compare-places;
• ✅ add-path-arg-to-fix;
• ✅ add-path-arg-to-visitors;
• ✅ add-test-args;
• ✅ add-traverse-args;
• ✅ add-track-file;
• ✅ apply-async-formatter;
• ✅ apply-create-test;
• ✅ apply-create-nested-directory;
• ✅ apply-declare;
• ✅ apply-exports;
• ✅ apply-exports-to-add-args;
• ✅ apply-exports-to-match-files;
• ✅ apply-exports-to-rename-files;
• ✅ apply-for-of-to-track-file;
• ✅ apply-fixture-name-to-message;
• ✅ apply-insert-after;
• ✅ apply-insert-before;
• ✅ apply-vars;
• ✅ apply-lowercase-to-node-builders;
• ✅ apply-namespace-specifier;
• ✅ apply-report;
• ✅ apply-processors-destructuring;
• ✅ apply-remove;
• ✅ apply-rename;
• ✅ apply-parens;
• ✅ apply-short-processors;
• ✅ check-match;
• ✅ check-declare;
• ✅ check-replace-code;
• ✅ convert-add-argument-to-add-args;
• ✅ convert-babel-types;
• ✅ convert-destructuring-to-identifier;
• ✅ convert-dirname-to-url;
• ✅ convert-find-to-traverse;
• ✅ convert-get-rule-to-require;
• ✅ convert-match-to-function;
• ✅ convert-method-to-property;
• ✅ convert-node-to-path-in-get-template-values;
• ✅ convert-number-to-numeric;
• ✅ convert-process-to-find;
• ✅ convert-progress-to-track-file;
• ✅ convert-putout-test-to-create-test;
• ✅ convert-replace-to-function;
• ✅ convert-replace-with;
• ✅ convert-replace-with-multiple;
• ✅ convert-report-to-function;
• ✅ convert-to-no-transform-code;
• ✅ convert-include-to-traverse;
• ✅ convert-traverse-to-include;
• ✅ convert-traverse-to-replace;
• ✅ convert-traverse-to-scan;
• ✅ convert-url-to-dirname;
• ✅ create-test;
• ✅ declare;
• ✅ declare-template-variables;
• ✅ declare-path-variable;
• ✅ includer;
• ✅ move-require-on-top-level;
• ✅ remove-empty-array-from-process;
• ✅ remove-empty-object-from-transform;
• ✅ remove-unused-get-properties-argument;
• ✅ remove-useless-printer-option;
• ✅ rename-operate-to-operator;
• ✅ replace-operate-with-operator;
• ✅ replace-test-message;
• ✅ shorten-imports;
• ✅ simplify-replace-template;

Config

1{
2    "rules": {
3        "putout/add-places-to-compare-places": "on",
4        "putout/add-path-arg-to-fix": "on",
5        "putout/add-path-arg-to-visitors": "on",
6        "putout/add-test-args": "on",
7        "putout/add-traverse-args": "on",
8        "putout/add-track-file": "on",
9        "putout/add-await-to-progress": "on",
10        "putout/apply-create-test": "on",
11        "putout/apply-create-nested-directory": "on",
12        "putout/apply-async-formatter": "on",
13        "putout/apply-declare": "on",
14        "putout/apply-exports": "off",
15        "putout/apply-exports-to-add-args": "on",
16        "putout/apply-exports-to-match-files": "on",
17        "putout/apply-exports-to-rename-files": "on",
18        "putout/apply-report": "on",
19        "putout/apply-processors-destructuring": "on",
20        "putout/apply-rename": "on",
21        "putout/apply-parens": "on",
22        "putout/apply-remove": "on",
23        "putout/apply-insert-before": "on",
24        "putout/apply-insert-after": "on",
25        "putout/apply-vars": "on",
26        "putout/apply-short-processors": "on",
27        "putout/apply-lowercase-to-node-builders": "on",
28        "putout/apply-namespace-specifier": "on",
29        "putout/apply-for-of-to-track-file": "on",
30        "putout/apply-fixture-name-to-message": "on",
31        "putout/check-match": "on",
32        "putout/check-declare": "on",
33        "putout/check-replace-code": ["on", {
34            "once": true
35        }],
36        "putout/convert-putout-test-to-create-test": "on",
37        "putout/convert-to-no-transform-code": "on",
38        "putout/convert-number-to-numeric": "on",
39        "putout/convert-replace-with": "on",
40        "putout/convert-replace-with-multiple": "on",
41        "putout/convert-replace-to-function": "on",
42        "putout/convert-match-to-function": "on",
43        "putout/convert-babel-types": "on",
44        "putout/convert-destructuring-to-identifier": "on",
45        "putout/convert-node-to-path-in-get-template-values": "on",
46        "putout/convert-include-to-traverse": "on",
47        "putout/convert-traverse-to-include": "on",
48        "putout/convert-traverse-to-replace": "on",
49        "putout/convert-traverse-to-scan": "on",
50        "putout/convert-process-to-find": "on",
51        "putout/convert-method-to-property": "on",
52        "putout/convert-add-argument-to-add-args": "on",
53        "putout/convert-dirname-to-url": "on",
54        "putout/convert-url-to-dirname": "on",
55        "putout/convert-report-to-function": "on",
56        "putout/convert-get-rule-to-require": "on",
57        "putout/convert-progress-to-track-file": "on",
58        "putout/create-test": "on",
59        "putout/shorten-imports": "on",
60        "putout/declare": "on",
61        "putout/declare-template-variables": "on",
62        "putout/declare-path-variable": "on",
63        "putout/includer": "on",
64        "putout/move-require-on-top-level": "on",
65        "putout/replace-test-message": "on",
66        "putout/remove-unused-get-properties-argument": "on",
67        "putout/remove-empty-array-from-process": "on",
68        "putout/remove-empty-object-from-transform": "on",
69        "putout/remove-useless-printer-option": "on",
70        "putout/simplify-replace-template": "on"
71    }
72}

apply-lowercase-to-node-builders

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1path.node = identifier('x');

✅ Example of correct code

1path.node = identifier('x');

apply-report

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1t.noReport('rename-files-full', {
2    from: ['/'],
3    to: [],
4});
5
6t.noReportWithOptions('rename-files-full');
7
8t.noReport('a', 'Use b');
9t.report('a');

✅ Example of correct code

1t.noReportWithOptions('rename-files-full', {
2    from: ['/'],
3    to: [],
4});
5
6t.noReport('rename-files-full');
7
8t.report('a', 'Use b');
9t.noReport('a');

apply-processors-destructuring

❌ Example of incorrect code

1test('', async (t) => {
2    await t.process({});
3});

✅ Example of correct code

1test('', async ({process}) => {
2    await process({});
3});

apply-processors-destructuring

❌ Example of incorrect code

1test('', async (t) => {
2    await t.process({});
3});

✅ Example of correct code

1test('', async ({process}) => {
2    await process({});
3});

apply-short-processors

Apply short names of processors, for example __json instead of __putout_processor_json . Checkout out in 🐊Putout Editor.

❌ Example of incorrect code

1export const match = () => ({
2    '__putout_processor_ignore(__a)': ({__a}) => {
3        const list = __a.elements.map(getValue);
4    },
5    '__putout_processor_filesystem(__a)': ({__a}) => {
6        const list = __a.elements.map(getValue);
7    },
8});

✅ Example of correct code

1export const match = () => ({
2    [__ignore]: ({__array}) => {
3        const list = __array.elements.map(getValue);
4    },
5    [__filesystem]: ({__object}) => {
6        const list = __object.elements.map(getValue);
7    },
8});

apply-rename

Better use rename(path, from, to) method of operator. Check out in 🐊Putout Editor.

❌ Example of incorrect code

1export const fix = ({path, from, to}) => {
2    path.scope.rename(from, to);
3};

✅ Example of correct code

1import {operator} from 'putout';
2
3const {rename} = operator;
4
5export const fix = ({path, from, to}) => {
6    rename(path, from, to);
7};

apply-parens

Better use addParens(path) method of operator instead of using path.node.extra to have support of both printers:

• ✅ @putout/printer;
• ✅ babel;

Check out in 🐊Putout Editor.

❌ Example of incorrect code

1path.node.extra.parenthesized = false;
2path.node.extra.parenthesized = true;
3
4if (!path.node.extra?.parenthesized)
5    return;

✅ Example of correct code

1removeParens(path);
2addParens(path);
3
4if (!hasParens(path))
5    return;

apply-remove

Better to use remove(path) method of operator. It helps to preserve comments.

❌ Example of incorrect code

1export const fix = (path) => {
2    path.remove();
3};

✅ Example of correct code

1import {operator} from 'putout';
2
3const {remove} = operator;
4
5export const fix = (path) => {
6    remove(path);
7};

apply-insert-before

Better to use insertBefore(a, b) method of operator.

❌ Example of incorrect code

1export const fix = (path) => {
2    path.insertBefore(path.get('init'));
3};

✅ Example of correct code

1import {operator} from 'putout';
2
3const {insertBefore} = operator;
4
5export const fix = (path) => {
6    insertBefore(path, path.get('init'));
7};

apply-insert-after

Better to use insertAfter(a, b) method of operator. It helps to avoid duplication of comments.

❌ Example of incorrect code

1export const fix = (path) => {
2    path.insertAfter(path.get('init'));
3};

✅ Example of correct code

1import {operator} from 'putout';
2
3const {insertAfter} = operator;
4
5export const fix = (path) => {
6    insertAfter(path, path.get('init'));
7};

apply-vars

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1export const replace = () => ({
2    '__a(__args': ({}, path) => {
3        return true;
4    },
5});
6
7export const match = () => ({
8    '__a(__args': ({}, path) => {
9        return '';
10    },
11});

✅ Example of correct code

1export const replace = () => ({
2    '__a(__args': (vars, path) => {
3        return true;
4    },
5});
6
7export const match = () => ({
8    '__a(__args': (vars, path) => {
9        return '';
10    },
11});

apply-declare

Better to use Declareator instead of operator.declare(). Check out in 🐊Putout Editor.

❌ Example of incorrect code

1const {operator} = require('putout');
2const {declare} = operator;
3
4module.exports = declare({
5    tryCatch: `import tryCatch from 'try-catch'`,
6    tryToCatch: `import tryToCatch from 'try-to-catch'`,
7});

✅ Example of correct code

1module.exports.declare = () => ({
2    tryCatch: `import tryCatch from 'try-catch'`,
3    tryToCatch: `import tryToCatch from 'try-to-catch'`,
4});

apply-exports

Check out in 🐊Putout Editor. Possible configuration:

1{
2    "rules": {
3        "putout/apply-exports": ["on", {
4            "addArgs": [
5                "report",
6                "fix",
7                "scan"
8            ]
9        }]
10    }
11}

❌ Example of incorrect code

1export default createRenameProperty([
2    ...v32,
3    ...v29,
4]);

✅ Example of correct code

1export const {
2    report,
3    fix,
4    scan,
5} = createRenameProperty([
6    ...v32,
7    ...v29,
8]);

apply-exports-to-add-args

Check out in 🐊Putout Editor.

❌ Example of incorrect code

1export default addArgs(__args);

✅ Example of correct code

1export const {
2    report,
3    fix,
4    traverse,
5} = addArgs(__args);

apply-exports-to-match-files

Check out in 🐊Putout Editor.

❌ Example of incorrect code

1export default matchFiles({
2    '*.cjs': plugin,
3});

✅ Example of correct code

1export const {
2    report,
3    fix,
4    scan,
5} = matchFiles({
6    '*.cjs': plugin,
7});

apply-exports-to-rename-files

Check out in 🐊Putout Editor.

❌ Example of incorrect code

1export default renameFiles({
2    type: 'module',
3    mask: '*.mjs',
4    rename(name) {
5        return name.replace(/mjs$/, 'js');
6    },
7});

✅ Example of correct code

1export const {
2    report,
3    fix,
4    scan,
5} = renameFiles({
6    type: 'module',
7    mask: '*.mjs',
8    rename(name) {
9        return name.replace(/mjs$/, 'js');
10    },
11});

apply-async-formatter

❌ Example of incorrect code

1test('formatter: codeframea', (t) => {
2    t.format(codeframe, 1);
3    t.end();
4});

✅ Example of correct code

1test('formatter: codeframea', async ({format}) => {
2    await format(codeframe, 1);
3});

apply-create-test

❌ Example of incorrect code

1const test = require('@putout/test')({
2    'remove-debugger': plugin,
3});

✅ Example of correct code

1const {createTest} = require('@putout/test');
2
3const test = createTest({
4    'remove-debugger': plugin,
5});

apply-create-nested-directory

Checkout in Putout Editor.

❌ Example of incorrect code

1const dirPath = createDirectory(path, '/hello/world');
2const dirPath2 = createNestedDirectory(path, 'world');

✅ Example of correct code

1const dirPath = createNestedDirectory(path, '/hello/world');
2const dirPath2 = createDirectory(path, 'world');

apply-namespace-specifier

Most likely what you need is esm/resolve-imported-file.

❌ Example of incorrect code

1import rmUnused from '@putout/plugin-remove-unused-variables';

✅ Example of correct code

1import * as rmUnused from '@putout/plugin-remove-unused-variables';

apply-for-of-to-track-file

The Generator object is returned by a generator function and it conforms to both the iterable protocol and the iterator protocol.

(c) MDN

trackFile is generator function used to count progress that can be used in Scanner.

Checkout in 🐊Putout Editor

❌ Example of incorrect code

1module.exports.scan = (path, {push, trackFile}) => {
2    trackFile(path, '*.swp').map(push);
3};

✅ Example of correct code

1module.exports.scan = (path, {push, trackFile}) => {
2    for (const file of trackFile(path, '*.swp')) {
3        push(file);
4    }
5};

create-test

Add properties to createTest options, here is example of .putout.json:

1{
2    "rules": {
3        "putout/create-test": ["on", {
4            "add": [
5                ["printer", "putout"]
6            ]
7        }]
8    }
9}

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

1createTest(__dirname, {
2    'putout/create-test': plugin,
3});

✅ Example of correct code

1createTest(__dirname, {
2    printer: 'putout',
3    plugins: [
4        ['putout/create-test', plugin],
5    ],
6});

convert-number-to-numeric

Prevent Babel warning: The node type NumberLiteral has been renamed to NumericLiteral.

❌ Example of incorrect code

1const {isNumberLiteral} = types;
2isNumberLiteral(node);

✅ Example of correct code

1const {isNumericLiteral} = types;
2isNumericLiteral(node);

convert-putout-test-to-create-test

Fixes results of @putout/convert-commonjs-to-esm work.

❌ Example of incorrect code

1import putoutTest from '@putout/test';
2
3const test = putoutTest(__dirname, {
4    'remove-unused-variables': rmVars,
5});

✅ Example of correct code

1import {createTest} from '@putout/test';
2
3const test = createTest(__dirname, {
4    'remove-unused-variables': rmVars,
5});

convert-to-no-transform-code

❌ Example of incorrect code

1test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
2    const code = 'const {name} = array[0]';
3    
4    t.transform(code, '');
5    t.end();
6});

✅ Example of correct code

1test('plugin-apply-destructuring: transform: array: destructuring', (t) => {
2    const code = 'const {name} = array[0]';
3    
4    t.noTransformCode(code);
5    t.end();
6});

convert-replace-with

❌ Example of incorrect code

1module.exports.fix = (path) => {
2    path.replaceWith(identifier('hello'));
3};

✅ Example of correct code

1const {replaceWith} = require('putout').operator;
2
3module.exports.fix = (path) => {
4    replaceWith(path, identifier('hello'));
5};

convert-replace-with-multiple

❌ Example of incorrect code

1module.exports.fix = (path) => {
2    path.replaceWithMultiple([
3        identifier('hello'),
4    ]);
5};

✅ Example of correct code

1const {replaceWithMultiple} = require('putout').operator;
2
3module.exports.fix = (path) => {
4    replaceWithMultiple(path, [
5        identifier('hello'),
6    ]);
7};

convert-replace-to-function

❌ Example of incorrect code

1module.exports.replace = {
2    'let __a = __b': 'const __b = __a',
3};

✅ Example of correct code

1module.exports.replace = () => ({
2    'let __a = __b': 'const __b = __a',
3});

convert-match-to-function

❌ Example of incorrect code

1module.exports.match = {
2    'let __a = __b': () => false,
3};

✅ Example of correct code

1module.exports.match = () => ({
2    'let __a = __b': () => false,
3});

convert-babel-types

❌ Example of incorrect code

1const {
2    ObjectExpression,
3    SpreadElement,
4    isObjectExpression,
5    isIdentifier,
6} = require('@babel/types');

✅ Example of correct code

1const {
2    ObjectExpression,
3    SpreadElement,
4    isObjectExpression,
5    isIdentifier,
6} = require('putout').types;

convert-destructuring-to-identifier

❌ Example of incorrect code

1module.exports.replace = () => ({
2    'const __a = __b': ({}) => {},
3    'const __c = __d': ({}, path) => {},
4});

✅ Example of correct code

1module.exports.replace = () => ({
2    'const __a = __b': (vars) => {},
3    'const __c = __d': (vars, path) => {},
4});

convert-node-to-path-in-get-template-values

❌ Example of incorrect code

1const {__a, __b} = getTemplateValues(path.node, 'const __a = __b');

✅ Example of correct code

1const {__a, __b} = getTemplateValues(path, 'const __a = __b');

shorten-imports

❌ Example of incorrect code

1const parseOptions = require('putout/lib/parse-options');

✅ Example of correct code

1const parseOptions = require('putout/parse-options');

convert-include-to-traverse

Checkout in 🐊*Putout Editor.

❌ Example of incorrect code

1export const include = () => ({
2    ClassDeclaration(path) {},
3});

✅ Example of correct code

1export const traverse = () => ({
2    ClassDeclaration(path) {},
3});

convert-traverse-to-include

❌ Example of incorrect code

1module.exports.traverse = ({push}) => ({
2    TSTypeAssertion(path) {
3        push(path);
4    },
5});

✅ Example of correct code

1module.exports.include = () => [
2    'TSTypeAssertion',
3];

convert-traverse-to-replace

❌ Example of incorrect code

1module.exports.traverse = () => ({
2    'async (__a) => __b': 'async ({process}) => __b',
3});

✅ Example of correct code

1module.exports.replace = () => ({
2    'async (__a) => __b': 'async ({process}) => __b',
3});

convert-traverse-to-scan

Checkout in 🐊Putout Editor:

• Traverser;
• Replacer;

❌ Example of incorrect code

1module.exports.traverse = ({push, options}) => ({
2    [__filesystem](path) {
3        const {names} = options;
4        
5        for (const name of names) {
6            const files = findFile(path, name);
7            
8            for (const file of files) {
9                push({
10                    name,
11                    path: file,
12                });
13            }
14        }
15    },
16});

✅ Example of correct code

1module.exports.scan = (path, {push, options}) => {
2    const {names} = options;
3    
4    for (const name of names) {
5        const files = findFile(path, name);
6        
7        for (const file of files) {
8            push(file, {
9                name,
10            });
11        }
12    }
13};

convert-process-to-find

❌ Example of incorrect code

1module.exports.preProcess = () => {};
2module.exports.postProcess = () => {};

✅ Example of correct code

1module.exports.branch = (rawSource) => [];
2module.exports.merge = (processedSource, list) => '';

convert-method-to-property

• property simpler to work with;
• support of convert-destructuring-to-identifier which is Replacer, while convert-method-to-property is Includer (searches for ObjectMethod node);

❌ Example of incorrect code

1module.exports.match = () => ({
2    'module.exports.traverse = __a'({}, path) {},
3});

✅ Example of correct code

1module.exports.match = () => ({
2    'module.exports.traverse = __a': ({}, path) => {},
3});

check-declare

Checks that Declarator transform is possible. Checkout in 🐊Putout Editor:

❌ Example of incorrect code

1module.exports.declare = () => ({
2    isNumber: 'const isNumber = () => {}',
3    isString: 'const isNumber = () => {}',
4});

☝️ There is no fix for this rule, it used internally to be more confident about test coverage, because of declaration form, transforms cannon be checked by nyc and c8, and uncovered lines can find unfixable false positives when running on code. This is additional tests, if you forget to test some case (from a big list of rules that is supported) it will be checked with this rule and make transforms more stable.

check-replace-code

Checks that Replacer transform is possible. Pass once=false to always fail no matter how many fixCounts passed.

❌ Example of incorrect code

1module.exports.replace = () => ({
2    'if (__a = __b) __body': 'if (__a === "__b") __body',
3});

☝️ There is no fix for this rule, it used internally to be more confident about test coverage, because of declaration form, transforms cannon be checked by nyc and c8, and uncovered lines can find unfixable false positives when running on code. This is additional tests, if you forget to test some case (from a big list of rules that is supported) it will be checked with this rule and make transforms more stable.

check-match

Checks that Replacer match() keys exists in replace. Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1module.exports.match = () => ({
2    '__a = __b': (vars, path) => {},
3});
4
5module.exports.replace = () => ({
6    '__a = __': '__a',
7});

☝️ There is no fix for this rule, it used internally to be more confident about test coverage, because of declaration form, transforms cannon be checked by nyc and c8, and uncovered lines can find unfixable false positives when running on code. This is additional tests, if you forget to test some case (from a big list of rules that is supported) it will be checked with this rule and make transforms more stable.

declare

Depends on @putout/convert-esm-to-commonjs and @putout/declare.

❌ Example of incorrect code

1compare(a, 'const __a = __b');
2isIdentifier(a);

✅ Example of correct code

1const {operator, types} = require('putout');
2
3const {compare} = operator;
4const {isIdentifier} = types;
5
6compare(a, 'const __a = __b');
7isIdentifier(a);

declare-template-variables

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1export const match = () => ({
2    '__a(__args': (vars, path) => {
3        fn(x);
4        
5        return __args[__a];
6    },
7});

✅ Example of correct code

1export const match = () => ({
2    '__a(__args': ({__args, __a}, path) => {
3        fn(x);
4        
5        return __args[__a];
6    },
7});

declare-path-variable

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1export const match = () => ({
2    '__x __a __expr': ({__x}) => {
3        if (path.isNextPunctuator(assign))
4            return false;
5        
6        return isOneOfKeywords(__x, ['const', 'let', 'var']);
7    },
8});

✅ Example of correct code

1export const match = () => ({
2    '__x __a __expr': ({__x}) => {
3        if (path.isNextPunctuator(assign))
4            return false;
5        
6        return isOneOfKeywords(__x, ['const', 'let', 'var']);
7    },
8});

add-places-to-compare-places"

❌ Example of incorrect code

comparePlaces takes two or more arguments.

Checkout in 🐊Putout Editor.

1comparePlaces('hello');

✅ Example of correct code

1comparePlaces('hello', []);

add-path-arg-to-fix

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1export const fix = () => {
2    path.remove();
3};

✅ Example of correct code

1export const fix = (path) => {
2    path.remove();
3};

add-path-arg-to-visitors

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1export const traverse = () => ({
2    TSUnionType() {
3        console.log(path);
4    },
5});

✅ Example of correct code

1export const traverse = () => ({
2    TSUnionType(path) {
3        console.log(path);
4    },
5});

add-test-args

❌ Example of incorrect code

1test('', () => {
2    comparePlaces();
3});

✅ Example of correct code

1test('', ({comparePlaces}) => {
2    comparePlaces();
3});

add-traverse-args

Checkout in 🐊Putout Editor. Supported args:

• push:

❌ Example of incorrect code

1module.exports.traverse = () => ({
2    '__a.replace(/__b/g, __c)': (path) => {
3        push(path);
4    },
5});

✅ Example of correct code

1module.exports.traverse = ({push}) => ({
2    '__a.replace(/__b/g, __c)': (path) => {
3        push(path);
4    },
5});

• store

❌ Example of incorrect code

1module.exports.traverse = () => ({
2    ImportDeclaration(path) {
3        const {node} = path;
4        const {name} = node.specifiers[0].local;
5        
6        store('name', name);
7    },
8});

✅ Example of correct code

1module.exports.traverse = ({store}) => ({
2    ImportDeclaration(path) {
3        const {node} = path;
4        const {name} = node.specifiers[0].local;
5        
6        store('name', name);
7    },
8});

• `listStore``

❌ Example of incorrect code

1export const traverse = () => ({
2    ImportDeclaration(path) {
3        listStore(path);
4    },
5});

✅ Example of correct code

1module.exports.traverse = ({listStore}) => ({
2    ImportDeclaration(path) {
3        listStore(path);
4    },
5});

• pathStore

❌ Example of incorrect code

1export const traverse = () => ({
2    'module.exports.match = __object': pathStore,
3});

✅ Example of correct code

1export const traverse = ({pathStore}) => ({
2    'module.exports.match = __object': pathStore,
3});

add-await-to-progress

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1test('', ({progress}) => {
2    progress();
3});

✅ Example of correct code

1test('', async ({progress}) => {
2    await progress();
3});

add-track-file

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1export const scan = (root, {push, progress}) => {
2    trackFile();
3};

✅ Example of correct code

1export const scan = (root, {push, progress, trackFile}) => {
2    trackFile();
3};

convert-add-argument-to-add-args

❌ Example of incorrect code

1const {operator} = require('putout');
2const {addArgument} = operator;
3
4module.exports = addArgument({
5    t: ['t', 'test("__a", (__args) => __body)'],
6});

✅ Example of correct code

1const {operator} = require('putout');
2const {addArgs} = operator;
3
4module.exports = addArgs({
5    t: ['t', 'test("__a", (__args) => __body)'],
6});

convert-dirname-to-url

❌ Example of incorrect code

1import {createTest} from '@putout/test';
2import plugin from '@putout/plugin-debugger';
3import {createSimport} from 'simport';
4
5const {__dirname} = createSimport(import.meta.url);
6
7const test = createTest(__dirname, {
8    'remove-debugger': plugin,
9});

✅ Example of correct code

1import {createTest} from '@putout/test';
2import plugin from '@putout/plugin-debugger';
3
4const test = createTest(import.meta.url, {
5    'remove-debugger': plugin,
6});

convert-url-to-dirname

❌ Example of incorrect code

1const {createTest} = require('@putout/test');
2const plugin = require('@putout/plugin-debugger');
3
4const test = createTest(__dirname, {
5    'remove-debugger': plugin,
6});

✅ Example of correct code

1const {createTest} = require('@putout/test');
2const plugin = require('@putout/plugin-debugger');
3
4const test = createTest(import.meta.url, {
5    'remove-debugger': plugin,
6});

convert-report-to-function

❌ Example of incorrect code

1module.exports.report = `'report' should be a 'function'`;

✅ Example of correct code

1module.exports.report = () => `'report' should be a 'function'`;

convert-progress-to-track

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1module.exports.scan = (root, {push, progress}) => {
2    const files = findFile(root, ['*']);
3    const n = files.length;
4    
5    for (const [i, file] of files.entries()) {
6        push(file);
7        progress({
8            i,
9            n,
10        });
11    }
12};

✅ Example of correct code

1module.exports.scan = (root, {push, trackFile}) => {
2    for (const file of trackFile(root, ['*'])) {
3        push(file);
4    }
5};

convert-get-rule-to-require

• ✅ import Nested plugins in Deno and Browser;
• ✅ easier bundle with rollup without dynamicRequireTargets;
• ✅ easier to migrate to ESM;

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1module.exports.rules = {
2    ...getRule('remove-unused-variables'),
3};

✅ Example of correct code

1const removeUnusedVariables = require('./remove-unused-variables');
2
3module.exports.rules = {
4    'remove-unused-variables': removeUnusedVariables,
5};

move-require-on-top-level

❌ Example of incorrect code

1const test = require('@putout/test')(__dirname, {
2    'remove-debugger': require('..'),
3});
4
5test('remove debugger: report', (t) => {
6    t.transform('debugger', {
7        'remove-debugger': require('..'),
8    });
9    t.end();
10});

✅ Example of correct code

1const removeDebugger = require('..');
2
3const test = require('@putout/test')(__dirname, {
4    'remove-debugger': removeDebugger,
5});
6
7test('remove debugger: report', (t) => {
8    t.transform('debugger', {
9        'remove-debugger': removeDebugger,
10    });
11    t.end();
12});

includer

❌ Example of incorrect code

1module.exports.include = () => 'cons __a = __b';
2module.exports.exclude = () => 'var __a = __b';
3module.exports.include = 'cons __a = __b';
4module.exports.exclude = 'var __a = __b';
5
6module.exports.include = [
7    'cons __a = __b',
8];
9
10module.exports.exclude = [
11    'var __a = __b',
12];
13
14export const include = [
15    'cons __a = __b',
16];
17
18export const exclude = [
19    'var __a = __b',
20];

✅ Example of correct code

1module.exports.include = () => [
2    'const __a = __b',
3];
4
5module.exports.exclude = () => [
6    'var __a = __b',
7];
8
9export const include = () => [
10    'cons __a = __b',
11];
12
13export const exclude = () => [
14    'var __a = __b',
15];

replace-test-message

Checks that test message and used operator are synchronized. Check it out in 🐊Putout Editor.

❌ Example of incorrect code

1test('plugin-putout: rename-operate-to-operator: transform: operator exist', (t) => {
2    t.noTransform('operator');
3    t.end();
4});
5
6test('plugin-putout: rename-operate-to-operator: report: operator exist', (t) => {
7    t.noReport('operator');
8    t.end();
9});

✅ Example of correct code

1test('plugin-putout: rename-operate-to-operator: no transform: operator exist', (t) => {
2    t.noTransform('operator');
3    t.end();
4});
5
6test('plugin-putout: rename-operate-to-operator: no report: operator exist', (t) => {
7    t.noReport('operator');
8    t.end();
9});

remove-empty-array-from-process

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

1await process('input', []);

✅ Example of correct code

1await process('input');

remove-empty-object-from-transform

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

1test('hello', (t) => {
2    t.transform('nested-labels', {});
3});

✅ Example of correct code

1test('hello', (t) => {
2    t.transform('nested-labels');
3});

remove-unused-get-properties-argument

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

1const {
2    overridesPath,
3    parserPath,
4    rulesPath,
5} = getProperties(__jsonPath, [
6    'parser',
7    'rules',
8    'overrides',
9    'extends',
10]);

✅ Example of correct code

1const {
2    overridesPath,
3    parserPath,
4    rulesPath,
5} = getProperties(__jsonPath, ['parser', 'rules', 'extends']);

remove-useless-printer-option

Check it out in 🐊Putout Editor. putout printer used by default, so there is no need to pass it.

❌ Example of incorrect code

1const test = createTest(__dirname, {
2    printer: 'putout',
3    plugins: [
4        ['remove-unchanged-zero-declarations', plugin],
5    ],
6});

✅ Example of correct code

1const test = createTest(__dirname, {
2    plugins: [
3        ['remove-unchanged-zero-declarations', plugin],
4    ],
5});

simplify-replace-template

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

1module.exports.replace = () => ({
2    'if (__a) {__b} else {__c}': () => 'if (__a) __b; else __c',
3});

✅ Example of correct code

1module.exports.replace = () => ({
2    'if (__a) {__b} else {__c}': 'if (__a) __b; else __c',
3});

apply-fixture-name-to-message"

Checkout in 🐊Putout Editor.

1test('flatlint: convert-comma-to-semicolon: no report: xxx', (t) => {
2    t.noReport('array');
3    t.end();
4});

✅ Example of correct code

1test('flatlint: convert-comma-to-semicolon: no report: array', (t) => {
2    t.noReport('array');
3    t.end();
4});

License

MIT