eslint-plugin-putout 25.0.4 → 25.1.0

package/README.md

@@ -17,7 +17,32 @@ npm i putout eslint eslint-plugin-putout -D
 
 ## Usage
 
-Update `eslint.config.js` with:
+### Plugin
+
+To use `putout` as ESLint plugin you can use in `eslint.config.js`
+
+```js
+import putout from 'eslint-plugin-putout';
+
+export default [
+    rules: {
+        'putout/putout': 'error',
+    },
+    plugins: {
+        putout,
+    },
+];
+```
+
+### Preset
+
+Also you can import one of predefined preset:
+
+- ✅ **recommended** - all rules enabled;
+- ✅ **safe** - dangerous rules disabled;
+- ✅ **safeAlign** - dangerous rules disabled + add whitespaces on empty lines;
+
+Here is how it can look like:
 
 ```js
 import {recommended} from 'eslint-plugin-putout';
@@ -25,6 +50,22 @@ import {recommended} from 'eslint-plugin-putout';
 export default recommended;
 ```
 
+Or with [`defineConfig`](https://eslint.org/blog/2025/03/flat-config-extends-define-config-global-ignores/):
+
+```js
+import {defineConfig} from 'eslint/config';
+import putout from 'eslint-plugin-putout';
+
+export default defineConfig({
+    plugins: {
+        putout,
+    },
+    extends: [
+        "putout/recommended",
+    ]
+});
+```
+
 Then configure the rules you want to use under the rules section.
 
 ```json

package/lib/index.mjs

@@ -139,8 +139,4 @@ export const configs = {
     esm,
 };
 
-const {rules} = putout;
-
-export {
-    rules,
-};
+export default putout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-putout",
-  "version": "25.0.4",
+  "version": "25.1.0",
   "type": "commonjs",
   "description": "ESLint plugin for 🐊Putout",
   "release": false,