@putout/test 3.7.5 → 4.2.0

package/README.md

@@ -1,11 +1,9 @@
-# @putout/test [![NPM version][NPMIMGURL]][NPMURL] [![Dependency Status][DependencyStatusIMGURL]][DependencyStatusURL]
+# @putout/test [![NPM version][NPMIMGURL]][NPMURL]
 
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/test.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/test "npm"
-[DependencyStatusURL]: https://david-dm.org/coderaiser/putout?path=packages/test-runner
-[DependencyStatusIMGURL]: https://david-dm.org/coderaiser/putout.svg?path=packages/test-runner
 
-Test runner for [`putout plugins`](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
 
@@ -23,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
 
@@ -34,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
 
@@ -45,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
 
@@ -58,7 +71,7 @@ test('remove usless variables: for-of', (t) => {
 });
 ```
 
-### transformCode(input, output)
+### `transformCode(input, output)`
 
 check transform of `input` -> `output` code
 
@@ -69,7 +82,7 @@ test('remove-console: property identifier: code', (t) => {
 });
 ```
 
-### reportWithOptions(filename, options)
+### `reportWithOptions(filename, options)`
 
 check report of `filename.js` with `options`
 
@@ -85,7 +98,7 @@ test('putout: test: reportWithOptions', (t) => {
 });
 ```
 
-### noReportWithOptions(filename, options)
+### `noReportWithOptions(filename, options)`
 
 check no report of `filename.js` with `options`
 
@@ -100,7 +113,7 @@ test('putout: test: noReportWithOptions', (t) => {
 });
 ```
 
-### transformWithOptions(filename, options)
+### `transformWithOptions(filename, options)`
 
 check transform of `filename.js` with `options`
 
@@ -109,12 +122,11 @@ test('putout: plugin: declare-undefined-variables: transform: parse', (t) => {
     t.transformWithOptions('parse', {
         dismiss: ['assign', 'stringify'],
     });
-    
     t.end();
 });
 ```
 
-### noTransformWithOptions(filename, options)
+### `noTransformWithOptions(filename, options)`
 
 When file should not be transformed:
 
@@ -125,7 +137,7 @@ test('test: declared', (t) => {
 });
 ```
 
-### noTransformWithOptions(filename, options)
+### `noTransformWithOptions(filename, options)`
 
 check transform of `filename.js` with `options`
 
@@ -138,7 +150,7 @@ test('putout: plugin: declare-undefined-variables: transform: assign: dismiss',
 });
 ```
 
-### noReport(filename)
+### `noReport(filename)`
 
 checks error message of a plugin not produces
 
@@ -149,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) => {
@@ -160,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) => {
@@ -171,29 +183,46 @@ 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)
 
-### noFormat
+```js
+test('formatter: codeframe', async ({format}) => {
+    await format(codeframe);
+});
+```
+
+### `noFormat`
 
 check that there is no formatting for for such file
 
 ```js
