@putout/plugin-putout

🐊Putout plugin helps with plugins development.

Install

npm i @putout/plugin-putout -D

Rules

✅ add-await-to-progress;
✅ add-index-to-import;
✅ add-places-to-compare-places;
✅ add-test-args;
✅ add-traverse-args;
✅ add-track-file;
✅ apply-async-formatter;
✅ apply-create-test;
✅ apply-declare;
✅ apply-for-of-to-track-file;
✅ apply-insert-after;
✅ apply-insert-before;
✅ apply-namespace-specifier;
✅ apply-processors-destructuring;
✅ apply-remove;
✅ apply-rename;
✅ apply-short-processors;
✅ check-match;
✅ 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-traverse-to-include;
✅ convert-traverse-to-replace;
✅ convert-traverse-to-scan;
✅ convert-url-to-dirname;
✅ create-test;
✅ declare;
✅ includer;
✅ move-require-on-top-level;
✅ remove-empty-array-from-process;
✅ remove-unused-get-properties-argument;
✅ rename-operate-to-operator;
✅ replace-operate-with-operator;
✅ replace-test-message;
✅ shorten-imports;
✅ simplify-replace-template;

Config

{
    "rules": {
        "putout/apply-create-test": "on",
        "putout/apply-processors-destructuring": "on",
        "putout/apply-async-formatter": "on",
        "putout/apply-declare": "on",
        "putout/apply-rename": "on",
        "putout/apply-remove": "on",
        "putout/apply-insert-before": "on",
        "putout/apply-insert-after": "on",
        "putout/apply-short-processors": "on",
        "putout/apply-namespace-specifier": "on",
        "putout/apply-for-of-to-track-file": "on",
        "putout/add-places-to-compare-places": "on",
        "putout/add-test-args": "on",
        "putout/add-traverse-args": "on",
        "putout/add-track-file": "on",
        "putout/add-await-to-progress": "on",
        "putout/add-index-to-import": "on",
        "putout/check-match": "on",
        "putout/check-replace-code": ["on", {
            "once": true
        }],
        "putout/convert-putout-test-to-create-test": "on",
        "putout/convert-to-no-transform-code": "on",
        "putout/convert-number-to-numeric": "on",
        "putout/convert-replace-with": "on",
        "putout/convert-replace-with-multiple": "on",
        "putout/convert-replace-to-function": "on",
        "putout/convert-match-to-function": "on",
        "putout/convert-babel-types": "on",
        "putout/convert-destructuring-to-identifier": "on",
        "putout/convert-node-to-path-in-get-template-values": "on",
        "putout/convert-traverse-to-include": "on",
        "putout/convert-traverse-to-replace": "on",
        "putout/convert-traverse-to-scan": "on",
        "putout/convert-process-to-find": "on",
        "putout/convert-method-to-property": "on",
        "putout/convert-add-argument-to-add-args": "on",
        "putout/convert-dirname-to-url": "on",
        "putout/convert-url-to-dirname": "on",
        "putout/convert-report-to-function": "on",
        "putout/convert-get-rule-to-require": "on",
        "putout/convert-progress-to-track-file": "on",
        "putout/create-test": "on",
        "putout/shorten-imports": "on",
        "putout/declare": "on",
        "putout/includer": "on",
        "putout/move-require-on-top-level": "on",
        "putout/replace-test-message": "on",
        "putout/remove-unused-get-properties-argument": "on",
        "putout/remove-empty-array-from-process": "on",
        "putout/simplify-replace-template": "on"
    }
}

apply-processors-destructuring

❌ Example of incorrect code

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

✅ Example of correct code

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

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

export const match = () => ({
    '__putout_processor_ignore(__a)': ({__a}) => {
        const list = __a.elements.map(getValue);
    },
    '__putout_processor_filesystem(__a)': ({__a}) => {
        const list = __a.elements.map(getValue);
    },
});

✅ Example of correct code

export const match = () => ({
    [__ignore]: ({__array}) => {
        const list = __array.elements.map(getValue);
    },
    [__filesystem]: ({__object}) => {
        const list = __object.elements.map(getValue);
    },
});

apply-rename

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

❌ Example of incorrect code

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

✅ Example of correct code

import {operator} from 'putout';

const {rename} = operator;

export const fix = ({path, from, to}) => {
    rename(path, from, to);
};

apply-remove

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

❌ Example of incorrect code

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

✅ Example of correct code

import {operator} from 'putout';

const {remove} = operator;

export const fix = (path) => {
    remove(path);
};

apply-insert-before

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

❌ Example of incorrect code

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

✅ Example of correct code

import {operator} from 'putout';

const {insertBefore} = operator;

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

apply-insert-after

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

❌ Example of incorrect code

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

✅ Example of correct code

import {operator} from 'putout';

const {insertAfter} = operator;

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

apply-declare

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

❌ Example of incorrect code

const {operator} = require('putout');
const {declare} = operator;

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

✅ Example of correct code

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

apply-async-formatter

❌ Example of incorrect code

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

