@putout/test 5.0.0 → 5.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 additional asseritions:
 
 ## Install
 
@@ -15,21 +15,24 @@ npm i @putout/test -D
 
 Set environment variable `UPDATE=1` to update `transform` and `format` fixtures.
 
+☝️ *Remember that `-fix.js` fixtures will be removed when used in `noReport`, `noTransform` and `noTransformWithOptions`*
+
 ```sh
 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).
+All 🐊**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');
+import rmVars from '@putout/plugin-remove-unused-variables';
 
 const test = createTest(import.meta.url, {
     'remove-unused-variables': rmVars,
@@ -38,7 +41,7 @@ const test = createTest(import.meta.url, {
 
 ### `report(filename, message | []messages)`
 
-checks error message (or messages) of a plugin
+Check error message (or messages) of a plugin:
 
 ```js
 test('remove usless variables: for-of', (t) => {
@@ -47,9 +50,18 @@ test('remove usless variables: for-of', (t) => {
 });
 ```
 
+When you want to check that report called exact count of times pass an array of messages:
+
+```js
+test('remove usless variables: for-of', (t) => {
+    t.report('dot', ['Dot files should be added to .gitignore']);
+    t.end();
+});
+```
+
 ### `reportCode(input, message)`
 
-checks error message of a plugin from `input` code
+Check error message of a plugin from `input` code:
 
 ```js
 test('remove debugger: report', (t) => {
@@ -60,7 +72,7 @@ test('remove debugger: report', (t) => {
 
 ### `transform(filename [, output, plugins])`
 
-check transform of `filename.js` -> `filename-fix.js` in `test/fixtures` directory
+Check transform of `filename.js` -> `filename-fix.js` in `test/fixtures` directory:
 
 ```js
 test('remove usless variables: for-of', (t) => {
@@ -73,7 +85,7 @@ test('remove usless variables: for-of', (t) => {
 
 ### `transformCode(input, output)`
 
-check transform of `input` -> `output` code
+Check transform of `input` -> `output` code:
 
 ```js
 test('remove-console: property identifier: code', (t) => {
@@ -84,7 +96,7 @@ test('remove-console: property identifier: code', (t) => {
 
 ### `reportWithOptions(filename, options)`
 
-check report of `filename.js` with `options`
+Check report of `filename.js` with `options`:
 
 ```js
 test('putout: test: reportWithOptions', (t) => {
@@ -100,7 +112,7 @@ test('putout: test: reportWithOptions', (t) => {
 
 ### `noReportWithOptions(filename, options)`
 
-check no report of `filename.js` with `options`
+Check no report of `filename.js` with `options`:
 
 ```js
 test('putout: test: noReportWithOptions', (t) => {
@@ -115,7 +127,7 @@ test('putout: test: noReportWithOptions', (t) => {
 
 ### `transformWithOptions(filename, options)`
 
-check transform of `filename.js` with `options`
+Check transform of `filename.js` with `options`:
 
 ```js
 test('putout: plugin: declare-undefined-variables: transform: parse', (t) => {
@@ -139,7 +151,7 @@ test('test: declared', (t) => {
 
 ### `noTransformWithOptions(filename, options)`
 
-check transform of `filename.js` with `options`
+Check transform of `filename.js` with `options`:
 
 ```js
 test('putout: plugin: declare-undefined-variables: transform: assign: dismiss', (t) => {
@@ -152,7 +164,7 @@ test('putout: plugin: declare-undefined-variables: transform: assign: dismiss',
 
 ### `noReport(filename)`
 
-checks error message of a plugin not produces
+Check error message of a plugin not produces
 
 ```js
 test('plugin-putout: check-replace-code: no report: typescript', (t) => {
@@ -163,7 +175,7 @@ test('plugin-putout: check-replace-code: no report: typescript', (t) => {
 
 ### `noReportAfterTransform(filename)`
 
-checks error message of a plugin not produced
+Check error message of a plugin not produced
 
 ```js
 test('test: no report after transform', (t) => {
@@ -174,7 +186,7 @@ test('test: no report after transform', (t) => {
 
 ### `noTransform(filename)`
 
-check transform of `filename.js` produce nothing
+Check transform of `filename.js` produce nothing
 
 ```js
 test('plugin-apply-numeric-separators: no transform: hex', (t) => {
@@ -198,7 +210,7 @@ const test = createTest(import.meta.url, {
 
 ### `format(formatter, filename)`
 
-check file name formatting (pass `process.env.UPDATE=1` to save fixture)
+Check file name formatting (pass `process.env.UPDATE=1` to save `fixture`):
 
 ```js
 test('formatter: codeframe', async ({format}) => {
@@ -208,7 +220,7 @@ test('formatter: codeframe', async ({format}) => {
 
 ### `noFormat`
 
-check that there is no formatting for for such file
+Check that there is no formatting for for such file:
 
 ```js
 test('formatter: codeframe: no', async ({noFormat}) => {
@@ -218,7 +230,7 @@ test('formatter: codeframe: no', async ({noFormat}) => {
 
 ### `formatMany(formatter, [filename1, filename2])`
 
-check file name formatting (pass `process.env.UPDATE=1` to save fixture)
+Check file name formatting (pass `process.env.UPDATE=1` to save `fixture`):
 
 ```js
 test('formatter: dump: many', async ({formatMany}) => {
@@ -270,7 +282,7 @@ 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`;
+- ✅ check that transformed is equal to `operator-linebreak-fix.js`;
 
 Example:
 
@@ -304,21 +316,42 @@ test('test: eslint: noProcess', async ({noProcess}) => {
 });
 ```
 
-### `comparePlaces(filename, places)`
+### `comparePlaces(filename, places[, overrides])`
 
 ```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,
+        message: 'There should be no line break before or after \'=\'.',
+        position: {
+            column: 1,
+            line: 2,
         },
-        "rule": "operator-linebreak (eslint)",
+        rule: 'operator-linebreak (eslint)',
     }]);
 });
 ```
 
+with `overrides`:
+
+```js
+test('eslint-config: operator-line-break', async ({comparePlaces}) => {
+    const overrides = {
+        extends: [
+            'plugin:putout/safe',
+        ],
+    };
+    
+    await comparePlaces('operator-linebreak', [{
+        message: 'There should be no line break before or after \'=\'.',
+        position: {
+            column: 1,
+            line: 2,
+        },
+        rule: 'operator-linebreak (eslint)',
+    }], overrides);
+});
+```
+
 ## Processors API
 
 With `processors api` you can test `processors` in a simplest possible way.
@@ -326,9 +359,9 @@ With `processors api` you can test `processors` in a simplest possible way.
 First things first, init `test` with:
 
 ```js
-const {createTest} = require('@putout/test/processor');
+import {createTest} from '@putout/test/processor';
 
-const test = createTest(__dirname, {
+const test = createTest(import.meta.url, {
     extension: 'json',
     processors: [
         'json',

package/lib/eslint/eslint.mjs

@@ -59,14 +59,17 @@ export const createTest = (url) => {
             
             return operator.equal(source, code);
         },
-        comparePlaces: (operator) => async (name, expected) => {
+        comparePlaces: (operator) => async (name, expected, override) => {
             const full = join(fixtureDir, name);
             const [resolvedName, code] = await read(full);
             
             const [, places] = await eslint({
-                config,
                 name: resolvedName,
                 code,
+                config: {
+                    ...config,
+                    ...override,
+                },
             });
             
             return operator.deepEqual(places, expected);

package/lib/processor/index.mjs

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

package/lib/test.js

@@ -5,6 +5,7 @@ const {
     readFileSync,
     writeFileSync,
     existsSync,
+    unlinkSync,
 } = require('fs');
 
 const tryCatch = require('try-catch');
@@ -22,6 +23,7 @@ global.__putout_test_fs = {
     readFileSync,
     writeFileSync,
     existsSync,
+    unlinkSync,
 };
 
 const isUpdate = () => Boolean(Number(process.env.UPDATE));
@@ -40,6 +42,16 @@ const readFixture = (name) => {
     return [readFileSync(`${name}.js`, 'utf8'), TS.DISABLED];
 };
 
+const rmFixture = (name) => {
+    const {unlinkSync} = global.__putout_test_fs;
+    
+    if (!isUpdate())
+        return;
+    
+    tryCatch(unlinkSync, `${name}.js`);
+    tryCatch(unlinkSync, `${name}.ts`);
+};
+
 module.exports = createTest;
 module.exports.createTest = createTest;
 
@@ -125,6 +137,7 @@ const formatMany = currify(({dir, plugins, rules}, t) => async (formatter, names
     
     const count = names.length;
     const report = putout.initReport();
+    
     for (let index = 0; index < count; index++) {
         const name = names[index];
         const full = fullNames[index];
@@ -266,6 +279,8 @@ const noTransformWithOptions = currify(({dir, plugins}, t, name, options) => {
     const full = join(dir, name);
     const [input, isTS] = readFixture(full);
     
+    rmFixture(`${full}-fix`);
+    
     const [plugin] = plugins;
     const [rule] = keys(plugin);
     
@@ -282,6 +297,8 @@ const noTransform = currify(({dir, plugins, rules}, t, name, addons = {}) => {
     const full = join(dir, name);
     const [fixture] = readFixture(full);
     
+    rmFixture(`${full}-fix`);
+    
     return transform({dir, plugins, rules}, t, name, fixture, addons);
 });
 
@@ -308,6 +325,8 @@ const noReport = currify(({dir, plugins, rules}, t, name) => {
     const full = join(dir, name);
     const [source, isTS] = readFixture(full);
     
+    rmFixture(`${full}-fix`);
+    
     return noReportCode({plugins, rules, isTS}, t, source);
 });
 module.exports._createNoReport = noReport;
@@ -338,6 +357,8 @@ const noReportWithOptions = currify(({dir, plugins}, t, name, options) => {
     const full = join(dir, name);
     const [source, isTS] = readFixture(full);
     
+    rmFixture(`${full}-fix`);
+    
     const [plugin] = plugins;
     const [rule] = keys(plugin);
     
@@ -360,7 +381,7 @@ const reportCode = currify(({plugins, rules, isTS}, t, source, message) => {
     const resultMessages = places.map(getMessage);
     
     if (isArray(message))
-        return t.deepEqual(resultMessages, message, 'should equal');
+        return t.deepEqual(resultMessages, message);
     
     return t.equal(resultMessages[0], message);
 });
@@ -420,6 +441,7 @@ function preTest(test, plugin) {
         }, options);
         
         const entries = Object.entries(rules);
+        
         for (const [entryName, plugin] of entries) {
             preTest(test, {
                 [`${name}/${entryName}`]: plugin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@putout/test",
-  "version": "5.0.0",
+  "version": "5.3.0",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "test runner for putout plugins ",
@@ -14,7 +14,10 @@
       "require": "./lib/test.js",
       "import": "./lib/test.mjs"
     },
-    "./processor": "./lib/processor/index.js",
+    "./processor": {
+      "require": "./lib/processor/index.js",
+      "import": "./lib/processor/index.mjs"
+    },
     "./formatter": "./lib/formatter/index.mjs",
     "./eslint": "./lib/eslint/eslint.mjs"
   },
@@ -61,8 +64,8 @@
     "c8": "^7.5.0",
     "eslint": "^8.0.1",
     "eslint-plugin-node": "^11.0.0",
-    "eslint-plugin-putout": "^13.0.0",
-    "lerna": "^4.0.0",
+    "eslint-plugin-putout": "^15.0.0",
+    "lerna": "^5.0.0",
     "madrun": "^9.0.0",
     "mock-require": "^3.0.3",
     "nodemon": "^2.0.1"