Putout

Perfection is finally attained not when there is no longer anything to add, but when there is no longer anything to take away.

(c) Antoine de Saint Exupéry

🐊Putout is JavaScript Linter and pluggable and configurable code transformer based on Babel with built-in ESLint. It has a lot of transformations that keeps your codebase in a clean state, removing any code smell and making code readable according to best practices. The main target is JavaScript, but:

• ✅ JSX;
• ✅ TypeScript;
• ✅ Flow;
• ✅ Yaml;
• ✅ Markdown;
• ✅ JSON;
• ✅ Ignore;

are also supported. Here is how it looks like:

Table of contents

• 🤷‍♂️ In doubt about using 🐊Putout?
• 🙏 Whom should I thank for this project exist?
• 🤷‍♂️ Why does this project exist?
• 🚚 Installation
• 🎙 Usage
• 🦕 Usage with Deno
• 📐 What is Ruler?
• ✂️ How Ruler can help me?
• 🚁 Convert CommonJS to ESM
• 🏛 Architecture
• 🌲 The Tree of Syntax
• 🌴 Laws of the Jungle
• 🏗 API
• 🏨 Built-in transformations
• 🏟 Plugins
• 🦚 Formatters
• 🦉 Configuration
• 🧬 Plugins API
• 🗿 Using Babel Plugins with Putout
• 🛴 Codemods
• ⏣ Integration with ESLint
• ☄️ Integration with Babel
• 🐈 Integration with Yarn PnP
• ⛓ Using Putout as Loader
• 🚪 Exit Codes
• 🦔 Real-world uses
• 📻 Versioning policy
• 🚀 I want contribute
• 🍄 License

🤷‍♂️ In doubt about using 🐊Putout?

Check out couple variants of plugins that does the same: linting debugger statement:

• ❌ ESLint no-debugger: 43 lines;
• ❌ SWCLint no-debugger: 49 lines;
• ❌ Rome no-debugger: 28 lines;
• ❌ RSLint no-debugger: 48 lines
• 🐊 Putout remove-debugger: 7 lines:

Choose wisely, competitors cannot even fix… 🤫

'use strict';

module.exports.report = () => `Unexpected 'debugger' statement`;

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

🙏 Whom should I thank for this project exist?

If I have seen further, it is by standing upon the shoulders of giants.

(c) Isaac Newton

• ESLint for stable releases and future proof API.
• Babel for amazing API documented in Handbook and responsiveness of a team.
• Prettier for minimalistic options and uniform codestyle.
• JSCodeshift for making codemods simple and popular.

🤷‍♂️ Why does this project exist?

• ESLint avoids fixes that could change the runtime behavior.
• Babel produces throw-away code.
• Prettier is a formatter.
• JSCodeshift has no config and plugins support.

🐊Putout on the other hand can make more drastic code transformations that directly affect your codebase making it a better place to code 💻.

🚚 Installation

To install 🐊Putout as a development dependency, run:

npm i putout -D

Make sure that you are running a relatively recent (≥16) version of Node.

🎙 Usage

Grown-ups never understand anything by themselves, and it is tiresome for children to be always and forever explaining things to them.

(c) Antoine de Saint-Exupéry

🐊Putout tries to be clear and likes a lot to explain things. So when you write putout --help most likely you will hear gladly purr :

Usage: putout [options] [path]
Options:
   -h, --help                  display this help and exit
   -v, --version               output version information and exit
   -f, --format [formatter]    use a specific output format, the default is: 'progress-bar' locally and 'dump' on CI
   -s, --staged                add staged files when in git repository
   --fix                       apply fixes of errors to code
   --fix-count [count = 10]    count of fixes rounds
   --rulesdir                  use additional rules from directory
   --transform [replacer]      apply Replacer, for example 'var __a = __b -> const __a = __b', read about Replacer https://git.io/JqcMn
   --plugins [plugins]         a comma-separated list of plugins to use
   --enable [rule]             enable the rule and save it to '.putout.json' walking up parent directories
   --disable [rule]            disable the rule and save it to '.putout.json' walking up parent directories
   --enable-all                enable all found rules and save them to '.putout.json' walking up parent directories
   --disable-all               disable all found rules (set baseline) and save them to '.putout.json' walking up parent directories
   --match [pattern]           read '.putout.json' and convert 'rules' to 'match' according to 'pattern'
   --flow                      enable flow
   --fresh                     generate a fresh cache
   --no-config                 avoid reading '.putout.json'
   --no-ci                     disable the CI detection
   --no-cache                  disable the cache

To find possible transform places in a folder named lib, run:

npx putout lib

To find possible transform places in multiple folders, such as folders named lib and test, run:

npx putout lib test

To apply the transforms, use --fix:

npx putout lib test --fix

☝️Commit your code before running 🐊Putout

Developers, myself included, usually prefer to make all code changes manually, so that nothing happens to our code without reviewing it first. That is until we trust a tool to make those changes safely for us. An example is WebStorm, which we trust when renaming a class or a method. Since 🐊Putout may still feel like a new tool, not all of us will be able to trust it immediately.

A good way to gain trust is two run without --fix option, and observe error messages. Another way is to use traditional version control tactics. Before running 🐊Putout you should do a git commit. Then after running 🐊Putout, you’ll be able to inspect the changes it made using git diff and git status. You still have the chance to run git checkout -- . at any time to revert all the changes that 🐊Putout has made. If you need more fine-grained control, you can also use git add -p or git add -i to interactively stage only the changes you want to keep.

Environment variables

🐊Putout supports the following environment variables:

• PUTOUT_CONFIG_FILE - path to configuration file;
• PUTOUT_FILES - files that should be processed split by comma (,);

Example:

PUTOUT_FILES=lib,test putout --fix

🦕 Usage with Deno

