@putout/eslint 4.0.0 → 5.0.0

package/README.md

@@ -29,7 +29,7 @@ NO_ESLINT_WARNINGS=1 putout --fix lib
 **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:
 
 ```js
-import eslint from '@putout/eslint';
+import {eslint} from '@putout/eslint';
 ````
 
 To use it simply write:
@@ -50,27 +50,27 @@ Isn't it looks similar to 🐊**Putout** way? It definitely is! But... It has a
 And you can even override any of **ESLint** ⚙️ options with help of `config` property:
 
 ```js
+import {safeAlign} from 'eslint-plugin-putout';
+
 const [source, places] = await eslint({
     name: 'hello.js',
     code: `const t = 'hi'\n`,
     fix: false,
-    config: {
-        extends: ['plugin:putout/recommended'],
-    },
+    config: [safeAlign],
 });
 ```
 
 If you want to apply 🐊**Putout** transformations using [`putout/putout`](https://github.com/coderaiser/putout/tree/master/packages/eslint-plugin-putout#readme) **ESLint** rule, enable 🐊**Putout** with the same called but lowercased flag:
 
 ```js
+import {safeAlign} from 'eslint-plugin-putout';
+
 const [source, places] = await eslint({
     name: 'hello.js',
     code: `const t = 'hi'\n`,
     fix: true,
     putout: true,
-    config: {
-        extends: ['plugin:putout/recommended'],
-    },
+    config: [safeAlign],
 });
 ```
 
@@ -84,17 +84,17 @@ You can also simplify creating of plugins for **ESLint** with help of `createPlu
 So it must contain classic `4` methods:
 
 ```js
-module.exports.report = () => 'debugger statement should not be used';
+export const report = () => 'debugger statement should not be used';
 
-module.exports.fix = (path) => {
+export const fix = (path) => {
     return '';
 };
 
-module.exports.include = () => [
+export const include = () => [
     'DebuggerStatement',
 ];
 
-module.exports.filter = (path) => {
+export const filter = (path) => {
     return true;
 };
 ```
