@putout/test 4.0.1 → 4.4.0

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/test.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/test "npm"
 
-Test runner for [🐊`Putout`](https://github.com/coderaiser/putout#plugins-api). Basically it is [supercharged `tape`](https://github.com/coderaiser/supertape) with aditional asseritions:
+Test runner for 🐊[`Putout`](https://github.com/coderaiser/putout#plugins-api). Basically it is [supercharged `tape`](https://github.com/coderaiser/supertape) with aditional asseritions:
 
 ## Install
 
@@ -21,6 +21,21 @@ UPDATE=1 tape test/*.js
 
 ## Plugins API
 
+All plugins 🐊`Putout` plugins written in `CommonJS`, since `ESLint` written on `CommonJS` and we have a huge `ESLint`-based ecosystem which is good to reuse.
+🐊`Putout`can be used in all IDE's supported by`ESLint` as [`eslint-plugin-putout`](https://github.com/coderaiser/putout/tree/packages/eslint-plugin-putout).
+When [async rules will be supported](https://github.com/eslint/eslint/issues/15394) we can switch to `ESM`.
+
+To write test for your plugins you need initialize `test` using `createTest`:
+
+```js
+import {createTest} from '@putout/test';
+const rmVars = require('@putout/plugin-remove-unused-variables');
+
+const test = createTest(import.meta.url, {
+    'remove-unused-variables': rmVars,
+});
+```
+
 ### `report(filename, message | []messages)`
 
 checks error message (or messages) of a plugin
@@ -168,6 +183,19 @@ test('plugin-apply-numeric-separators: no transform: hex', (t) => {
 });
 ```
 
+## Formatters API
+
+First you need to create test with:
+
+```js
+import {createTest} from '@putout/test';
+import rmVars from '@putout/plugin-remove-unused-variables';
+
+const test = createTest(import.meta.url, {
+    'remove-unused-variables': rmVars,
+});
+```
+
 ### `format(formatter, filename)`
 
 check file name formatting (pass `process.env.UPDATE=1` to save fixture)
@@ -203,8 +231,11 @@ test('formatter: dump: many', async ({formatMany}) => {
 Here is example of tests for [remove-console](https://github.com/coderaiser/putout/tree/master/packages/plugin-remove-console):
 
 ```js
-const test = require('@putout/test')(__dirname, {
-    'remove-console': require('..'),
+const {createTest} = require('@putout/test');
+const removeConsole = require('@putout/plugin-remove-console');
+
+const test = createTest(__dirname, {
+    'remove-console': removeConsole,
 });
 
 test('remove-console: report', (t) => {
@@ -224,6 +255,70 @@ test('test: declared', (t) => {
 });
 ```
 
+## ESLint API
+
+First you need to create test with:
+
+```js
+import {createTest} from '@putout/test/eslint';
+const test = createTest(import.meta.url);
+```
+
+### `process(filename [, config])`
+
+Works in similar to [transform](#transformfilename--output-plugins) way:
+
+- ✅ reads `operator-linebreak.js`;
+- ✅ transforms it;
+- ✅ checks that transformed is equal to `operator-linebreak-fix.js`;
+
+Example:
+
+```js
+test('test: eslint: transform', async ({process}) => {
+    await process('operator-linebreak');
+});
+
+test('test: eslint: transform', async ({process}) => {
+    await process('operator-linebreak', {
+        rules: {
+            'putout/putout': {
+                rules: {
+                    'convert-esm-to-commonjs': 'on',
+                },
+            },
+        },
+    });
+});
+```
+
+### `noProcess(filename)`
+
+Check that filename would not be processed.
+
+Example:
+
+```js
+test('test: eslint: noProcess', async ({noProcess}) => {
+    await noProcess('operator-linebreak-fix');
+});
+```
+
+### `comparePlaces(filename, places)`
+
+```js
+test('eslint-config: operator-line-break', async ({comparePlaces}) => {
+    await comparePlaces('operator-linebreak', [{
+        "message": "There should be no line break before or after '='.",
+        "position": {
+            "column": 1,
+            "line": 2,
+        },
+        "rule": "operator-linebreak (eslint)",
+    }]);
+});
+```
+
 ## Processors API
 
 With `processors api` you can test `processors` in a simplest possible way.

package/lib/eslint/eslint.mjs

@@ -0,0 +1,76 @@
+import {readFile} from 'fs/promises';
+import {join} from 'path';
+
+import eslint from 'putout/eslint';
+import tryToCatch from 'try-to-catch';
+import {extend} from 'supertape';
+
+const config = {
+    extends: [
+        'plugin:node/recommended',
+        'plugin:eslint-plugin/recommended',
+        'plugin:putout/recommended',
+    ],
+};
+
+const read = async (name) => {
+    const [, data] = await tryToCatch(readFile, `${name}.js`, 'utf8');
+    
+    if (data)
+        return [`${name}.js`, data];
+    
+    return [`${name}.ts`, await readFile(`${name}.ts`, 'utf8')];
+};
+
+export const createTest = (url) => {
+    const fixtureDir = new URL('fixture', url).pathname;
+    
+    return extend({
+        process: (operator) => async (name, override) => {
+            const full = join(fixtureDir, name);
+            const [resolvedName, code] = await read(full);
+            const [, fixture] = await read(`${full}-fix`);
+            const fix = true;
+            
+            const [source] = await eslint({
+                name: resolvedName,
+                code,
+                fix,
+                putout: true,
+                config: {
+                    ...config,
+                    ...override,
+                },
+            });
+            
+            return operator.equal(source, fixture);
+        },
+        noProcess: (operator) => async (name) => {
+            const full = join(fixtureDir, name);
+            const [resolvedName, code] = await read(full);
+            const fix = true;
+            
+            const [source] = await eslint({
+                name: resolvedName,
+                config,
+                code,
+                fix,
+            });
+            
+            return operator.equal(source, code);
+        },
+        comparePlaces: (operator) => async (name, expected) => {
+            const full = join(fixtureDir, name);
+            const [resolvedName, code] = await read(full);
+            
+            const [, places] = await eslint({
+                config,
+                name: resolvedName,
+                code,
+            });
+            
+            return operator.deepEqual(places, expected);
+        },
+    });
+};
+

package/lib/test.js

@@ -18,15 +18,13 @@ const isString = (a) => typeof a === 'string';
 const {isArray} = Array;
 const {keys, entries} = Object;
 
-const {UPDATE} = process.env;
-global.__putout_test_update = UPDATE;
 global.__putout_test_fs = {
     readFileSync,
     writeFileSync,
     existsSync,
 };
 
-const isUpdate = () => UPDATE || global.__putout_test_update;
+const isUpdate = () => Boolean(Number(process.env.UPDATE));
 
 const TS = {
     ENABLED: true,
@@ -42,7 +40,10 @@ const readFixture = (name) => {
     return [readFileSync(`${name}.js`, 'utf8'), TS.DISABLED];
 };
 
-module.exports = (dir, plugin, rules) => {
+module.exports = createTest;
+module.exports.createTest = createTest;
+
+function createTest(dir, plugin, rules) {
     const update = isUpdate();
     
     dir = join(dir, 'fixture');
@@ -75,7 +76,7 @@ module.exports = (dir, plugin, rules) => {
         formatMany: (update ? formatManySave : formatMany)({dir, plugins, rules}),
         noFormat: noFormat({dir, plugins, rules}),
     });
-};
+}
 
 const format = currify(({dir, plugins, rules}, t) => async (formatter, name, formatterOptions = {}) => {
     const full = join(dir, name);
@@ -211,6 +212,8 @@ const formatSave = currify(({dir, plugins, rules}, t) => async (formatter, name,
 });
 
 const transform = currify(({dir, plugins, rules}, t, name, transformed = null, addons = {}) => {
+    const {writeFileSync} = global.__putout_test_fs;
+    
     const full = join(dir, name);
     const [input, isTS] = readFixture(full);
     const isStr = isString(transformed);
@@ -231,13 +234,15 @@ const transform = currify(({dir, plugins, rules}, t, name, transformed = null, a
         }],
     });
     
-    if (isUpdate())
+    if (isUpdate() && !isStr) {
         writeFileSync(`${full}-fix.js`, code);
+    }
     
     return t.equal(code, output);
 });
 
 const transformWithOptions = currify(({dir, plugins}, t, name, options) => {
+    const {writeFileSync} = global.__putout_test_fs;
     const full = join(dir, name);
     const [input, isTS] = readFixture(full);
     
@@ -404,11 +409,15 @@ function preTest(test, plugin) {
         match,
     }] = entries(plugin).pop();
     
+    const options = {
+        checkDuplicates: false,
+    };
+    
     if (rules) {
         test(`${name}: rules is an object`, (t) => {
             t.equal(typeof rules, 'object', 'should export "rules" object');
             t.end();
-        }, {checkDuplicates: false});
+        }, options);
         
         const entries = Object.entries(rules);
         for (const [entryName, plugin] of entries) {
@@ -420,10 +429,6 @@ function preTest(test, plugin) {
         return;
     }
     
-    const options = {
-        checkDuplicates: false,
-    };
-    
     test(`${name}: report: is function`, (t) => {
         t.equal(typeof report, 'function', 'should export "report" function');
         t.end();

package/lib/test.mjs

@@ -0,0 +1,12 @@
+import {dirname} from 'path';
+import {fileURLToPath} from 'url';
+import create from './test.js';
+
+export default create;
+
+export const createTest = (url, plugins) => {
+    const __filename = fileURLToPath(url);
+    const __dirname = dirname(__filename);
+    
+    return create(__dirname, plugins);
+};

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@putout/test",
-  "version": "4.0.1",
+  "version": "4.4.0",
+  "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "test runner for putout plugins ",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/test#readme",
@@ -9,8 +10,13 @@
     "tape": "bin/test.mjs"
   },
   "exports": {
-    ".": "./lib/test.js",
-    "./processor": "./lib/processor/index.js"
+    ".": {
+      "require": "./lib/test.js",
+      "import": "./lib/test.mjs"
+    },
+    "./processor": "./lib/processor/index.js",
+    "./formatter": "./lib/formatter/index.mjs",
+    "./eslint": "./lib/eslint/eslint.mjs"
   },
   "release": false,
   "tag": false,
@@ -34,7 +40,8 @@
     "currify": "^4.0.0",
     "putout": "*",
     "supertape": "^6.0.0",
-    "try-catch": "^3.0.0"
+    "try-catch": "^3.0.0",
+    "try-to-catch": "^3.0.0"
   },
   "keywords": [
     "putout",
@@ -54,12 +61,11 @@
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^12.0.0",
+    "eslint-plugin-putout": "^13.0.0",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",
     "mock-require": "^3.0.3",
-    "nodemon": "^2.0.1",
-    "simport": "^1.2.0"
+    "nodemon": "^2.0.1"
   },
   "license": "MIT",
   "engines": {