✅ Example of correct code

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

apply-create-test

❌ Example of incorrect code

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

✅ Example of correct code

const {createTest} = require('@putout/test');

const test = createTest({
    'remove-debugger': plugin,
});

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

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

✅ Example of correct code

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

create-test

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

{
    "rules": {
        "putout/create-test": ["on", {
            "add": [
                ["printer", "putout"]
            ]
        }]
    }
}

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

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

✅ Example of correct code

createTest(__dirname, {
    printer: 'putout',
    plugins: [
        ['putout/create-test', plugin],
    ],
});

convert-number-to-numeric

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

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-putout-test-to-create-test

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

❌ Example of incorrect code

import putoutTest from '@putout/test';

const test = putoutTest(__dirname, {
    'remove-unused-variables': rmVars,
});

✅ Example of correct code

import {createTest} from '@putout/test';

const test = createTest(__dirname, {
    'remove-unused-variables': rmVars,
});

convert-to-no-transform-code

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-replace-with

❌ Example of incorrect code

module.exports.fix = (path) => {
    path.replaceWith(Identifier('hello'));
};

✅ Example of correct code

const {replaceWith} = require('putout').operator;

module.exports.fix = (path) => {
    replaceWith(path, Identifier('hello'));
};

convert-replace-with-multiple

❌ Example of incorrect code

module.exports.fix = (path) => {
    path.replaceWithMultiple([
        Identifier('hello'),
    ]);
};

✅ Example of correct code

const {replaceWithMultiple} = require('putout').operator;

module.exports.fix = (path) => {
    replaceWithMultiple(path, [
        Identifier('hello'),
    ]);
};

convert-replace-to-function

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-match-to-function

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-babel-types

❌ Example of incorrect code

const {
    ObjectExpression,
    SpreadElement,
    isObjectExpression,
    isIdentifier,
} = require('@babel/types');

✅ Example of correct code

const {
    ObjectExpression,
    SpreadElement,
    isObjectExpression,
    isIdentifier,
} = require('putout').types;

convert-destructuring-to-identifier

❌ Example of incorrect code

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

✅ Example of correct code

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

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

❌ Example of incorrect code

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

✅ Example of correct code

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

shorten-imports

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-traverse-to-include

❌ Example of incorrect code

module.exports.traverse = ({push}) => ({
    TSTypeAssertion(path) {
        push(path);
    },
});

✅ Example of correct code

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

convert-traverse-to-replace

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-traverse-to-scan

Checkout in 🐊Putout Editor:

Traverser;
Replacer;

❌ Example of incorrect code

module.exports.traverse = ({push, options}) => ({
    [__filesystem](path) {
        const {names} = options;
        
        for (const name of names) {
            const files = findFile(path, name);
            
            for (const file of files) {
                push({
                    name,
                    path: file,
                });
            }
        }
    },
});

✅ Example of correct code

module.exports.scan = (path, {push, options}) => {
    const {names} = options;
    
    for (const name of names) {
        const files = findFile(path, name);
        
        for (const file of files) {
            push(file, {
                name,
            });
        }
    }
};

convert-process-to-find

❌ Example of incorrect code

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

✅ Example of correct code

module.exports.branch = (rawSource) => [];
module.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

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

✅ Example of correct code

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

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

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

☝️ 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

module.exports.match = () => ({
    '__a = __b': (vars, path) => {},
});

module.exports.replace = () => ({
    '__a = __': '__a',
});

declare

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

❌ Example of incorrect code

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

✅ Example of correct code

const {operator, types} = require('putout');

const {compare} = operator;
const {isIdentifier} = types;

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

add-places-to-compare-places"

❌ Example of incorrect code

comparePlaces takes two or more arguments.

Checkout in 🐊Putout Editor.

comparePlaces('hello');

✅ Example of correct code

comparePlaces('hello', []);

add-test-args

❌ Example of incorrect code

test('', () => {
    comparePlaces();
});

✅ Example of correct code

test('', ({comparePlaces}) => {
    comparePlaces();
});

add-traverse-args

Checkout in 🐊Putout Editor. Supported args:

push:

❌ Example of incorrect code

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

✅ Example of correct code

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

store

❌ Example of incorrect code

module.exports.traverse = () => ({
    ImportDeclaration(path) {
        const {node} = path;
        const {name} = node.specifiers[0].local;
        
        store('name', name);
    },
});

✅ Example of correct code

module.exports.traverse = ({store}) => ({
    ImportDeclaration(path) {
        const {node} = path;
        const {name} = node.specifiers[0].local;
        
        store('name', name);
    },
});

