@putout/eslint 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,72 @@
+# @putout/eslint [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/eslint.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/eslint "npm"
+
+Wrapper that simplifies [**ESLint**](https://eslint.org/) API and makes it compatible with 🐊[**Putout**](https://github.com/coderaiser/putout).
+
+## Install
+
+```
+npm i @putout/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:
+
+```js
+import eslint from '@putout/eslint';
+```
+
+To use it simply write:
+
+```js
+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](https://github.com/coderaiser/putout#plugins).*
+- ☝️ ***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:
+
+```js
+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:
+
+```js
+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.
+
+## License
+
+MIT

package/lib/eslint.js

@@ -0,0 +1,131 @@
+'use strict';
+
+const {simpleImport} = require('./simple-import.js');
+const tryToCatch = require('try-to-catch');
+
+const {keys} = Object;
+const eslintId = ' (eslint)';
+const overrideConfigFile = process.env.ESLINT_CONFIG_FILE;
+
+const noConfigFound = (config, configError) => {
+    if (configError && configError.messageTemplate === 'no-config-found')
+        return true;
+    
+    if (configError)
+        return false;
+    
+    if (!keys(config.rules).length)
+        return true;
+    
+    return false;
+};
+
+const cutNewLine = ({message}) => ({
+    message: message.replace(/\n.*/, ''),
+});
+
+module.exports = async ({name, code, fix, config, putout = false}) => {
+    const noChanges = [
+        code,
+        [],
+    ];
+    
+    const [, ESLint] = await tryToCatch(simpleImport, './get-eslint.mjs');
+    
+    if (!ESLint)
+        return noChanges;
+    
+    const {getESLint} = ESLint;
+    const [eslintError, eslint] = await tryToCatch(getESLint, {
+        fix,
+        config,
+        overrideConfigFile,
+    });
+    
+    if (eslintError)
+        return [
+            code,
+            [convertToPlace(cutNewLine(eslintError))],
+        ];
+    
+    const [configError, finalConfig] = await tryToCatch(eslint.calculateConfigForFile, name);
+    
+    if (noConfigFound(finalConfig, configError))
+        return noChanges;
+    
+    if (configError) {
+        return [
+            code,
+            [convertToPlace(parseError(configError))],
+        ];
+    }
+    
+    !putout && disablePutout(finalConfig);
+    
+    // that's right, we disabled "putout" rules in "config"
+    // and now it located in eslint's cache
+    const results = await eslint.lintText(code, {
+        filePath: name,
+    });
+    
+    if (!results.length)
+        return noChanges;
+    
+    const [report] = results;
+    const {output} = report;
+    const places = report.messages.map(convertToPlace);
+    
+    return [
+        output || code,
+        places,
+    ];
+};
+
+module.exports._noConfigFound = noConfigFound;
+
+const parseRule = (rule) => rule || 'parser';
+
+module.exports.convertToPlace = convertToPlace;
+function convertToPlace({ruleId = 'parser', message, line = 0, column = 0}) {
+    const rule = `${parseRule(ruleId)}${eslintId}`;
+    
+    return {
+        rule,
+        message: replaceControlChars(message),
+        position: {
+            line,
+            column,
+        },
+    };
+}
+
+function disablePutout(config) {
+    if (!config.rules['putout/putout'])
+        return;
+    
+    config.rules['putout/putout'] = 'off';
+}
+
+// when eslint config got errors, table formatter used for reporting
+// can't show control characters and crash
+//
+// https://stackoverflow.com/questions/26741455/how-to-remove-control-characters-from-string
+const replaceControlChars = (a) => a.replace(/[\x00-\x1F]/g, '. ');
+
+function parseError(e) {
+    const {
+        messageTemplate,
+        messageData,
+        message,
+    } = e;
+    
+    if (messageTemplate !== 'plugin-missing')
+        return {
+            message: replaceControlChars(message),
+        };
+    
+    return {
+        message: `Plugin missing: ${messageData.pluginName}`,
+    };
+}
+

package/lib/get-eslint.mjs

@@ -0,0 +1,23 @@
+import {ESLint} from 'eslint';
+
+export const getESLint = ({fix, config, overrideConfigFile, ESLintOverride = ESLint}) => {
+    const eslint = new ESLintOverride({
+        fix,
+        overrideConfig: {
+            ignorePatterns: [
+                '!.*',
+            ],
+            ...config,
+        },
+        ...overrideConfigFile && {
+            overrideConfigFile,
+            useEslintrc: false,
+        },
+    });
+    
+    return {
+        calculateConfigForFile: eslint.calculateConfigForFile.bind(eslint),
+        lintText: eslint.lintText.bind(eslint),
+    };
+};
+

package/lib/simple-import.js

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

package/package.json

@@ -0,0 +1,56 @@
+{
+  "name": "@putout/eslint",
+  "version": "1.0.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",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/eslint#readme",
+  "main": "lib/eslint.js",
+  "commitType": "colon",
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report"
+  },
+  "dependencies": {
+    "try-to-catch": "^3.0.1"
+  },
+  "keywords": [
+    "putout",
+    "eslint"
+  ],
+  "devDependencies": {
+    "c8": "^7.5.0",
+    "eslint": "^8.0.1",
+    "eslint-plugin-n": "^15.2.4",
+    "eslint-plugin-putout": "^16.0.0",
+    "just-camel-case": "^4.0.2",
+    "lerna": "^5.0.0",
+    "madrun": "^9.0.0",
+    "mock-require": "^3.0.3",
+    "montag": "^1.0.0",
+    "nodemon": "^2.0.1",
+    "putout": "*",
+    "supertape": "^7.0.0",
+    "try-catch": "^3.0.0"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=16"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}