@putout/test 4.0.0 → 4.3.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,7 +21,22 @@ UPDATE=1 tape test/*.js
 
 ## Plugins API
 
-### report(filename, message | []messages)
+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
 
@@ -32,7 +47,7 @@ test('remove usless variables: for-of', (t) => {
 });
 ```
 
-### reportCode(input, message)
+### `reportCode(input, message)`
 
 checks error message of a plugin from `input` code
 
@@ -43,7 +58,7 @@ test('remove debugger: report', (t) => {
 });
 ```
 
-### transform(filename [, output, plugins])
+### `transform(filename [, output, plugins])`
 
 check transform of `filename.js` -> `filename-fix.js` in `test/fixtures` directory
 
@@ -56,7 +71,7 @@ test('remove usless variables: for-of', (t) => {
 });
 ```
 
-### transformCode(input, output)
+### `transformCode(input, output)`
 
 check transform of `input` -> `output` code
 
@@ -67,7 +82,7 @@ test('remove-console: property identifier: code', (t) => {
 });
 ```
 
-### reportWithOptions(filename, options)
+### `reportWithOptions(filename, options)`
 
 check report of `filename.js` with `options`
 
@@ -83,7 +98,7 @@ test('putout: test: reportWithOptions', (t) => {
 });
 ```
 
-### noReportWithOptions(filename, options)
+### `noReportWithOptions(filename, options)`
 
 check no report of `filename.js` with `options`
 
@@ -98,7 +113,7 @@ test('putout: test: noReportWithOptions', (t) => {
 });
 ```
 
-### transformWithOptions(filename, options)
+### `transformWithOptions(filename, options)`
 
 check transform of `filename.js` with `options`
 
@@ -111,7 +126,7 @@ test('putout: plugin: declare-undefined-variables: transform: parse', (t) => {
 });
 ```
 
-### noTransformWithOptions(filename, options)
+### `noTransformWithOptions(filename, options)`
 
 When file should not be transformed:
 
@@ -122,7 +137,7 @@ test('test: declared', (t) => {
 });
 ```
 
-### noTransformWithOptions(filename, options)
+### `noTransformWithOptions(filename, options)`
 
 check transform of `filename.js` with `options`
 
@@ -135,7 +150,7 @@ test('putout: plugin: declare-undefined-variables: transform: assign: dismiss',
 });
 ```
 
-### noReport(filename)
+### `noReport(filename)`
 
 checks error message of a plugin not produces
 
@@ -146,9 +161,9 @@ test('plugin-putout: check-replace-code: no report: typescript', (t) => {
 });
 ```
 
-### noReportAfterTransform(filename)
+### `noReportAfterTransform(filename)`
 
-checks error message of a plugin not produces
+checks error message of a plugin not produced
 
 ```js
 test('test: no report after transform', (t) => {
@@ -157,9 +172,9 @@ test('test: no report after transform', (t) => {
 });
 ```
 
-### noTransform(filename)
+### `noTransform(filename)`
 
-check transform of `filename.js` produce nothing new
+check transform of `filename.js` produce nothing
 
 ```js
 test('plugin-apply-numeric-separators: no transform: hex', (t) => {
@@ -168,7 +183,20 @@ test('plugin-apply-numeric-separators: no transform: hex', (t) => {
 });
 ```
 
-### format(formatter, filename)
+## 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)
 
@@ -178,7 +206,7 @@ test('formatter: codeframe', async ({format}) => {
 });
 ```
 
-### noFormat
+### `noFormat`
 
 check that there is no formatting for for such file
 
@@ -188,7 +216,7 @@ test('formatter: codeframe: no', async ({noFormat}) => {
 });
 ```
 
-### formatMany(formatter, [filename1, filename2])
+### `formatMany(formatter, [filename1, filename2])`
 
 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,64 @@ 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])`
+
+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.
@@ -245,7 +334,7 @@ const test = createTest(__dirname, {
 
 ```
 
-### process(filename [, plugins, ])
+### `process(filename [, plugins, ])`
 
 Example:
 
@@ -259,7 +348,7 @@ test('putout: processor: json', async ({process}) => {
 });
 ```
 
-### noProcess(filename [, plugins, processors])
+### `noProcess(filename [, plugins, processors])`
 
 Check that filename would not be processed.
 
@@ -271,7 +360,7 @@ test('putout: process: json: no process', async ({noProcess}) => {
 });
 ```
 
-### comparePlaces(filename, places)
+### `comparePlaces(filename, places)`
 
 ```js
 test('putout: processor: css: places', async ({comparePlaces}) => {

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,7 +18,14 @@ const isString = (a) => typeof a === 'string';
 const {isArray} = Array;
 const {keys, entries} = Object;
 
-const {UPDATE} = process.env;
+global.__putout_test_fs = {
+    readFileSync,
+    writeFileSync,
+    existsSync,
+};
+
+const isUpdate = () => Boolean(Number(process.env.UPDATE));
+
 const TS = {
     ENABLED: true,
     DISABLED: false,
@@ -33,7 +40,12 @@ 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');
     const plugins = getPlugins(plugin);
     
@@ -59,12 +71,12 @@ module.exports = (dir, plugin, rules) => {
         }),
         
         formatSave: formatSave({dir, plugins, rules}),
-        format: (UPDATE ? formatSave : format)({dir, plugins, rules}),
+        format: (update ? formatSave : format)({dir, plugins, rules}),
         formatManySave: formatManySave({dir, plugins, rules}),
-        formatMany: (UPDATE ? formatManySave : formatMany)({dir, plugins, 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);
@@ -143,6 +155,11 @@ const formatMany = currify(({dir, plugins, rules}, t) => async (formatter, names
 });
 
 const formatManySave = currify(({dir, plugins, rules}, t) => async (formatter, names, options = {}) => {
+    const {
+        existsSync,
+        writeFileSync,
+    } = global.__putout_test_fs;
+    
     const name = `${names.join('-')}-format.js`;
     const outputName = join(dir, name);
     
@@ -163,6 +180,11 @@ const formatManySave = currify(({dir, plugins, rules}, t) => async (formatter, n
 });
 
 const formatSave = currify(({dir, plugins, rules}, t) => async (formatter, name, options = {}) => {
+    const {
+        existsSync,
+        writeFileSync,
+    } = global.__putout_test_fs;
+    
     const full = join(dir, name);
     const outputName = `${full}-format.js`;
     
@@ -190,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);
@@ -210,13 +234,15 @@ const transform = currify(({dir, plugins, rules}, t, name, transformed = null, a
         }],
     });
     
-    if (UPDATE)
+    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);
     
@@ -230,7 +256,7 @@ const transformWithOptions = currify(({dir, plugins}, t, name, options) => {
     
     const {code} = putout(input, {isTS, plugins, rules});
     
-    if (UPDATE)
+    if (isUpdate())
         writeFileSync(`${full}-fix.js`, code);
     
     return t.equal(code, output);

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.0",
+  "version": "4.3.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,7 +61,7 @@
     "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",