@putout/eslint 1.1.0 → 1.4.0

package/README.md

@@ -5,6 +5,8 @@
 
 Wrapper that simplifies [**ESLint**](https://eslint.org/) API and makes it compatible with 🐊[**Putout**](https://github.com/coderaiser/putout).
 
+☝️ *[FlatConfig](https://eslint.org/blog/2022/08/new-config-system-part-2/) supported from the box.*
+
 ## Install
 
 ```
@@ -34,7 +36,7 @@ const [source, places] = await eslint({
 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](https://github.com/coderaiser/putout#plugins).*
-- ☝️ * **ESLint** has a `name` property that is used to calculate configuration file. *
+- ☝️ ***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:
 
@@ -92,6 +94,12 @@ module.exports.filter = (path) => {
 };
 ```
 
+The main difference with [Includer](https://github.com/coderaiser/putout/tree/master/packages/engine-runner#includer) is:
+
+- `fix` works with text;
+- `include` does not support 🦎[PutoutScript](https://github.com/coderaiser/putout/blob/master/docs/putout-script.md#-putoutscript);
+- there is no `exclude`;
+
 Take a look at more sophisticated example, rule [`remove-duplicate-extensions`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout/lib/remove-duplicate-extensions#readme):
 
 ```js
@@ -135,10 +143,41 @@ Or just:
 const {createPlugin} = require('@putout/eslint/create-plugin');
 
 module.exports.rules = {
-    'remove-duplicate-extensions': createPlugin('remove-duplicate-extensions'),
+    'remove-duplicate-extensions': createPlugin(require('./remove-duplicate-extensions')),
 };
 ```
 
+### `lint(source, {fix, plugins, options, filename})`
+
+When you need to run **ESLint** with one plugin (*rule*), just use `lint` it will do the thing.
+
+```js
+const lint = require('@putout/eslint/lint');
+const removeDebugger = require('./remove-debugger');
+
+const [code, places] = lint('debugger', {
+    fix: true, // default
+    plugins: [
+        ['remove-debugger', createPlugin(removeDebugger)],
+    ],
+});
+```
+
+When you want to skip plugins, and just provide `options` and `filename` you can:
+
+```js
+const lint = require('@putout/eslint/lint');
+
+const [code, places] = lint('debugger', {
+    filename: 'index.js',
+    options: [{
+        rules: {
+            semi: 'error',
+        },
+    }],
+});
+```
+
 ## License
 
 MIT

package/lib/create-plugin/index.js

@@ -114,6 +114,7 @@ const createGetSpacesBeforeNode = ({getText}) => (node, text = getText(node)) =>
     
     return spaces.slice(1);
 };
+module.exports.createGetSpaceBeforeNode = createGetSpacesBeforeNode;
 
 const createGetSpacesAfterNode = ({getText}) => (node, {text = getText(node)}) => {
     let spaces = '';
@@ -125,4 +126,4 @@ const createGetSpacesAfterNode = ({getText}) => (node, {text = getText(node)}) =
     
     return spaces.slice(0, -1);
 };
-
+module.exports.createGetSpacesAfterNode = createGetSpacesAfterNode;

package/lib/eslint.js

@@ -37,6 +37,7 @@ module.exports = async ({name, code, fix, config, putout = false}) => {
     
     const {getESLint} = ESLint;
     const [eslintError, eslint] = await tryToCatch(getESLint, {
+        name,
         fix,
         config,
         overrideConfigFile,

package/lib/get-eslint.mjs

@@ -1,6 +1,45 @@
 import {ESLint} from 'eslint';
+import FlatESLintExports from 'eslint/use-at-your-own-risk';
+import {findUpSync} from 'find-up';
 
-export const getESLint = ({fix, config, overrideConfigFile, ESLintOverride = ESLint}) => {
+const {FlatESLint} = FlatESLintExports;
+
+export const getESLint = ({name, fix, config, overrideConfigFile, ESLintOverride, find = findUpSync}) => {
+    const eslint = chooseESLint({
+        fix,
+        name,
+        config,
+        overrideConfigFile,
+        ESLintOverride,
+        find,
+    });
+    
+    return {
+        calculateConfigForFile: eslint.calculateConfigForFile.bind(eslint),
+        lintText: eslint.lintText.bind(eslint),
+    };
+};
+
+function chooseESLint({name, config, fix, overrideConfigFile, ESLintOverride, find}) {
+    if (find('eslint.config.js'))
+        return getFlatESLint({
+            ESLintOverride,
+            name,
+            config,
+            overrideConfigFile,
+            fix,
+        });
+    
+    return getOldESLint({
+        name,
+        config,
+        ESLintOverride,
+        overrideConfigFile,
+        fix,
+    });
+}
+
+function getOldESLint({fix, config, overrideConfigFile, ESLintOverride = ESLint}) {
     const eslint = new ESLintOverride({
         fix,
         overrideConfig: {
@@ -15,9 +54,23 @@ export const getESLint = ({fix, config, overrideConfigFile, ESLintOverride = ESL
         },
     });
     
-    return {
-        calculateConfigForFile: eslint.calculateConfigForFile.bind(eslint),
-        lintText: eslint.lintText.bind(eslint),
-    };
-};
+    return eslint;
+}
+
+function getFlatESLint({fix, config, overrideConfigFile, ESLintOverride = FlatESLint}) {
+    const eslint = new ESLintOverride({
+        fix,
+        overrideConfig: {
+            ignores: [
+                '!.*',
+            ],
+            ...config,
+        },
+        ...overrideConfigFile && {
+            overrideConfigFile,
+        },
+    });
+    
+    return eslint;
+}
 

package/lib/lint/index.js

@@ -0,0 +1,45 @@
+'use strict';
+
+const {Linter} = require('eslint');
+const {convertToPlace} = require('../eslint.js');
+
+module.exports.lint = (source, {fix = true, plugins, filename, options = []}) => {
+    const linter = new Linter({
+        configType: 'flat',
+    });
+    
+    const allOptions = [];
+    
+    if (plugins) {
+        const [name, plugin] = plugins[0];
+        allOptions.push({
+            rules: {
+                [`${name}/plugin`]: 'error',
+            },
+            plugins: {
+                [name]: {
+                    rules: {
+                        plugin,
+                    },
+                },
+            },
+        });
+    }
+    
+    allOptions.push(...options);
+    
+    const mainOptions = {};
+    
+    if (filename)
+        mainOptions.filename = filename;
+    
+    if (!fix) {
+        const places = linter.verify(source, allOptions, mainOptions).map(convertToPlace);
+        return [source, places];
+    }
+    
+    const {output, messages} = linter.verifyAndFix(source, allOptions, mainOptions);
+    
+    return [output, messages.map(convertToPlace)];
+};
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/eslint",
-  "version": "1.1.0",
+  "version": "1.4.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Wrapper that simplifies ESLint API and makes it compatible with 🐊Putout",
@@ -12,7 +12,8 @@
   "changelog": false,
   "exports": {
     ".": "./lib/eslint.js",
-    "./create-plugin": "./lib/create-plugin/index.js"
+    "./create-plugin": "./lib/create-plugin/index.js",
+    "./lint": "./lib/lint/index.js"
   },
   "repository": {
     "type": "git",
@@ -29,6 +30,7 @@
     "report": "madrun report"
   },
   "dependencies": {
+    "find-up": "^6.3.0",
     "try-to-catch": "^3.0.1"
   },
   "keywords": [