@@ -110,19 +110,19 @@ Take a look at more sophisticated example, rule [`remove-duplicate-extensions`](
 ```js
 const getValue = ({source}) => source?.value;
 
-module.exports.report = () => 'Avoid duplicate extensions in relative imports';
-module.exports.include = () => [
+export const report = () => 'Avoid duplicate extensions in relative imports';
+export const include = () => [
     'ImportDeclaration',
     'ImportExpression',
     'ExportAllDeclaration',
     'ExportNamedDeclaration',
 ];
 
-module.exports.fix = ({text}) => {
+export const fix = ({text}) => {
     return text.replace('.js.js', '.js');
 };
 
-module.exports.filter = ({node}) => {
+export const filter = ({node}) => {
     const value = getValue(node);
     return /\.js\.js/.test(value);
 };
@@ -131,21 +131,19 @@ module.exports.filter = ({node}) => {
 To use it just add couple lines to your main plugin file:
 
 ```js
-const {createPlugin} = require('@putout/eslint/create-plugin');
+import {createPlugin} from '@putout/eslint/create-plugin';
 
 const createRule = (a) => ({
     [a]: createPlugin(require(`./${a}`)),
 });
 
-module.exports.rules = {
-    ...createRule('remove-duplicate-extensions'),
-};
+module.exports.rules = createRule('remove-duplicate-extensions');
 ```
 
 Or just:
 
 ```js
-const {createPlugin} = require('@putout/eslint/create-plugin');
+import {createPlugin} from '@putout/eslint/create-plugin';
 
 module.exports.rules = {
     'remove-duplicate-extensions': createPlugin(require('./remove-duplicate-extensions')),
@@ -157,9 +155,9 @@ module.exports.rules = {
 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 {createPlugin} = require('@putout/eslint/create-plugin');
-const removeDebugger = require('./remove-debugger');
+import {lint} from '@putout/eslint/lint';
+import {createPlugin} from '@putout/eslint/create-plugin';
+import * as removeDebugger from 'remove-debugger';
 
 const [code, places] = lint('debugger', {
     fix: true, // default
@@ -172,7 +170,7 @@ const [code, places] = lint('debugger', {
 When you want to skip plugins, and just provide `options` and `filename` you can:
 
 ```js
-const lint = require('@putout/eslint/lint');
+import {lint} from '@putout/eslint/lint';
 
 const [code, places] = lint('debugger', {
     filename: 'index.js',

package/lib/create-plugin/index.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const prepare = (plugin, context, options) => (node) => {
     const {filter, report} = plugin;
     const {sourceCode, filename} = context;
@@ -64,7 +62,7 @@ const prepareFix = (fix, {node, text, getText, filename}) => (fixer) => {
     ];
 };
 
-module.exports.createPlugin = (plugin) => {
+export const createPlugin = (plugin) => {
     const meta = getMeta(plugin);
     
     return {
@@ -108,7 +106,7 @@ function getTraversers(names, plugin) {
     return traversers;
 }
 
-const createGetSpacesBeforeNode = ({getText}) => (node, text = getText(node)) => {
+export const createGetSpacesBeforeNode = ({getText}) => (node, text = getText(node)) => {
     let spaces = '';
     let i = 0;
     
@@ -121,9 +119,7 @@ const createGetSpacesBeforeNode = ({getText}) => (node, text = getText(node)) =>
     return spaces.slice(1);
 };
 
-module.exports.createGetSpacesBeforeNode = createGetSpacesBeforeNode;
-
-const createGetSpacesAfterNode = ({getText}) => (node, text = getText(node)) => {
+export const createGetSpacesAfterNode = ({getText}) => (node, text = getText(node)) => {
     const reg = /^[ \n;]+$/;
     
     if (isLastNodeInBody(node))
@@ -138,8 +134,6 @@ const createGetSpacesAfterNode = ({getText}) => (node, text = getText(node)) =>
     return spaces.slice(0, -1);
 };
 
-module.exports.createGetSpacesAfterNode = createGetSpacesAfterNode;
-
 function isLastNodeInBody(node) {
     if (node.parent.body) {
         const {length} = node.parent.body;

package/lib/eslint.js

@@ -1,22 +1,18 @@
-'use strict';
-
-const {join} = require('node:path');
-const process = require('node:process');
-const tryToCatch = require('try-to-catch');
-const once = require('once');
-
-const {simpleImport} = require('./simple-import.js');
-const {isIgnored} = require('./ignore');
+import {join} from 'node:path';
+import process from 'node:process';
+import tryToCatch from 'try-to-catch';
+import {simpleImport as _simpleImport} from './simple-import.js';
+import {isIgnored} from './ignore.js';
 
 const {keys} = Object;
 const eslintId = ' (eslint)';
 
-const isNoESLint = once(() => process.env.NO_ESLINT);
-const noESLintWarnings = process.env.NO_ESLINT_WARNINGS;
-const {ESLINT_CONFIG_FILE} = process.env;
+const {env} = process;
+const isNoESLint = () => env.NO_ESLINT;
+const isNoESLintWarnings = () => env.NO_ESLINT_WARNINGS;
 
 const dir = process.cwd();
-const overrideConfigFile = parseOverride(dir, ESLINT_CONFIG_FILE);
+const overrideConfigFile = () => parseOverride(dir, env.ESLINT_CONFIG_FILE);
 
 const NO_FLAT_CONFIG_FOUND = 'Could not find config file.';
 const WARNING = 1;
@@ -40,11 +36,16 @@ const noConfigFound = (config, configError) => {
     return !keys(config.rules).length;
 };
 
-const cutNewLine = ({message}) => ({
-    message: message.replace(/\n.*/, ''),
-});
-
-module.exports = async ({name, code, fix, config, putout = false}) => {
+export const eslint = async (overrides = {}) => {
+    const {
+        name,
+        code,
+        fix,
+        config,
+        putout = false,
+        simpleImport = _simpleImport,
+    } = overrides;
+    
     const noChanges = [
         code,
         [],
@@ -53,28 +54,20 @@ module.exports = async ({name, code, fix, config, putout = false}) => {
     if (isNoESLint())
         return noChanges;
     
-    const [, ESLint] = await tryToCatch(simpleImport, './get-eslint.mjs');
+    const [, ESLint] = await tryToCatch(simpleImport, './get-eslint.js');
     
     if (!ESLint)
         return noChanges;
     
     const {getESLint} = ESLint;
     
-    const [eslintError, eslint] = await tryToCatch(getESLint, {
+    const eslint = await getESLint({
         name,
         fix,
         config,
-        overrideConfigFile,
+        overrideConfigFile: overrideConfigFile(),
     });
     
-    if (eslintError) {
-        const places = [
-            convertToPlace(cutNewLine(eslintError)),
-        ];
-        
-        return [code, places];
-    }
-    
     const [configError, finalConfig] = await tryToCatch(eslint.calculateConfigForFile, name);
     
     if (noConfigFound(finalConfig, configError))
@@ -102,23 +95,21 @@ module.exports = async ({name, code, fix, config, putout = false}) => {
     const [report] = results;
     const {output = code} = report;
     
-    const places = report
-        .messages
+    const places = report.messages
         .map(convertToPlace)
         .filter(Boolean);
     
     return [output, places];
 };
 
-module.exports._noConfigFound = noConfigFound;
+export const _noConfigFound = noConfigFound;
 
 const parseRule = (rule) => rule || 'parser';
 
-module.exports.convertToPlace = convertToPlace;
-function convertToPlace({ruleId = 'parser', message, line = 0, column = 0, severity}) {
+export function convertToPlace({ruleId = 'parser', message, line = 0, column = 0, severity}) {
     const rule = `${parseRule(ruleId)}${eslintId}`;
     
-    if (severity === WARNING && noESLintWarnings)
+    if (severity === WARNING && isNoESLintWarnings())
         return null;
     
     if (isIgnored(message))

package/lib/get-eslint.js

@@ -0,0 +1,33 @@
+import {dirname} from 'node:path';
+import process from 'node:process';
+import {loadESLint} from 'eslint';
+
+const {isArray} = Array;
+const maybeArray = (a) => isArray(a) ? a : [a];
+const CWD = process.cwd();
+
+export const getESLint = async ({name, fix, config = [], overrideConfigFile, loadESLintOverride = loadESLint}) => {
+    const cwd = dirname(name).replace(/^\./, CWD);
+    
+    const FlatESLint = await loadESLintOverride({
+        useFlatConfig: true,
+    });
+    
+    const eslint = new FlatESLint({
+        cwd,
+        fix,
+        overrideConfig: [
+            ...maybeArray(config), {
+                ignores: ['!.*'],
+            },
+        ],
+        ...overrideConfigFile && {
+            overrideConfigFile,
+        },
+    });
+    
+    return {
+        calculateConfigForFile: eslint.calculateConfigForFile.bind(eslint),
+        lintText: eslint.lintText.bind(eslint),
+    };
+};

package/lib/ignore.js

@@ -1,5 +1,3 @@
-'use strict';
-
 const MESSAGES = [
     `Parsing error: Cannot use keyword 'await' outside an async function`,
     `Parsing error: The keyword 'yield' is reserved`,
@@ -7,7 +5,7 @@ const MESSAGES = [
     `Parsing error: Unexpected reserved word 'yield'`,
 ];
 
-module.exports.isIgnored = (message) => {
+export const isIgnored = (message) => {
     for (const current of MESSAGES) {
         if (message.includes(current))
             return true;

package/lib/lint/index.js

@@ -1,9 +1,7 @@
-'use strict';
+import {Linter} from 'eslint';
+import {convertToPlace} from '../eslint.js';
 
-const {Linter} = require('eslint');
-const {convertToPlace} = require('../eslint.js');
-
-module.exports.lint = (source, {fix = true, plugins, filename, options = []}) => {
+export const lint = (source, {fix = true, plugins, filename, options = []}) => {
     const linter = new Linter({
         configType: 'flat',
     });

package/lib/simple-import.js

@@ -1,6 +1,4 @@
-'use strict';
-
-module.exports.simpleImport = async (url) => {
+export const simpleImport = async (url) => {
     const result = await import(url);
     return result.default || result;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@putout/eslint",
-  "version": "4.0.0",
-  "type": "commonjs",
+  "version": "5.0.0",
+  "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Wrapper that simplifies ESLint API and makes it compatible with 🐊Putout",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/eslint#readme",
@@ -29,7 +29,6 @@
     "report": "madrun report"
   },
   "dependencies": {
-    "find-up": "^7.0.0",
     "once": "^1.4.0",
     "try-to-catch": "^3.0.1"
   },
@@ -38,26 +37,25 @@
     "eslint"
   ],
   "devDependencies": {
-    "@putout/eslint-flat": "^2.0.0",
+    "@putout/eslint-flat": "^3.0.0",
     "@putout/plugin-eslint-plugin": "*",
     "c8": "^10.0.0",
-    "eslint": "^9.0.0",
+    "eslint": "^10.0.0-alpha.0",
     "eslint-plugin-n": "^17.0.0",
-    "eslint-plugin-putout": "^24.1.0",
-    "madrun": "^10.0.0",
-    "mock-require": "^3.0.3",
+    "eslint-plugin-putout": "^29.0.0",
+    "madrun": "^11.0.0",
     "montag": "^1.0.0",
     "nodemon": "^3.0.1",
     "putout": "*",
-    "supertape": "^10.0.0",
+    "supertape": "^11.0.3",
     "try-catch": "^3.0.0"
   },
   "peerDependencies": {
-    "eslint": ">=8"
+    "eslint": ">=9"
   },
   "license": "MIT",
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "public"

package/lib/get-eslint.mjs

@@ -1,110 +0,0 @@
-import {dirname} from 'node:path';
-import process from 'node:process';
-import {loadESLint} from 'eslint';
-import {findUp} from 'find-up';
-
-const {isArray} = Array;
-const maybeArray = (a) => isArray(a) ? a : [a];
-const CWD = process.cwd();
-
-export const getESLint = async ({name, fix, config, overrideConfigFile, loadESLintOverride, find = findUp, findFlat = find, findRC = find}) => {
-    const cwd = dirname(name).replace(/^\./, CWD);
-    const eslint = await chooseESLint({
-        fix,
-        cwd,
-        config,
-        overrideConfigFile,
-        loadESLintOverride,
-        findFlat,
-        findRC,
-    });
-    
-    return {
-        calculateConfigForFile: eslint.calculateConfigForFile.bind(eslint),
-        lintText: eslint.lintText.bind(eslint),
-    };
-};
-
-async function chooseESLint({cwd, config, fix, overrideConfigFile, loadESLintOverride, findFlat, findRC}) {
-    const runESLint = await getESLintRunner({
-        cwd,
-        overrideConfigFile,
-        findFlat,
-        findRC,
-    });
-    
-    return await runESLint({
-        loadESLintOverride,
-        cwd,
-        config,
-        overrideConfigFile,
-        fix,
-    });
-}
-
-async function getOldESLint({cwd, fix, config, overrideConfigFile, loadESLintOverride = loadESLint}) {
-    const ESLint = await loadESLintOverride({
-        useFlatConfig: false,
-    });
-    
-    const eslint = new ESLint({
-        cwd,
-        fix,
-        overrideConfig: {
-            ignorePatterns: ['!.*'],
-            ...config,
-        },
-        ...overrideConfigFile && {
-            overrideConfigFile,
-            useEslintrc: false,
-        },
-    });
-    
-    return eslint;
-}
-
-async function getFlatESLint({cwd, fix, config = [], overrideConfigFile, loadESLintOverride = loadESLint}) {
-    const FlatESLint = await loadESLintOverride({
-        useFlatConfig: true,
-    });
-    
-    const eslint = new FlatESLint({
-        cwd,
-        fix,
-        overrideConfig: [
-            ...maybeArray(config), {
-                ignores: ['!.*'],
-            }
-            ,
-        ],
-        ...overrideConfigFile && {
-            overrideConfigFile,
-        },
-    });
-    
-    return eslint;
-}
-
-const isFlat = (a) => a?.includes('config');
-
-async function getESLintRunner({cwd, findFlat, findRC, overrideConfigFile}) {
-    if (overrideConfigFile)
-        return isFlat(overrideConfigFile) ? getFlatESLint : getOldESLint;
-    
-    const [rcConfig = '', flatConfig = ''] = await Promise.all([
-        findRC(['.eslintrc.json', '.eslintrc.js'], {
-            cwd,
-        }),
-        findFlat(['eslint.config.js', 'eslint.config.mjs', 'eslint.config.cjs'], {
-            cwd,
-        }),
-    ]);
-    
-    const noConfigFound = !rcConfig && !flatConfig;
-    const foundRConfig = rcConfig.length > flatConfig.length;
-    
-    if (noConfigFound || foundRConfig)
-        return getOldESLint;
-    
-    return getFlatESLint;
-}