@putout/plugin-putout [![NPM version][NPMIMGURL]][NPMURL]

[NPMIMGURL]: https://img.shields.io/npm/v/@putout/plugin-putout.svg?style=flat&longCache=true
[NPMURL]: https://npmjs.org/package/@putout/plugin-putout "npm"

🐊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-push-arg;
- ✅ add-test-args;
- ✅ add-traverse-args;
- ✅ add-crawl-file;
- ✅ add-track-file;
- ✅ apply-async-formatter;
- ✅ apply-create-test;
- ✅ apply-create-nested-directory;
- ✅ apply-declare;
- ✅ apply-destructuring;
- ✅ apply-engine-node-version;
- ✅ 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;
- ✅ apply-transform-with-options;
- ✅ 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-get-file-content-to-read-file-content;
- ✅ 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-plugins-element-to-tuple;
- ✅ convert-push-object-to-push-path;
- ✅ convert-replace-to-function;
- ✅ convert-replace-to-traverse;
- ✅ 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;
- ✅ remove-message-from-no-report-after-transform;
- ✅ rename-operate-to-operator;
- ✅ replace-operate-with-operator;
- ✅ replace-test-message;
- ✅ shorten-imports;
- ✅ simplify-replace-template;

Config

`json
{
"rules": {
"putout/add-places-to-compare-places": "on",
"putout/add-path-arg-to-fix": "on",
"putout/add-path-arg-to-visitors": "on",
"putout/add-push-arg": "on",
"putout/add-test-args": "on",
"putout/add-traverse-args": "on",
"putout/add-crawl-file": "on",
"putout/add-track-file": "on",
"putout/add-await-to-progress": "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-engine-node-version": "off",
"putout/apply-exports": "off",
"putout/apply-exports-to-add-args": "on",
"putout/apply-exports-to-match-files": "on",
"putout/apply-exports-to-rename-files": "on",
"putout/apply-report": "on",
"putout/apply-processors-destructuring": "on",
"putout/apply-rename": "on",
"putout/apply-parens": "on",
"putout/apply-remove": "on",
"putout/apply-transform-with-options": "on",
"putout/apply-insert-before": "on",
"putout/apply-insert-after": "on",
"putout/apply-vars": "on",
"putout/apply-short-processors": "on",
"putout/apply-lowercase-to-node-builders": "on",
"putout/apply-namespace-specifier": "on",
"putout/apply-for-of-to-track-file": "on",
"putout/apply-fixture-name-to-message": "on",
"putout/check-match": "on",
"putout/check-declare": "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-replace-to-traverse": "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-include-to-traverse": "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-get-file-content-to-read-file-content": "on",
"putout/convert-progress-to-track-file": "on",
"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",
"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/remove-empty-object-from-transform": "on",
"putout/remove-useless-printer-option": "on",
"putout/remove-message-from-no-report-after-transform": "on",
"putout/simplify-replace-template": "on"
}
}
`

apply-lowercase-to-node-builders

Checkout in 🐊Putout Editor.

$3

`js
path.node = Identifier('x');
`

$3

`js
path.node = identifier('x');
`

apply-report

Checkout in 🐊Putout Editor.

$3

`js
t.noReport('rename-files-full', {
from: ['/'],
to: [],
});

t.noReportWithOptions('rename-files-full');

t.noReport('a', 'Use b');
t.report('a');
`

$3

`js
t.noReportWithOptions('rename-files-full', {
from: ['/'],
to: [],
});

t.noReport('rename-files-full');

t.report('a', 'Use b');
t.noReport('a');
`

apply-transform-with-options

Checkout in 🐊Putout Editor.

$3

`js
t.transform('submenu', {
submenuIndex: 1,
insideSubmenu: true,
});
`

$3

`js
t.transformWithOptions('submenu', {
submenuIndex: 1,
insideSubmenu: true,
});
`

apply-processors-destructuring

$3

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