When you need to run 🐊Putout in Deno, use @putout/bundle:

import putout from 'https://esm.sh/@putout/bundle';
import removeDebugger from 'https://esm.sh/@putout/plugin-remove-debugger?alias=putout:@putout/bundle';
import declare from 'https://esm.sh/@putout/plugin-declare-undefined-variables?alias=putout:@putout/bundle';

putout('isFn(fn, "hello"); debugger', {
    plugins: [
        ['remove-debugger', removeDebugger],
        ['declare-undefined-variables', declare],
    ],
});
// returns
({
    code: `const isFn = a => typeof a === 'function';\nisFn(fn, "hello");`,
    places: [],
});

📐 What is Ruler?

When you need to change configuration file use Ruler instead of editing the file manually.

Ruler can:

• ✅ putout --enable [rule];
• ✅ putout --disable [rule];
• ✅ putout --enable-all;
• ✅ putout --disable-all;

☝️Remember, Ruler should never be used with --fix, because unclear things makes 🐊 Putout angry and you can find him barking at you:

🐊 '--fix' cannot be used with ruler toggler ('--enable', '--disable')

✂️ How Ruler can help me?

You may want to convert your CommonJS to ESM since node v12 supports it without a flag.

🚁 Convert CommonJS to ESM

☝️ I have a package.json

Well, if you have no type field or type=commonjs your package will be converted to CommonJS automatically. To convert to ESM just set type=module.

☝️ I have .cjs or .mjs files

They will be converted automatically to CommonJS and ESM accordingly.

☝️ I want to run only one rule

Let's suppose you have a file called index.js:

const unused = 5;

module.exports = function() {
    return promise();
};

async function promise(a) {
    return Promise.reject(Error('x'));
}

You call putout --fix index.js and see that file is changed:

'use strict';

module.exports = async function() {
    return await promise();
};

async function promise() {
    throw Error('x');
}

But for some reason you don't want so many changes.

☝️ Remember, safe mode of eslint-plugin-putout has the most dangerous rules disabled, so it can be used as auto fix on each save in your IDE.

So, if you want to convert it to ESM keeping everything else untouched use Ruler: it can easily disable all rules 🐊Putout finds.

putout index.js --disable-all will find next errors:

 1:4   error   'unused' is defined but never used                        remove-unused-variables
 7:23  error   'a' is defined but never used                             remove-unused-variables
 3:0   error   Arrow functions should be used                            convert-to-arrow-function
 1:0   error   'use strict' directive should be on top of commonjs file  strict-mode/add-missing
 8:4   error   Reject is useless in async functions, use throw instead   promises/convert-reject-to-throw
 4:11  error   Async functions should be called using await              promises/add-missing-await
 7:0   error   Useless async should be avoided                           promises/remove-useless-async

It will create config file .putout.json:

{
    "rules": {
        "remove-unused-variables": "off",
        "convert-to-arrow-function": "off",
        "strict-mode/add-missing": "off",
        "promises/convert-reject-to-throw": "off",
        "promises/add-missing-await": "off",
        "promises/remove-useless-async": "off"
    }
}

Then running putout index.js --enable convert-commonjs-to-esm will update config with:

{
    "rules": {
        "remove-unused-variables": "off",
        "convert-to-arrow-function": "off",
        "strict-mode/add-missing": "off",
        "promises/convert-reject-to-throw": "off",
        "promises/add-missing-await": "off",
-       "promises/remove-useless-async": "off"
+       "promises/remove-useless-async": "off",
+       "convert-commonjs-to-esm": "on"
    }
}

Then putout --fix index.js will do the thing and update index.js with:

const unused = 5;

export default function() {
    return promise();
}

async function promise(a) {
    return Promise.reject(Error('x'));
}

So in case of src directory, it will look like:

putout src --disable-all && putout src --enable convert-commonjs-to-esm && putout src --fix

This command will disable all rules that 🐊Putout can find right now and enable a single rule. All built-in rules made for good and highly suggested to be used, all of them are enabled in all my repositories, since they have auto fix.

☝️You can always disable what you don't need, so give it a try. You won't regret 🐊.

Happy coding 🎈!

🏛 Architecture

🐊Putout consists of a couple simple parts, here is a workflow representation:

And here is a CLI scheme:

🌲 The Tree of Syntax

The wise speak of the perennial Ashvattha tree, which has roots above and branches below. The leaves protecting it are the Vedas. One who knows this, truly knows. The tender sprouts of this mighty tree are the senses nourished by the gunas. The branches extend both above and below. The secondary roots going downward represent actions that bind the individual soul to earthly existence.

(c) “Bhagavatgita”, chapter 15

On the bottom level of 🐊Putout layes down Syntax Tree. This is data structure that makes possible to do crazy transformations in a simplest possible way. It used mostly in compilers development.

You can read about it in Babel Plugin Handbook. To understand how things works from the inside take a look at Super Tiny Compiler.

Preoccupied with a single leaf, you won't see the tree. Preoccupied with a single tree, you'll miss the entire forest. When you look at a tree, se it for its leafs, its branches, its trunk and the roots, then and only then will you see the tree.

(c) Takuan Soho, "The Unfettered Mind: Writings of the Zen Master to the Sword Master"

Consider next peace of code:

hello = 'world';

It looks this way in ESTree JavaScript syntax format:

{
    "type": "AssignmentExpression",
    "operator": "=",
    "left": {
        "type": "Identifier",
        "name": "hello"
    },
    "right": {
        "type": "StringLiteral",
        "value": "world"
    }
}

When one is not capable of true intelligence, it is good to consult with someone of good sense. An advisor will fulfill the Way when he makes a decision by selfless and frank intelligence because he is not personally involved. This way of doing things will certainly be seen by others as being strongly rooted. It is, for example, like a large tree with many roots.

(c) Yamamoto Tsunetomo "Hagakure"