-test('formatter: codeframe: no', (t) => {
-    t.noFormat(codeframe, 'no');
-    t.end();
+test('formatter: codeframe: no', async ({noFormat}) => {
+    await noFormat(codeframe, 'no');
 });
 ```
 
-### formatMany(formatter, [filename1, filename2])
+### `formatMany(formatter, [filename1, filename2])`
 
 check file name formatting (pass `process.env.UPDATE=1` to save fixture)
 
 ```js
-test('formatter: dump: many', (t) => {
-    t.formatMany(dump, ['var', 'var']);
-    t.end();
+test('formatter: dump: many', async ({formatMany}) => {
+    await formatMany(dump, ['var', 'var']);
 });
 ```
 
@@ -202,8 +231,11 @@ test('formatter: dump: many', (t) => {
 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) => {
@@ -244,7 +276,7 @@ const test = createTest(__dirname, {
 
 ```
 
-### process(filename [, plugins, ])
+### `process(filename [, plugins, ])`
 
 Example:
 
@@ -258,19 +290,19 @@ test('putout: processor: json', async ({process}) => {
 });
 ```
 
-### noProcess(filename [, plugins, processors])
+### `noProcess(filename [, plugins, processors])`
 
 Check that filename would not be processed.
 
 Example:
 
 ```js
-test('putout: process: json: no process', async (t) => {
-    await t.noProcess('eslintrc', [], ['json']);
+test('putout: process: json: no process', async ({noProcess}) => {
+    await noProcess('eslintrc', [], ['json']);
 });
 ```
 
-### comparePlaces(filename, places)
+### `comparePlaces(filename, places)`
 
 ```js
 test('putout: processor: css: places', async ({comparePlaces}) => {

package/lib/test.js

@@ -19,6 +19,15 @@ 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 TS = {
     ENABLED: true,
     DISABLED: false,
@@ -33,7 +42,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,14 +73,14 @@ 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, formatter, name, formatterOptions = {}) => {
+const format = currify(({dir, plugins, rules}, t) => async (formatter, name, formatterOptions = {}) => {
     const full = join(dir, name);
     const outputName = `${full}-format`;
     const [input, isTS] = readFixture(full);
@@ -75,7 +89,7 @@ const format = currify(({dir, plugins, rules}, t, formatter, name, formatterOpti
     const {places} = putout(input, {fixCount: 1, isTS, plugins, rules});
     
     const report = putout.initReport();
-    const result = report(formatter, {
+    const result = await report(formatter, {
         formatterOptions,
         name,
         source: input,
@@ -87,14 +101,14 @@ const format = currify(({dir, plugins, rules}, t, formatter, name, formatterOpti
     return {is, output, result};
 });
 
-const noFormat = currify(({dir, plugins, rules}, t, formatter, name, formatterOptions = {}) => {
+const noFormat = currify(({dir, plugins, rules}, t) => async (formatter, name, formatterOptions = {}) => {
     const full = join(dir, name);
     const [input] = readFixture(full);
     
     const {places} = putout(input, {plugins, rules});
     
     const report = putout.initReport();
-    const result = report(formatter, {
+    const result = await report(formatter, {
         name,
         places,
         formatterOptions,
@@ -105,7 +119,7 @@ const noFormat = currify(({dir, plugins, rules}, t, formatter, name, formatterOp
     return {is, output, result};
 });
 
-const formatMany = currify(({dir, plugins, rules}, t, formatter, names, formatterOptions = {}) => {
+const formatMany = currify(({dir, plugins, rules}, t) => async (formatter, names, formatterOptions = {}) => {
     const joinTwo = (a) => (b) => join(a, b);
     const fullNames = names.map(joinTwo(dir));
     
@@ -124,7 +138,7 @@ const formatMany = currify(({dir, plugins, rules}, t, formatter, names, formatte
             rules,
         });
         
-        result += report(formatter, {
+        result += await report(formatter, {
             name,
             formatterOptions,
             source: input,
@@ -142,44 +156,54 @@ const formatMany = currify(({dir, plugins, rules}, t, formatter, names, formatte
     return {is, output, result};
 });
 
-const formatManySave = currify(({dir, plugins, rules}, t, formatter, names, options = {}) => {
+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);
     
     if (!existsSync(outputName))
         writeFileSync(outputName, '');
     
+    const runFormat = await formatMany({dir, plugins, rules}, t);
+    
     const {
         is,
         output,
         result,
-    } = formatMany({dir, plugins, rules}, t, formatter, names, options);
+    } = await runFormat(formatter, names, options);
     
     writeFileSync(outputName, result);
     
     return {is, output, result};
 });
 
-const formatSave = currify(({dir, plugins, rules}, t, formatter, name, options = {}) => {
+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`;
     
     if (!existsSync(outputName))
         writeFileSync(outputName, '');
     
+    const runFormat = format({
+        dir,
+        plugins,
+        rules,
+    }, t);
+    
     const {
         is,
         output,
         result,
-    } = format(
-        {dir,
-            plugins,
-            rules},
-        t,
-        formatter,
-        name,
-        options,
-    );
+    } = await runFormat(formatter, name, options);
     
     writeFileSync(outputName, result);
     
@@ -210,7 +234,7 @@ const transform = currify(({dir, plugins, rules}, t, name, transformed = null, a
         }],
     });
     
-    if (UPDATE)
+    if (isUpdate())
         writeFileSync(`${full}-fix.js`, code);
     
     return t.equal(code, output);
@@ -230,7 +254,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": "3.7.5",
+  "version": "4.2.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,12 @@
     "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"
   },
   "release": false,
   "tag": false,
@@ -44,18 +49,17 @@
     "runner"
   ],
   "devDependencies": {
-    "@cloudcmd/stub": "^3.0.0",
-    "@putout/formatter-dump": "^2.0.1",
-    "@putout/formatter-progress": "^2.0.0",
-    "@putout/plugin-extract-object-properties": "^6.0.1",
-    "@putout/plugin-putout": "^7.2.0",
-    "@putout/plugin-remove-console": "^3.1.0",
-    "@putout/plugin-remove-empty": "^6.0.0",
+    "@putout/formatter-dump": "*",
+    "@putout/formatter-progress": "*",
+    "@putout/plugin-extract-object-properties": "*",
+    "@putout/plugin-putout": "*",
+    "@putout/plugin-remove-console": "*",
+    "@putout/plugin-remove-empty": "*",
     "@putout/plugin-remove-unused-variables": "*",
     "c8": "^7.5.0",
-    "eslint": "^8.0.0-beta.0",
+    "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^10.0.0",
+    "eslint-plugin-putout": "^13.0.0",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",
     "mock-require": "^3.0.3",