$3

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

apply-processors-destructuring

$3

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

$3

`js
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.

$3

`js
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);
},
});
`

$3

`js
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.

$3

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

$3

`js
import {operator} from 'putout';

const {rename} = operator;

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

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.

$3

`js
path.node.extra.parenthesized = false;
path.node.extra.parenthesized = true;

if (!path.node.extra?.parenthesized)
return;
`

$3

`js
removeParens(path);
addParens(path);

if (!hasParens(path))
return;
`

apply-remove

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

$3

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

$3

`js
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.

$3

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

$3

`js
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.

$3

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

$3

`js
import {operator} from 'putout';

const {insertAfter} = operator;

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

apply-vars

Checkout in 🐊Putout Editor.

$3

`js
export const replace = () => ({
'__a(__args': ({}, path) => {
return true;
},
});

export const match = () => ({
'__a(__args': ({}, path) => {
return '';
},
});
`

$3

`js
export const replace = () => ({
'__a(__args': (vars, path) => {
return true;
},
});

export const match = () => ({
'__a(__args': (vars, path) => {
return '';
},
});
`

apply-declare

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

$3

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

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

$3

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

apply-destructuring

Check out in 🐊Putout Editor.

$3

`js
const putout = require('putout');
`

$3

`js
const {putout} = require('putout');
`

apply-engine-node-version

Check out in 🐊Putout Editor.

`diff
{
"name": "@putout/plugin-variables",
"peerDependencies": {
"putout": ">=41"
},
"license": "MIT",
"engines": {
- "node": ">=20"
+ "node": ">=22"
}
}
`

apply-exports

Check out in 🐊Putout Editor.
Possible configuration:

`json
{
"rules": {
"putout/apply-exports": ["on", {
"addArgs": [
"report",
"fix",
"scan"
]
}]
}
}
`

$3

`js
export default createRenameProperty([
...v32,
...v29,
]);
`

$3

`js
export const {
report,
fix,
scan,
} = createRenameProperty([
...v32,
...v29,
]);
`

apply-exports-to-add-args

Check out in 🐊Putout Editor.

$3

`js
export default addArgs(__args);
`

$3

`js
export const {
report,
fix,
traverse,
} = addArgs(__args);
`

apply-exports-to-match-files

Check out in 🐊Putout Editor.

$3

`js
export default matchFiles({
'*.cjs': plugin,
});
`

$3

`js
export const {
report,
fix,
scan,
} = matchFiles({
'*.cjs': plugin,
});
`

apply-exports-to-rename-files

Check out in 🐊Putout Editor.

$3

`js
export default renameFiles({
type: 'module',
mask: '*.mjs',
rename(name) {
return name.replace(/mjs$/, 'js');
},
});
`

$3

`js
export const {
report,
fix,
scan,
} = renameFiles({
type: 'module',
mask: '*.mjs',
rename(name) {
return name.replace(/mjs$/, 'js');
},
});
`

apply-async-formatter

$3

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

$3

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

apply-create-test

$3

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

$3

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

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

apply-create-nested-directory

Checkout in Putout Editor.

$3

`js
const dirPath = createDirectory(path, '/hello/world');
const dirPath2 = createNestedDirectory(path, 'world');
`

$3

`js
const dirPath = createNestedDirectory(path, '/hello/world');
const dirPath2 = createDirectory(path, 'world');
`

apply-namespace-specifier

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

$3

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

$3

`js
import * 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

$3

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

$3

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

create-test

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

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

Check it out in 🐊Putout Editor.

$3

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

$3

`js
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.

$3

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

$3

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

convert-putout-test-to-create-test

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

$3