🐊Putout based on Babel AST. It has a couple differences from ESTree which are perfectly handled by estree-to-babel especially when 🐊Putout running as a plugin for ESLint.

☝️ You can get more information about AST in The Book of AST.

🌴 Laws of the Jungle

• 🐅 engines chilling with engines, and chasing plugins, processors, operators;
• 🦌 plugins chilling with plugins and operators via require('putout').operator;
• 🦒 processors chilling with processors;
• 🐃 operators chilling with operators;

💚 Engines

Engines is the heart of 🐊Putout: Parser, Loader and Runner are running for every processed file. Processor runs all the processors.

Package	Version
@putout/engine-parser
@putout/engine-loader
@putout/engine-runner
@putout/engine-processor

🧪 Processors

With help of processors 🐊Putout can be extended to read any file format and parse JavaScript from there.

Here is a list of built-int processors:

Package	Version
@putout/processor-javascript
@putout/processor-json
@putout/processor-markdown
@putout/processor-ignore
@putout/processor-yaml
@putout/processor-css

You can disable any of them with:

{
    "processors": [
        ["markdown", "off"]
    ]
}

And not bundled processors:

Package	Version
@putout/processor-typescript
@putout/processor-html
@putout/processor-wasm

To enable it use:

{
    "processors": [
        ["typescript", "on"]
    ]
}

Processors can be tested using @putout/test/processors.

🏗 API

In one’s life there are levels in the pursuit of study. In the lowest level, a person studies but nothing comes of it, and he feels that both he and others are unskillful. At this point he is worthless. In the middle level he is still useless but is aware of his own insufficiencies and can also see the insufficiencies of others. At a higher level, he has pride concerning his own ability, rejoices in praise from others, and laments the lack of ability in his fellows. This man has worth. At the highest level a man has the look of knowing nothing.

(c) Yamamoto Tsunetomo "Hagakure"

In the similar way works 🐊Putout API: it has no plugins defined, tabula rasa.

putout(source, options)

First things first, require putout:

const putout = require('putout');

Let's consider the next source with two variables and one call expression:

const hello = 'world';
const hi = 'there';

console.log(hello);

We can declare it as source:

const source = `
    const hello = 'world';
    const hi = 'there';
    
    console.log(hello);
`;

Plugins

Putout supports dynamic loading of plugins from node_modules. Let's consider the example of using the remove-unused-variables plugin:

putout(source, {
    plugins: [
        'remove-unused-variables',
    ],
});
// returns
({
    code: `\n    const hello = 'world';\n\n    console.log(hello);\n`,
    places: [],
});

As you see, places is empty, but the code is changed: there is no hi variable.

No fix

From the beginning, 🐊Putout developed with ability to split the main process into two concepts: find (find places that could be fixed) and fix (apply the fixes to the files). It is therefore easy to find sections that could be fixed. In the following example redundant variables are found without making changes to the source file:

putout(source, {
    fix: false,
    plugins: [
        'remove-unused-variables',
    ],
});
// returns
({
    code: '\n' +
    `    const hello = 'world';\n` +
    `    const hi = 'there';\n` +
    '    \n' +
    '    console.log(hello);\n',
    places: [{
        rule: 'remove-unused-variables',
        message: '"hi" is defined but never used',
        position: {line: 3, column: 10},
    }],
});

🗺 Source map

Source maps are embedded in the generated source using a special comment. These comments may contain the entire source map, using a Data URI, or may reference an external URL or file.

(c) Source maps in Node.js

In our case Data URL used. Here is an example of source map:

{
    "version": 3,
    "file": "out.js",
    "sourceRoot": "",
    "sources": ["foo.js", "bar.js"],
    "names": ["src", "maps", "are", "fun"],
    "mappings": "AAgBC,SAAQ,CAAEA"
}

To generate source map you need to pass:

• ✅ sourceFileName;
• ✅ sourceMapName;

putout(source, {
    fix: false,
    sourceFileName: 'hello.js',
    sourceMapName: 'world.js',
    plugins: [
        'remove-unused-variables',
    ],
});
// returns
({
    code: '\n' +
    `    const hello = 'world';\n` +
    `    const hi = 'there';\n` +
    '    \n' +
    '    console.log(hello);\n' +
    '   //# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJ...',
    places: [{
        rule: 'remove-unused-variables',
        message: '"hi" is defined but never used',
        position: {line: 3, column: 10},
    }],
});

🏨 Built-in transformations

JavaScript

  function show() {
-     const message = 'hello';
      console.log('hello world');
  }

