coderaiser / putout

Putout [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL] [![DeepScan][DeepScanIMGURL]][DeepScanURL] [NPMURL]: https://npmjs.org/package/putout "npm" [NPMIMGURL]: https://img.shields.io/npm/v/putout.svg?style=flat&longCache=true [BuildStatusURL]: https://github.com/coderaiser/putout/actions?query=workflow%3A%22Node+CI%22 "Build Status" [BuildStatusIMGURL]: https://github.com/coderaiser/putout/workflows/Node%20CI/badge.svg [CoverageURL]: https://coveralls.io/github/coderaiser/putout?branch=master [CoverageIMGURL]: https://coveralls.io/repos/coderaiser/putout/badge.svg?branch=master&service=github [DeepScanURL]: https://deepscan.io/dashboard#view=project&tid=16903&pid=20211&bid=545558 [DeepScanIMGURL]: https://deepscan.io/api/teams/16903/projects/20211/branches/545558/badge/grade.svg > **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 a JavaScript Linter, pluggable and configurable code transformer, drop-in **ESLint** replacement with built-in code printer and ability to fix syntax errors. It has lots 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; • ✅ Yaml; • ✅ TOML; • ✅ 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? • 🪬Core Concepts • 🚚 Installation • 🎙 Usage • 🦕 Usage with Deno • 📐 What is **Ruler**? • ✂️ How **Ruler** can help me? • 🚁 Convert to • 🏛 Architecture • 🌲 The Tree of Syntax • 🌴 Laws of the Jungle • 🏗 API • 🏨 Built-in transformations • 🛠️ Syntax errors • 🐃 Operators • 🏟 Plugins • 🦚 Formatters • 🦉 Configuration • 🧬 Plugins API • 🛴 codemods • 💾 rulesdir • ⏣ Integration with ESLint • ☄️ Integration with Babel • 🐈 Integration with Yarn • ⛓ 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**: • ❌ SWCLint no-debugger: **49** lines; • ❌ RSLint no-debugger: **48** lines; • ❌ ESLint no-debugger: **43** lines; • ❌ Rome no-debugger: **28** lines; • 🐊 **Putout** remove-debugger: **5** lines: *Choose wisely, competitors cannot even fix…* 🤫 Drop-in ESLint replacement 🐊**Putout** in addition to own format supports both and , it has ability to autodect format you use. Also it works good with monorepository, since it uses that is closer to linting file, instead of of ESLint run. 🙏 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** has no ability to report errors, it only runs transformations. • ❌**Prettier** is a formatter. • ❌**JSCodeshift** has no **config** and **plugins** support. 🐊**Putout** on the other hand can make more drastic code transformations that directly affects your codebase making it a better place to code 💻: • ✅ fixes Reference Errors; • ✅ declares variables; • ✅ converts CommonJS to ESM; • ✅ ...and much more 😏! 🚚 Installation To install 🐊**Putout** as a development dependency, run: 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 most likely you will hear gladly purr : To skip prefix , update your variable in with : To find possible transform places in a folder named , run: To find possible transform places in multiple folders, such as folders named and , run: To apply the transforms, use : ☝️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 or a . 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 option, and observe error messages. Another way is to use traditional version control tactics. Before running 🐊**Putout** you should do a . Then after running 🐊**Putout**, you’ll be able to inspect the changes it made using and . You still have the chance to run at any time to revert all the changes that 🐊**Putout** has made. If you need more fine-grained control, you can also use or to interactively stage only the changes you want to keep. Environment variables 🐊**Putout** supports the following environment variables: • - path to configuration file; • - files that should be processed split by comma ( ); Example: 🦕 Usage with **Deno** When you need to run 🐊**Putout** in **Deno**, use : 📐 What is **Ruler**? When you need to change configuration file use **Ruler** instead of editing the file manually. **Ruler** can: • ✅ ; • ✅ ; • ✅ ; • ✅ ; *☝️Remember, **Ruler** should never be used with , because unclear things makes 🐊 **Putout** angry and you can find hi…