`js
import putoutTest from '@putout/test';

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

$3

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

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

convert-plugins-element-to-tuple

Checkout in 🐊Putout Editor.

$3

`js
t.transform('nested-not-block', [
['convert-if-to-jmp', convertIfToJmp],
convertDoWhileToJnz,
]);
`

$3

`js
t.transform('nested-not-block', [
['convert-if-to-jmp', convertIfToJmp],
['convert-do-while-to-jnz', convertDoWhileToJnz],
]);
`

convert-push-object-to-push-path

Checkout in 🐊Putout Editor.

$3

`js
export const fix = ({path}) => {
removeClassName(path, SELECTED);
};

push({
path: child,
});
`

$3

`js
export const fix = (path) => {
removeClassName(path, SELECTED);
};

push(child);
`

convert-to-no-transform-code

$3

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

t.transform(code, '');
t.end();
});
`

$3

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

t.noTransformCode(code);
t.end();
});
`

convert-replace-with

$3

`js
module.exports.fix = (path) => {
path.replaceWith(identifier('hello'));
};
`

$3

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

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

convert-replace-with-multiple

$3

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

$3

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

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

convert-replace-to-function

$3

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

$3

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

convert-replace-to-traverse

Checkout in 🐊Putout Editor.

$3

`js
export const fix = () => {};
export const replace = () => ({
[__json]: (path) => {
const __aPath = path.get('arguments.0');
const {importsPath} = getProperties(__aPath, ['imports']);
},
});
`

$3

`js
export const fix = () => {};
export const traverse = () => ({
[__json]: (path) => {
const __aPath = path.get('arguments.0');
const {importsPath} = getProperties(__aPath, ['imports']);
},
});
`

convert-match-to-function

$3

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

$3

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

convert-babel-types

$3

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

$3

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

convert-destructuring-to-identifier

$3

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

$3

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

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

$3

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

$3

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

shorten-imports

$3

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

$3

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

convert-include-to-traverse

Checkout in 🐊*Putout Editor.

$3

`js
export const include = () => ({
ClassDeclaration(path) {},
});
`

$3

`js
export const traverse = () => ({
ClassDeclaration(path) {},
});
`

convert-traverse-to-include

$3

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

$3

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

convert-traverse-to-replace

$3

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

$3

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

convert-traverse-to-scan

Checkout in 🐊Putout Editor:

- Traverser;
- Replacer;

$3

`js
module.exports.traverse = ({push, options}) => ({
__filesystem {
const {names} = options;

for (const name of names) {
const files = findFile(path, name);

for (const file of files) {
push({
name,
path: file,
});
}
}
},
});
`

$3

`js
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

$3

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

$3

`js
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);

$3

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

$3

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

check-declare

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

$3

`js
module.exports.declare = () => ({
isNumber: 'const isNumber = () => {}',
isString: 'const isNumber = () => {}',
});
`

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

$3

`js
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.

$3

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

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

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

$3

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

$3

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

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

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

declare-template-variables

Checkout in 🐊Putout Editor.

$3

`js
export const match = () => ({
'__a(__args': (vars, path) => {
fn(x);

return __args[__a];
},
});
`

$3

`js
export const match = () => ({
'__a(__args': ({__args, __a}, path) => {
fn(x);

return __args[__a];
},
});
`

declare-path-variable

Checkout in 🐊Putout Editor.

$3

`js
export const match = () => ({
'__x __a __expr': ({__x}) => {
if (path.isNextPunctuator(assign))
return false;

return isOneOfKeywords(__x, ['const', 'let', 'var']);
},
});
`

$3

`js
export const match = () => ({
'__x __a __expr': ({__x}) => {
if (path.isNextPunctuator(assign))
return false;

return isOneOfKeywords(__x, ['const', 'let', 'var']);
},
});
`

add-places-to-compare-places"

$3

comparePlaces takes two or more arguments.

Checkout in 🐊Putout Editor.

`js
comparePlaces('hello');
`

$3

`js
comparePlaces('hello', []);
`

add-path-arg-to-fix

Checkout in 🐊Putout Editor.

$3

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

$3

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

add-path-arg-to-visitors

Checkout in 🐊Putout Editor.