-for (const {a, b} of c) {
+for (const {a} of c) {
    console.log(a);
}

-let a;
- a = 1;
let b;
b = 2;
console.log(b);

const a = {
-   x: 'hello',
-   ...y,
    x: 'world',
    ...y,
}

switch (x) {
    case 5:
        console.log('hello');
        break;
-   case 5:
-       console.log('zz');
-       break;
}

  class Hello {
    #a = 5;
-   #b = 3;
    get() {
        return this.#a;
    };
}

  function show(error) {
-     showError;
  }

-   function hi(a) {
-       const b = a;
    };
+   function hi(b) {
    };

-const load = stub().rejects(assign(Error('LOAD USED')));
+const load = stub().rejects(Error('LOAD USED'));

-const a = 'hello'.replace(world, world);
+const a = 'hello';

-new Error('something when wrong');
+Error('something when wrong');

-const map = Map();
+const map = new Map();

-const s = String('hello');
+const s = 'hello';

-const [str] = lines.map((line) => `hello ${line}`);
+const [line] = lines;
+const str = `hello ${line}`;

-for (sign = decpt, i = 0; (sign /= 10) != 0; i++)
-    continue;
+for (sign = decpt, i = 0; (sign /= 10) != 0; i++);

-a = a + b;
+a += b;

-module.exports.traverse = ({push}) => {
-    return {
-        ObjectExpression(path) {
-        }
-    }
-};
+module.exports.traverse = ({push}) => ({
+    ObjectExpression(path) {
+    }
+});

-const a = Array(1, 2, 3);
+const a = [1, 2, 3];

-if (zone?.tooltipCallback) {
-    zone.tooltipCallback(e);
-}
+zone?.tooltipCallback(e);

-const a = Boolean(b.includes(c));
+const a = b.includes(c);

--if (!!a)
++if (a)
    console.log('hi');

-const f = (...a) => fn(...a);
-array.filter((a) => a);

+const f = fn;
+array.filter(Boolean);

- typeof typeof 'hello';
+ typeof 'hello';

-const {compare} = operator;
import {operator} from 'putout';
+const {compare} = operator

-const [arg] = process.argv;
import esbuild from 'esbuild';
+const [arg] = process.argv;

+const fs = import 'fs/promises';
+const {stub} = import 'supertape';
+const {assign} = Object;

const readFile = stub();
assign(fs, {
    readFile,
});

onIfStatement({
    push,
-   generate,
-   abc,
})

function onIfStatement({push}) {
}

-let y = `${"hello"} + ${"world"}`;
+let y = `hello + world`;

-for (const a of ['hello']) {
-    console.log(a);
-}
+console.log('hello');

-for (const [, element] of array.entries()) {
-}
+for (const element of array) {
+}

const putout = require('putout');
-const {operator} = require('putout');
+const {operator} = putout;

-const createRegExp = (a) = RegExp(a, 'g');
+const createRegExp = (a) => RegExp(a, 'g');

-if (a = 5) {
+if (a === 5) {
}

-const a = 'hello \'world\'';
+const a = `hello 'world'`;

+const isFn = (a) => typeof a === 'function';
+
+if (isFn(fn))
-if (typeof fn === 'function')
    fn();

-a | !b
+a || !b

-if (a == b) {
+if (a === b) {
}

-Math.sqrt(a ** 2 + b ** 2);
+Math.hypot(a, b);

-const a = Math.sqrt(b ** 2 + c ** 2);
+const a = Math.hypot(a, b);

- const a = Math.imul(b, c);
+ const a = b * c;

-const t = 'hello \"world\"';
-const s1 = `hello \"world\"`;
-const s = `hello \'world\'`;
+const t = 'hello "world"';
+const s1 = `hello "world"`;
+const s = `hello 'world'`;

-for (const x of Array.from(y)) {}
+for (const x of y) {}

-for (const x of [...y]) {}
+for (const x of y) {}

- debugger;

-(function() {
-    console.log('hello world');
-}());
+console.log('hello world');

-if (a === true)
+if (a)
    alert();

-const t = true && false;
+const t = false;

for (const x of Object.keys(a)) {
-   {
-       console.log(x);
-   }
+   console.log(x);
}

function hi() {
    return 5;
-   console.log('hello');
}

-let a, b;
+let a;
+let b;

-const {a: {b}} = c;
+const {a} = c;
+const {b} = a;

-const {a} = {a: 5};
-const [b] = [5];
+const a = 5;
+const b = 5;

-!(options && !options.bidirectional);
+!options || options.bidirectional;

-module.exports = fs.copyFileSync ? fs.copyFileSync : copyFileSync;
+module.exports = fs.copyFileSync || copyFileSync;

-console.log('hello');

-if (x > 0) {
-}

-const {} = process;

-'use strict';
-
import * from fs;

+'use strict';
+
const fs = require('fs');

function hi(a) {
-   if (2 < 3) {
-       console.log('hello');
-       console.log('world');
-   }
+   console.log('hello');
+   console.log('world');
};

function world(a) {
-   if (false) {
-       console.log('hello');
-       console.log('world');
-   }
};

-import hello from 'world';
+const hello = require('world');

-const hello = require('world');
+import hello from 'world';

-'hello'.replace(/hello/g, 'world');
+'hello'.replaceAll('hello', 'world');

-const hello = world.hello;
-const a = b[0];
+const {hello} = world;
+const [a] = b;

-const {readFile} = import('fs/promises');
+const {readFile} = await import('fs/promises');

-if (2 > 3);
+if (2 > 3)
    alert();

-x instanceof Array;
+Array.isArray(x);

-const latest = (a) => a[a.length - 1];
+const latest = (a) => a.at(-1);

-const a = 100000000;
+const a = 100_000_000;

-const result = hello && hello.world;
+const result = hello?.world;

-result = typeof result  === 'undefined' ? 'hello': result;
result = result ?? 'hello';

-const fn = (a) => {throw Error(a);}
+const fn = (a) => throw Error(a);

-const {one} = require('numbers'):
-const {two} = require('numbers');
+ const {
+   one,
+   two
+} = require('numbers');

-import {m as b} from 'y';
-import {z} from 'y';
-import x from 'y';
+import x, {m as b, z} from 'y';

-if (a > b)
-    if (b < c)
-        console.log('hi');
+if (a > b && b < c)
+    console.log('hi');

-Math.pow(2, 4);
+2 ** 4;

-module.exports = function(a, b) {
+module.exports = (a, b) => {
}

-for (let i = 0; i < items.length; i++) {
+for (const item of items) {
-   const item = items[i];
    log(item);
}

-Object.keys(json).forEach((name) => {
+for (const name of Object.keys(json)) {
    manage(name, json[name]);
-});
+}

-for (const name in object) {
-   if (object.hasOwnProperty(name)) {
+for (const name of Object.keys(object)) {
    console.log(a);
-   }
}

-names.map((name) => {
+for (const name of names) {
    alert(`hello ${name}`);
+}
-});

-const result = list.reduce((a, b) => a + b, 1);
+let sum = 1;
+for (const a of list) {
+   sum += a;
+}

-const places = [
-    ...items,
-];
+const places = items.slice();

-module.exports.x = 1,
-module.exports.y = 2;
+module.exports.x = 1;
+module.exports.y = 2;

-const {replace} = putout.operator;
-const {isIdentifier} = putout.types;
+const {operator, types} = putout;
+const {replace} = operator;
+const {isIdentifier} = types;

-console.log.apply(console, arguments);
+console.log(...arguments);

-[].concat(...array);
+array.flat();

-function hello() {
-    console.log(arguments);
+function hello(...args) {
+    console.log(args);
}

function merge(a) {
-   return Object.assign({}, a, {
-       hello: 'world'
-   });
+   return {
+       ...a,
+       hello: 'world'
+   };
};

-   const a = b === b;
+   const a = true;

-5 === a;
+a === 5;

-   const a = 5;
+   let a = 5;
    a = 3;

Promises

-   await await Promise.resolve('hello');
+   await Promise.resolve('hello');

-const show = async () => {
+const show = () => {
    console.log('hello');
};

-runCli();
+await runCli();

async function runCli() {
}

async run () {
-   return promise();
+   return await promise();
}

import fs from 'fs';

-(async () => {
-    const data = await fs.promises.readFile('hello.txt');
-})();
+const data = await fs.promises.readFile('hello.txt');

async () => {
-    return Promise.resolve('x');
+    return 'x';
}

async () => {
-    return Promise.reject('x');
+    throw 'x';
}

Node.js

-const {readFile} = require('fs').promises;
+const {readFile} = require('fs/promises');

-   return;
+   process.exit();

-process.exit();

Tape

-test.only('some test here', (t) => {
+test('some test here', (t) => {
    t.end();
});

-test.skip('some test here', (t) => {
+test('some test here', (t) => {
    t.end();
});

TypeScript

-type x = boolean[] | A | string | A | string[] | boolean[];
+type x = boolean[] | A | string | string[];

interface A {
-    x: Array<X>;
+    x: X[];
}

-const x: any = 5;
+const x = 5;

-type SuperType = {
-   [Key in keyof Type]: Type[Key]
-}
+type SuperType = Type;

type SuperType = {
-   +readonly[Key in keyof Type]+?: Type[Key];
+   readonly[Key in keyof Type]?: Type[Key];
}

type oldType = number;
-type newType = oldType;
-const x: newType = 5;
+const x: oldType = 5;

interface Hello {
-   'hello': any;
    'hello': string;
}

type n = number;
-type s = string;
const x: n = 5;

-const boundaryElement = <HTMLElement>e.target;
+const boundaryElement1 = e.target as HTMLElement;

-type SuperType = {
-    [Key in keyof Type]?: Type[Key];
-}
+type SuperType = Partial<Type>;

🏟 Plugins

The 🐊Putout repo is comprised of many npm packages. It is a lerna monorepo similar to babel. It has a lot plugins divided by groups:

Appliers

Package	Version
@putout/plugin-apply-array-at
@putout/plugin-apply-is-array
@putout/plugin-apply-numeric-separators
@putout/plugin-apply-destructuring
@putout/plugin-apply-optional-chaining
@putout/plugin-apply-if-condition
@putout/plugin-apply-early-return
@putout/plugin-apply-comparison-order

Splitters

Package	Version
@putout/plugin-split-variable-declarations
@putout/plugin-split-nested-destructuring

Mergers

Package	Version
@putout/plugin-merge-destructuring-properties
@putout/plugin-merge-duplicate-imports
@putout/plugin-merge-if-statements

Converters

Package	Version
@putout/plugin-convert-apply-to-spread
@putout/plugin-convert-quotes-to-backticks
@putout/plugin-convert-bitwise-to-logical
@putout/plugin-convert-concat-to-flat
@putout/plugin-convert-sqrt-to-hypot
@putout/plugin-convert-imul-to-multiplication
@putout/plugin-convert-esm-to-commonjs
@putout/plugin-convert-commonjs-to-esm
@putout/plugin-convert-array-copy-to-slice
@putout/plugin-convert-template-to-string
@putout/plugin-convert-equal-to-strict-equal
@putout/plugin-convert-index-of-to-includes
@putout/plugin-convert-math-pow
@putout/plugin-convert-to-arrow-function
@putout/plugin-convert-for-to-for-of
@putout/plugin-convert-for-each-to-for-of
@putout/plugin-convert-for-in-to-for-of
@putout/plugin-convert-map-to-for-of
@putout/plugin-convert-reduce-to-for-of
@putout/plugin-convert-object-assign-to-merge-spread
@putout/plugin-convert-comparison-to-boolean
@putout/plugin-convert-typeof-to-is-type
@putout/plugin-convert-mock-require-to-mock-import
@putout/plugin-convert-assignment-to-arrow-function
@putout/plugin-convert-assignment-to-comparison
@putout/plugin-convert-const-to-let

Removers

Package	Version
@putout/plugin-remove-unused-variables
@putout/plugin-remove-unused-for-of-variables
@putout/plugin-remove-unreferenced-variables
@putout/plugin-remove-duplicate-keys
@putout/plugin-remove-duplicate-case
@putout/plugin-remove-unused-expressions
@putout/plugin-remove-unused-private-fields
@putout/plugin-remove-useless-variables
@putout/plugin-remove-useless-assign
@putout/plugin-remove-useless-replace
@putout/plugin-remove-useless-else
@putout/plugin-remove-useless-map
@putout/plugin-remove-useless-constructor
@putout/plugin-remove-useless-return
@putout/plugin-remove-useless-continue
@putout/plugin-remove-useless-operand
@putout/plugin-remove-useless-array-constructor
@putout/plugin-remove-useless-conditions
@putout/plugin-remove-useless-type-conversion
@putout/plugin-remove-useless-functions
@putout/plugin-remove-useless-typeof
@putout/plugin-remove-useless-array-from
@putout/plugin-remove-useless-spread
@putout/plugin-remove-useless-array-entries
@putout/plugin-remove-useless-arguments
@putout/plugin-remove-useless-escape
@putout/plugin-remove-useless-template-expressions
@putout/plugin-remove-useless-for-of
@putout/plugin-remove-debugger
@putout/plugin-remove-iife
@putout/plugin-remove-unreachable-code
@putout/plugin-remove-console
@putout/plugin-remove-empty
@putout/plugin-remove-empty-pattern
@putout/plugin-remove-constant-conditions
@putout/plugin-remove-boolean-from-assertions
@putout/plugin-remove-boolean-from-logical-expressions
@putout/plugin-remove-nested-blocks

Simplifiers

Package	Version
@putout/plugin-simplify-assignment
@putout/plugin-simplify-logical-expressions
@putout/plugin-simplify-ternary

Declarators

Package	Version
@putout/plugin-declare-undefined-variables
@putout/plugin-declare-imports-first
@putout/plugin-declare-before-reference

Not bundled

Next packages not bundled with 🐊Putout but can be installed separately.

Package	Version
@putout/plugin-react-hooks
@putout/plugin-react-router
@putout/plugin-convert-is-nan-to-number-is-nan
@putout/plugin-convert-spread-to-array-from
@putout/plugin-apply-shorthand-properties
@putout/plugin-apply-nullish-coalescing
@putout/plugin-cloudcmd
@putout/plugin-postcss
@putout/plugin-jest
@putout/plugin-travis
@putout/plugin-convert-throw

Groups

Package	Version
@putout/plugin-madrun
@putout/plugin-strict-mode
@putout/plugin-putout
@putout/plugin-putout-config
@putout/plugin-tape
@putout/plugin-webpack
@putout/plugin-eslint
@putout/plugin-package-json
@putout/plugin-promises
@putout/plugin-gitignore
@putout/plugin-npmignore
@putout/plugin-browserlist
@putout/plugin-github
@putout/plugin-regexp
@putout/plugin-nodejs
@putout/plugin-typescript
@putout/plugin-try-catch
@putout/plugin-montag
@putout/plugin-new

Extractors

Package	Version
@putout/plugin-extract-sequence-expressions
@putout/plugin-extract-object-properties

Reusers

Package	Version
@putout/plugin-reuse-duplicate-init

🦚 Formatters

🐊Putout uses formatters similar to ESLint's formatters. You can specify a formatter using the --format or -f flag on the command line. For example, --format codeframe uses the codeframe formatter.

The built-in formatter options are:

• dump
• stream
• json
• json-lines
• codeframe
• progress
• progress-bar
• frame (codeframe + progress)
• memory

Package	Version
@putout/formatter-dump
@putout/formatter-stream
@putout/formatter-progress
@putout/formatter-progress-bar
@putout/formatter-json
@putout/formatter-json-lines
@putout/formatter-codeframe
@putout/formatter-frame
@putout/formatter-eslint
@putout/formatter-memory

Custom Formatter

A formatter function executes on every processed file, it should return an output string.

export default function formatter({name, source, places, index, count, filesCount, errorsCount}) {
    return '';
}

Here is list of options:

• name - name of processed file
• source - source code of processed file
• index - current index
• count - processing files count
• filesCount - count of files with errors
• errorsCount count of errors

You can avoid any of this and use only what you need. To make your formatter usable with putout, add the prefix putout-formatter- to your npm package, and add the tags putout, formatter, putout-formatter.

ESLint Formatters

ESLint formatters can be used as well with help of @putout/formatter-eslint this way:

Install:

npm i putout @putout/formatter-eslint eslint-formatter-pretty -D

Run:

ESLINT_FORMATTER=pretty putout -f eslint lib

🦉 Configuration

To configure 🐊Putout add a section named putout to your package.json file or create .putout.json file and override any of default options.

Rules

All rules located in plugins section and built-in rules are enabled by default. You can disable rules using "off", or enable them (in match section) using "on".

{
    "rules": {
        "remove-unused-variables": "off"
    }
}

Or pass options using rules section:

{
    "rules": {
        "remove-unused-variables": ["on", {
            "exclude": "const global = __"
        }]
    }
}

Exclude

With help of exclude you can set type or code pattern to exclude for current rule. Pass an array when you have a couple templates to exclude:

{
    "rules": {
        "remove-unused-variables": ["on", {
            "exclude": [
                "VariableDeclaration"
            ]
        }]
    }
}

exclude is cross-plugin function supported by core, when develop your plugin, please use other name to keep users ability to customize all plugins in a way they need to.

Match

When you need to match paths to rules you can use match section for this purpose in .putout.json:

{
    "match": {
        "server": {
            "nodejs/remove-process-exit": "on"
        }
    }
}

Ignore

When you need to ignore some routes no matter what, you can use ignore section in .putout.json:

{
    "ignore": [
        "test/fixture"
    ]
}

Plugins

There are two types of plugin names supported by 🐊Putout, their names in npm start with a prefix:

• @putout/plugin- for official plugins
• putout-plugin- for user plugins

Example If you need to remove-something create putout plugin with a name putout-plugin-remove-something and add it to .putout.json:

{
    "plugins": [
        "remove-something"
    ]
}

Add putout as a peerDependency to your packages.json (>= of version you developing for).

☝️ Always add keywords putout, putout-plugin when publish putout plugin to npm so others can easily find it.

🧬 Plugins API

Throughout your life advance daily, becoming more skillful than yesterday more skillful than today. This is never-ending

(c) Yamamoto Tsunetomo "Hagakure"

🐊Putout plugins are the simplest possible way to transform AST and this is for a reason.

And the reason is JavaScript-compatible language 🦎PutoutScript which adds additional meaning to identifiers used in AST-template.

Let's dive into plugin types that you can use for you next code transformation.

Replacer

The simplest 🐊Putout plugin type consists of 2 functions:

• report - report error message to putout cli;
• replace - replace key template into value template;

module.exports.report = () => 'use optional chaining';
module.exports.replace = () => ({
    '__a && __a.__b': '__a?.__b',
});

This plugin will find and suggest to replace all occurrences of code: object && object.property into object?.property.

Includer

More powerful plugin type, when you need more control over traversing. It should contain next 2 functions:

• report - report error message to putout cli;
• fix - fixes paths using places array received using find function;

and one or more of this:

• filter - filter path, should return true, or false (don't use with traverse);
• include - returns array of templates, or node names to include;
• exclude - returns array of templates, or node names to exclude;

module.exports.report = () => 'use optional chaining';
module.exports.include = () => [
    'debugger',
];

module.exports.fix = (path) => {
    path.remove(path);
};

☝️ More information about supported plugin types you can find in @putout/engine-runner.

☝️ Find out about the way plugins load in @putout/engine-loader.

☝️ When you need, you can use @babel/types, template and generate. All of this can be gotten from 🐊Putout:

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

Operator

When you need to use replaceWith, replaceWithMultiple, or insertAfter, please use operator instead of path-methods.

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

const ast = template.ast(`
  const str = 'hello';
`);

module.exports.fix = (path) => {
    // wrong
    path.replaceWith(ast);
    
    // correct
    replaceWith(path, ast);
};

This should be done to preserve loc and comments information, which is different in Babel and Recast. 🐊Putout will handle this case for you :), just use the methods of operator.

🐊 Putout Plugin

When you work on a plugin or codemod please add rule putout into .putout.json:

{
    "rules": {
        "putout": "on"
    }
}

@putout/plugin-putout will handle plugin-specific cases for you :).

Example

Let's consider simplest possible plugin for removing debugger statements @putout/plugin-remove-debugger:

// this is a message to show in putout cli
module.exports.report = () => 'Unexpected "debugger" statement';

// let's find all "debugger" statements and replace them with ""
module.exports.replace = () => ({
    debugger: '',
});

Visitor used in traverse function can be code template as well. So when you need to find module.exports = <something>, you can use:

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

Where __ is a placeholder for anything.

☝️Remember: template key should be valid JavaScript, or Node Type, like in previous example.

You can also use include and/or exclude instead of traverse and filter (more sophisticated example):

// should be always used include/or exclude, when traverse not used
module.exports.include = () => [
    'debugger',
];

// optional
module.exports.exclude = () => [
    'console.log',
];

// optional
module.exports.filter = (path) => {
    // do some checks
    return true;
};

Template

There is predefined placeholders:

• __ - any code;
• "__" - any string literal;
• __ - any template string literal;

📼 Testing

That was the simplest module to remove debugger statements in your code. Let's look how to test it using @putout/test:

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

// this is how we test that messages is correct
test('remove debugger: report', (t) => {
    t.reportCode('debugger', 'Unexpected "debugger" statement');
    t.end();
});

// statement should be removed so result is empty
test('remove debugger: transformCode', (t) => {
    t.transformCode('debugger', '');
    t.end();
});

As you see test runner it is little bit extended 📼Supertape. To see a more sophisticated example look at @putout/plugin-remove-console.

🤷‍♂️ What if I don't want to publish a plugin?

If you don't want to publish a plugin you developed, you can pass it to 🐊Putout as an object described earlier. Here is how it can look like:

putout('const a = 5', {
    plugins: [
        ['remove-unused-variables', require('@putout/plugin-remove-unused-variables')],
    ],
});

Where plugins is an array that contains [name, implementation] tuples.

🗿 Using Babel Plugins with Putout

You can add Babel to the plugins section of .putout.json with babel/ prefix.

You can disable a rule, or use a match in a similar way.

☝️Remember to omit babel-plugin- or @babel/plugin: putout will set it up for you :)

Example Let's add babel-plugin-transform-inline-consecutive-adds to .putout.json:

{
    "plugins": [
        "babel/transform-inline-consecutive-adds"
    ]
}

Then create a file and process it with the help of babel plugin.

coderaiser@cloudcmd:~$ cat > a.js
const t = [];
t.push(1);
t.push(2);

coderaiser@cloudcmd:~$ putout a.js -f codeframe
/home/coderaiser/a.js:4:0
  2 | t.push(1);
  3 | t.push(2);
> 4 |
    | ^ transform inline consecutive adds

✖ 1 errors in 1 files
  fixable with the `--fix` option
coderaiser@cloudcmd:~$ putout --fix a.js
coderaiser@cloudcmd:~$ cat a.js
const t = [1, 2];

Using 🐊Putout as a runner for babel plugins you can not only change file content, but also see what exactly will be changed. You can use your already written babel plugins or reuse work in progress plugins made for babel,

☝️ Remember 🐊Putout plugins gave more accurate information about changing places, and works faster (no need to find information about changes in transformed file).

Babel plugins list

Here you can find babel plugins which feats the most main purpose of 🐊Putout and advised to use:

-const foo = {};
-foo.a = 42;
-foo.b = ["hi"];
-foo.c = bar();
-foo.d = "str";
+const foo = {
+  a: 42,
+  b: ["hi"],
+  c: bar(),
+  d: "str"
+};

-const bar = [];
-bar.push(1);
-bar.push(2);
+const bar = [1, 2];

function merge(a) {
-   return Object.assign({}, a, {
-       hello: 'world'
-   });
+   return {
+       ...a,
+       hello: 'world'
+   };
};

try {
    throw 0;
-} catch (err) {
+} catch {
    console.log("it failed, but this code executes");
}

Please send pull requests with babel plugins which can be used as codemods, or simplify, fix, makes code more readable.

🛴 Codemods

🐊Putout supports codemodes in the similar to plugins way, just create a directory ~/.putout and put your plugins there. Here is example: convert-tape-to-supertape and this is example of work.

rulesdir

When you have plugins related to your project and you don't want to publish them (because it cannot be reused right now). Use rulesdir:

putout --rulesdir ./rules

This way you can keep rules specific for your project and run them on each lint.

☝️ Remember: if you want to exclude file from loading, add prefix not-rule- and 🐊Putout will ignore it (in the same way as he does for node_modules).

⏣ Integration with ESLint

Find and fix problems in your JavaScript code

(c) eslint.org

If you see that 🐊Putout brokes formatting of your code, use ESLint plugin eslint-plugin-putout.

Install eslint-plugin-putout with:

npm i eslint eslint-plugin-putout -D

Then create .eslintrc.json:

{
    "extends": [
        "plugin:putout/recommended"
    ],
    "plugins": [
        "putout"
    ]
}

And use with 🐊Putout this way:

putout --fix lib

To set custom config file for ESLint use ESLINT_CONFIG_FILE env variable:

ESLINT_CONFIG_FILE=test.eslintrc.json putout --fix lib

You can even lint without CLI using ESlint only, since 🐊Putout is bundled to eslint-plugin-putout:

eslint --fix lib

Applies 🐊Putout transformations for you :).

ESLint API

ESLint begins his work as a formatter when 🐊Putout done his transformations. That's why it used a lot in different parts of application, for testing purpose and using API in a simplest possible way. You can access it with:

import eslint from 'putout/eslint';

To use it simply write:

const [source, places] = await eslint({
    name: 'hello.js',
    code: `const t = 'hi'\n`,
    fix: false,
});

Isn't it looks similar to 🐊Putout way? It definitely is! But... It has a couple differences you should remember:

• ☝️ 🐊Putout returns object with code and places properties.
• ☝️ ESLint has a name property that is used to calculate configuration file.*

And you can even override any of ESLint ⚙️ options with help of config property:

const [source, places] = await eslint({
    name: 'hello.js',
    code: `const t = 'hi'\n`,
    fix: false,
    config: {
        extends: [
            'plugin:putout/recommended',
        ],
    },
});

If you want to apply 🐊Putout transformations using putout/putout ESLint rule, enable 🐊Putout with the same called flag lowercased:

const [source, places] = await eslint({
    name: 'hello.js',
    code: `const t = 'hi'\n`,
    fix: true,
    putout: true,
    config: {
        extends: [
            'plugin:putout/recommended',
        ],
    },
});

It is disabled by default, because ESLint always runs after 🐊Putout transformations, so there is no need to traverse tree again.

This API doesn't suppose to came in 🌴 Public Space, anyways it is already used in eslint-plugin-putout to test plugins, so why not :)? Anyways it's signature didn't changed from the beginning.

☄️ Integration with Babel

🐊 Putout can be used as babel plugin. Just create .babelrc.json file with configuration you need.

{
    "plugins": [
        ["putout", {
            "rules": {
                "remove-unused-variables": "off"
            }
        }]
    ]
}

🐈 Integration with Yarn PnP

Since 🐊Putout has dynamic nature of loading:

• plugins;
• processors;
• formatters;

It was a nice adventure to have support of such a wonderful feature of Yarn as Plug'n'Play. For this purpose new env variable was added to help to load external extensions: PUTOUT_YARN_PNP.

So if you package eslint-config-hardcore you should run ESLint this way:

PUTOUT_YARN_PNP=eslint-config-hardcore eslint .

⛓ Using Putout as Loader

🐊Putout can be used as loader this way:

node --loader putout your-file.js

You can also transform input files using Babel. For example if you need to transform jsx with @babel/plugin-transform-react-jsx you can use .putout.json:

{
    "plugins": [
        "babel/transform-react-jsx"
    ]
}

🚪Exit Codes

🐊Putout can have one of next exit codes:

Example of providing invalid option:

coderaiser@localcmd:~/putout$ putout --helo
🐊 Invalid option `--helo`. Perhaps you meant `--help`
coderaiser@localcmd:~/putout$ echo $?
7

API

Exit codes enum can be imported as:

import {OK} from 'putout/exit-codes';

🦔 Real-world uses

• Cloud Commander: orthodox file manager for the web.
• Eslint Config Hardcore: The most strict (but practical) ESLint config out there.
• Mock Import: Mocking of Node.js EcmaScript Modules.
• 🏎 Madrun: CLI tool to run multiple npm-scripts in a madly comfortable way.
• Xterm.js: A terminal for the web.
• Stylelint: A mighty, modern linter that helps you avoid errors and enforce conventions in your styles.
• ESTrace: Trace functions in EcmaScript Modules.
• 🎩ESCover: Coverage for EcmaScript Modules.
• ♨️ Speca: Write tape tests for you.
• Goldstein: JavaScript with no limits 🤫.
• 🎬MadCut: CLI tool to cut markdown into peaces.

Do you use putout in your application as well? Please open a Pull Request to include it here. We would love to have it in our list.

📻 Versioning Policy

Putout follows semantic versioning (semver) principles, with version numbers being on the format major.minor.patch:

• patch: bug fix, dependency update (17.0.0 -> 17.0.1).
• minor: new features, new rules or fixes (17.0.0 -> 17.1.0).
• major breaking changes, removing rules (17.0.0 -> 18.0.0).

🚀 I want contribute

You can contribute by proposing a feature, fixing a bug or a typo in the documentation. If you wish to play with code 🔥, you can 💪! 🐊 Putout rejoice and wag its tail when see new contributions 👾.

🍄 License

MIT