@putout/test 4.0.1 → 4.1.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 wich 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)

package/lib/test.js

@@ -42,7 +42,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 +78,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);

package/lib/test.mjs

@@ -0,0 +1,9 @@
+import {createCommons} from 'simport';
+import create from './test.js';
+
+export default create;
+
+export const createTest = (url, plugins) => {
+    const {__dirname} = createCommons(url);
+    return create(__dirname, plugins);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/test",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "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 +9,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,
@@ -33,6 +37,7 @@
     "@putout/engine-processor": "*",
     "currify": "^4.0.0",
     "putout": "*",
+    "simport": "^1.2.0",
     "supertape": "^6.0.0",
     "try-catch": "^3.0.0"
   },
@@ -58,8 +63,7 @@
     "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": {