$3

`js
export const traverse = () => ({
TSUnionType() {
console.log(path);
},
});
`

$3

`js
export const traverse = () => ({
TSUnionType(path) {
console.log(path);
},
});
`

add-push-arg

Checkout in 🐊Putout Editor.

$3

`js
export const scan = (root, {trackFile}) => {
for (const file of trackFile(root, names)) {
push(file);
}
};
`

$3

`js
export const scan = (root, {trackFile, push}) => {
for (const file of trackFile(root, names)) {
push(file);
}
};
`

add-test-args

$3

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

$3

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

add-traverse-args

Checkout in 🐊Putout Editor.
Supported args:

- push:

$3

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

$3

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

- store

$3

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

store('name', name);
},
});
`

$3

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

store('name', name);
},
});
`

- listStore`

$3

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

$3

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

- pathStore

$3

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

$3

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

add-await-to-progress

Checkout in 🐊Putout Editor.

$3

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

$3

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

add-crawl-file

Checkout in 🐊Putout Editor.

$3

`js
export const scan = (root, {push, progress}) => {
crawlFile();
};
`

$3

`js
export const scan = (root, {push, progress, crawlFile}) => {
crawlFile();
};
`

add-track-file

Checkout in 🐊Putout Editor.

$3

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

$3

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

convert-add-argument-to-add-args

$3

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

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

$3

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

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

convert-dirname-to-url

$3

`js
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,
});
`

$3

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

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

convert-url-to-dirname

$3

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

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

$3

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

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

convert-report-to-function

$3

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

$3

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

convert-progress-to-track

Checkout in 🐊Putout Editor.

$3

`js
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,
});
}
};
`

$3

`js
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.

$3

`js
module.exports.rules = getRule('remove-unused-variables');
`

$3

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

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

convert-get-file-content-to-read-file-content

To read file content use readFileContent and never confuse.

Checkout in 🐊Putout Editor.

$3

`js
const content = getFileContent(file);
`

$3

`js
const content = readFileContent(file);
`

move-require-on-top-level

$3

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

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

$3

`js
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

$3

`js
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',
];

export const include = [
'cons __a = __b',
];

export const exclude = [
'var __a = __b',
];
`

$3

`js
module.exports.include = () => [
'const __a = __b',
];

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

export const include = () => [
'cons __a = __b',
];

export const exclude = () => [
'var __a = __b',
];
`

replace-test-message

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

$3

`js
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();
});
`

$3

`js
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.

$3

`js
await process('input', []);
`

$3

`js
await process('input');
`

remove-empty-object-from-transform

Check it out in 🐊Putout Editor.

$3

`js
test('hello', (t) => {
t.transform('nested-labels', {});
});
`

$3

`js
test('hello', (t) => {
t.transform('nested-labels');
});
`

remove-unused-get-properties-argument

Check it out in 🐊Putout Editor.

$3

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

$3

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

remove-message-from-no-report-after-transform

Check it out in 🐊Putout Editor.

$3

`js
test('github: set-message-of-commit-fixes: no report after transform', (t) => {
t.noReportAfterTransform('set-message-of-commit-fixes', Set 'message' of 'Commit fixes');
t.end();
});
`

$3

`js
test('github: set-message-of-commit-fixes: no report after transform', (t) => {
t.noReportAfterTransform('set-message-of-commit-fixes');
t.end();
});
`

remove-useless-printer-option

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

$3

`js
const test = createTest(__dirname, {
printer: 'putout',
plugins: [
['remove-unchanged-zero-declarations', plugin],
],
});
`

$3

`js
const test = createTest(__dirname, {
plugins: [
['remove-unchanged-zero-declarations', plugin],
],
});
`

simplify-replace-template

Checkout in 🐊Putout Editor.

$3

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

$3

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

apply-fixture-name-to-message"

Checkout in 🐊Putout Editor.

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

$3

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

License

MIT