`listStore``

❌ Example of incorrect code

export const traverse = () => ({
    ImportDeclaration(path) {
        listStore(path);
    },
});

✅ Example of correct code

module.exports.traverse = ({listStore}) => ({
    ImportDeclaration(path) {
        listStore(path);
    },
});

pathStore

❌ Example of incorrect code

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

✅ Example of correct code

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

add-await-to-progress

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

test('', ({progress}) => {
    progress();
});

✅ Example of correct code

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

add-track-file

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

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

✅ Example of correct code

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

add-index-to-import

ESM doesn't add index.js, so it can be left after @putout/plugin-convert-esm-to-commonjs. Checkout in 🐊Putout Editor.

❌ Example of incorrect code

import insertRust from './insert-rust.js';
import addAction from './add-action.js';

export const rules = {};

✅ Example of correct code

import insertRust from './insert-rust/index.js';
import addAction from './add-action/index.js';

export const rules = {};

convert-add-argument-to-add-args

❌ Example of incorrect code

const {operator} = require('putout');
const {addArgument} = operator;

module.exports = addArgument({
    t: ['t', 'test("__a", (__args) => __body)'],
});

✅ Example of correct code

const {operator} = require('putout');
const {addArgs} = operator;

module.exports = addArgs({
    t: ['t', 'test("__a", (__args) => __body)'],
});

convert-dirname-to-url

❌ Example of incorrect code

import {createTest} from '@putout/test';
import plugin from '@putout/plugin-debugger';
import {createSimport} from 'simport';

const {__dirname} = createSimport(import.meta.url);

const test = createTest(__dirname, {
    'remove-debugger': plugin,
});

✅ Example of correct code

import {createTest} from '@putout/test';
import plugin from '@putout/plugin-debugger';

const test = createTest(import.meta.url, {
    'remove-debugger': plugin,
});

convert-url-to-dirname

❌ Example of incorrect code

const {createTest} = require('@putout/test');
const plugin = require('@putout/plugin-debugger');

const test = createTest(__dirname, {
    'remove-debugger': plugin,
});

✅ Example of correct code

const {createTest} = require('@putout/test');
const plugin = require('@putout/plugin-debugger');

const test = createTest(import.meta.url, {
    'remove-debugger': plugin,
});

convert-report-to-function

❌ Example of incorrect code

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

✅ Example of correct code

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

convert-progress-to-track

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

module.exports.scan = (root, {push, progress}) => {
    const files = findFile(root, ['*']);
    const n = files.length;
    
    for (const [i, file] of files.entries()) {
        push(file);
        progress({
            i,
            n,
        });
    }
};

✅ Example of correct code

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

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

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

✅ Example of correct code

const removeUnusedVariables = require('./remove-unused-variables');

module.exports.rules = {
    'remove-unused-variables': removeUnusedVariables,
};

move-require-on-top-level

❌ Example of incorrect code

const test = require('@putout/test')(__dirname, {
    'remove-debugger': require('..'),
});

test('remove debugger: report', (t) => {
    t.transform('debugger', {
        'remove-debugger': require('..'),
    });
    t.end();
});

✅ Example of correct code

const removeDebugger = require('..');

const test = require('@putout/test')(__dirname, {
    'remove-debugger': removeDebugger,
});

test('remove debugger: report', (t) => {
    t.transform('debugger', {
        'remove-debugger': removeDebugger,
    });
    t.end();
});

includer

❌ Example of incorrect code

module.exports.include = () => 'cons __a = __b';
module.exports.exclude = () => 'var __a = __b';
module.exports.include = 'cons __a = __b';
module.exports.exclude = 'var __a = __b';

module.exports.include = [
    'cons __a = __b',
];

module.exports.exclude = [
    'var __a = __b',
];

✅ Example of correct code

module.exports.include = () => [
    'cons __a = __b',
];

module.exports.exclude = () => [
    'var __a = __b',
];

module.exports.include = () => [
    'cons __a = __b',
];

module.exports.exclude = () => [
    'var __a = __b',
];

module.exports.include = () => [
    'cons __a = __b',
];

module.exports.exclude = () => [
    'var __a = __b',
];

replace-test-message

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

❌ Example of incorrect code

test('plugin-putout: rename-operate-to-operator: transform: operator exist', (t) => {
    t.noTransform('operator');
    t.end();
});

test('plugin-putout: rename-operate-to-operator: report: operator exist', (t) => {
    t.noReport('operator');
    t.end();
});

✅ Example of correct code

test('plugin-putout: rename-operate-to-operator: no transform: operator exist', (t) => {
    t.noTransform('operator');
    t.end();
});

test('plugin-putout: rename-operate-to-operator: no report: operator exist', (t) => {
    t.noReport('operator');
    t.end();
});

remove-empty-array-from-process

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

await process('input', []);

✅ Example of correct code

await process('input');

remove-unused-get-properties-argument

Check it out in 🐊Putout Editor.

❌ Example of incorrect code

const {
    overridesPath,
    parserPath,
    rulesPath,
} = getProperties(__jsonPath, [
    'parser',
    'rules',
    'overrides',
    'extends',
]);

✅ Example of correct code

const {
    overridesPath,
    parserPath,
    rulesPath,
} = getProperties(__jsonPath, ['parser', 'rules', 'extends']);

simplify-replace-template

Checkout in 🐊Putout Editor.

❌ Example of incorrect code

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

✅ Example of correct code

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