@putout/eslint 1.0.1 → 1.3.0

package/README.md

@@ -13,6 +13,8 @@ npm i @putout/eslint
 
 ## API
 
+### `eslint(options)`
+
 **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
@@ -67,6 +69,114 @@ const [source, places] = await eslint({
 
 It is disabled by default, because **ESLint** always runs after 🐊**Putout** transformations, so there is no need to traverse tree again.
 
+### `createPlugin(options)`
+
+You can also simplify creating of plugins for **ESLint** with help of `createPlugin`.
+🐊**Putout**-based **ESLint** plugin are highly inspired by [**Putout Plugins API**](https://github.com/coderaiser/putout/tree/master/packages/engine-runner#readme) of [**Includer**](https://github.com/coderaiser/putout/tree/master/packages/engine-runner#includer).
+
+So it must contain classic `4` methods:
+
+```js
+module.exports.report = () => 'debugger statement should not be used';
+
+module.exports.fix = (path) => {
+    return '';
+};
+
+module.exports.include = () => [
+    'DebuggerStatement',
+];
+
+module.exports.filter = (path) => {
+    return true;
+};
+```
+
+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
+const getValue = ({source}) => source?.value;
+
+module.exports.report = () => 'Avoid duplicate extensions in relative imports';
+module.exports.include = () => [
+    'ImportDeclaration',
+    'ImportExpression',
+    'ExportAllDeclaration',
+    'ExportNamedDeclaration',
+];
+
+module.exports.fix = ({text}) => {
+    return text.replace('.js.js', '.js');
+};
+
+module.exports.filter = ({node}) => {
+    const value = getValue(node);
+    return /\.js\.js/.test(value);
+};
+```
+
+To use it just add couple lines to your main plugin file:
+
+```js
+const {createPlugin} = require('@putout/eslint/create-plugin');
+
+const createRule = (a) => ({
+    [a]: createPlugin(require(`./${a}`)),
+});
+
+module.exports.rules = {
+    ...createRule('remove-duplicate-extensions'),
+};
+```
+
+Or just:
+
+```js
+const {createPlugin} = require('@putout/eslint/create-plugin');
+
+module.exports.rules = {
+    '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 removeDebugger = require('./remove-debugger');
+
+const [code, places] = lint('debugger', {
+    filename: 'index.js',
+    options: [{
+        rules: {
+            semi: 'error',
+        },
+    }],
+});
+```
+
 ## License
 
 MIT

package/lib/create-plugin/index.js

@@ -0,0 +1,129 @@
+'use strict';
+
+const prepare = (plugin, context, options) => (node) => {
+    const {filter, report} = plugin;
+    
+    const source = context.getSourceCode();
+    const filename = context.getFilename();
+    const getText = source.getText.bind(source);
+    const getCommentsBefore = source.getCommentsBefore.bind(source);
+    const getCommentsAfter = source.getCommentsAfter.bind(source);
+    const getCommentsInside = source.getCommentsInside.bind(source);
+    
+    const getSpacesBeforeNode = createGetSpacesBeforeNode({
+        getText,
+    });
+    
+    const getSpacesAfterNode = createGetSpacesAfterNode({
+        getText,
+    });
+    
+    const text = getText(node);
+    
+    const result = filter({
+        text,
+        node,
+        options,
+        getText,
+        getCommentsBefore,
+        getCommentsAfter,
+        getCommentsInside,
+        getSpacesBeforeNode,
+        getSpacesAfterNode,
+        filename,
+    });
+    
+    if (!result)
+        return;
+    
+    const fix = prepareFix(plugin.fix, {
+        filename,
+        node,
+        text,
+        getText,
+    });
+    
+    context.report({
+        node,
+        message: report(node),
+        fix,
+    });
+};
+
+const prepareFix = (fix, {node, text, getText, filename}) => (fixer) => {
+    const fixed = fix({
+        node,
+        text,
+        getText,
+        filename,
+    });
+    
+    return [
+        fixer.replaceText(node, fixed),
+    ];
+};
+
+module.exports.createPlugin = (plugin) => {
+    const meta = getMeta(plugin);
+    
+    return {
+        meta,
+        create(context) {
+            const {options} = context;
+            const prepared = prepare(plugin, context, options);
+            const names = plugin.include({options});
+            
+            return getTraversers(names, prepared);
+        },
+    };
+};
+
+function getMeta(plugin) {
+    const {
+        type = 'layout',
+        recommended = true,
+        fixable = 'whitespace',
+    } = plugin;
+    
+    return {
+        type,
+        docs: {
+            recommended,
+        },
+        schema: {},
+        fixable,
+    };
+}
+
+function getTraversers(names, plugin) {
+    const traversers = {};
+    
+    for (const name of names)
+        traversers[name] = plugin;
+    
+    return traversers;
+}
+
+const createGetSpacesBeforeNode = ({getText}) => (node, text = getText(node)) => {
+    let spaces = '';
+    let i = 0;
+    
+    while (!spaces || /^[ \n]+$/.test(spaces))
+        spaces = getText(node, ++i)
+            .replace(text, '');
+    
+    return spaces.slice(1);
+};
+module.exports.createGetSpaceBeforeNode = createGetSpacesBeforeNode;
+
+const createGetSpacesAfterNode = ({getText}) => (node, {text = getText(node)}) => {
+    let spaces = '';
+    let i = 0;
+    
+    while (!spaces || /^[ \n;]+$/.test(spaces))
+        spaces = getText(node, 0, ++i)
+            .replace(text, '');
+    
+    return spaces.slice(0, -1);
+};
+module.exports.createGetSpacesAfterNode = createGetSpacesAfterNode;

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,15 +1,20 @@
 {
   "name": "@putout/eslint",
-  "version": "1.0.1",
+  "version": "1.3.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",
+  "main": "./lib/eslint.js",
   "commitType": "colon",
   "release": false,
   "tag": false,
   "changelog": false,
+  "exports": {
+    ".": "./lib/eslint.js",
+    "./create-plugin": "./lib/create-plugin/index.js",
+    "./lint": "./lib/lint/index.js"
+  },
   "repository": {
     "type": "git",
     "url": "git://github.com/coderaiser/putout.git"