@putout/test 3.7.2 → 4.0.0

package/README.md

@@ -1,12 +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"
+[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`. Basically it is [supercharged](https://github.com/coderaiser/supertape) `tape` 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
 
@@ -14,19 +11,40 @@ Test runner for `putout plugins`. Basically it is [supercharged](https://github.
 npm i @putout/test -D
 ```
 
+## Autofix
+
+Set environment variable `UPDATE=1` to update `transform` and `format` fixtures.
+
+```sh
+UPDATE=1 tape test/*.js
+```
+
 ## Plugins API
 
-### Environment Variable
+### report(filename, message | []messages)
 
-Set environment variable `UPDATE=1` to update `transform` and `format` fixtures.
+checks error message (or messages) of a plugin
 
-### report(filename, message)
-checks error message of a plugin
+```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
 
+```js
+test('remove debugger: report', (t) => {
+    t.reportCode('debugger', 'Unexpected "debugger" statement');
+    t.end();
+});
+```
+
 ### transform(filename [, output, plugins])
+
 check transform of `filename.js` -> `filename-fix.js` in `test/fixtures` directory
 
 ```js
@@ -39,24 +57,97 @@ test('remove usless variables: for-of', (t) => {
 ```
 
 ### transformCode(input, output)
+
 check transform of `input` -> `output` code
 
+```js
+test('remove-console: property identifier: code', (t) => {
+    t.transformCode('console.log()', '');
+    t.end();
+});
+```
+
 ### reportWithOptions(filename, options)
+
 check report of `filename.js` with `options`
 
+```js
+test('putout: test: reportWithOptions', (t) => {
+    const cache = new Map();
+    cache.set('x', 'y');
+    
+    t.reportWithOptions('remove-import', 'avoid imports', {
+        cache,
+    });
+    t.end();
+});
+```
+
 ### noReportWithOptions(filename, options)
+
 check no report of `filename.js` with `options`
 
+```js
+test('putout: test: noReportWithOptions', (t) => {
+    const cache = new Map();
+    
+    t.noReportWithOptions('remove-import', {
+        cache,
+    });
+    t.end();
+});
+```
+
 ### transformWithOptions(filename, options)
+
 check transform of `filename.js` with `options`
 
+```js
+test('putout: plugin: declare-undefined-variables: transform: parse', (t) => {
+    t.transformWithOptions('parse', {
+        dismiss: ['assign', 'stringify'],
+    });
+    t.end();
+});
+```
+
 ### noTransformWithOptions(filename, options)
+
+When file should not be transformed:
+
+```js
+test('test: declared', (t) => {
+    t.noTransform('declared');
+    t.end();
+});
+```
+
+### noTransformWithOptions(filename, options)
+
 check transform of `filename.js` with `options`
 
+```js
+test('putout: plugin: declare-undefined-variables: transform: assign: dismiss', (t) => {
+    t.noTransformWithOptions('assign', {
+        dismiss: ['assign', 'stringify'],
+    });
+    t.end();
+});
+```
+
 ### noReport(filename)
+
 checks error message of a plugin not produces
 
+```js
+test('plugin-putout: check-replace-code: no report: typescript', (t) => {
+    t.noReport('typescript');
+    t.end();
+});
+```
+
 ### noReportAfterTransform(filename)
+
 checks error message of a plugin not produces
 
 ```js
@@ -66,18 +157,47 @@ test('test: no report after transform', (t) => {
 });
 ```
 
-### noReportCode(filename)
-checks error message of a plugin not produces with a `code`
-
 ### noTransform(filename)
-check transform of `filename.js` produce nothing
+
+check transform of `filename.js` produce nothing new
+
+```js
+test('plugin-apply-numeric-separators: no transform: hex', (t) => {
+    t.noTransform('hex');
+    t.end();
+});
+```
 
 ### format(formatter, filename)
+
 check file name formatting (pass `process.env.UPDATE=1` to save fixture)
 
+```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', async ({noFormat}) => {
+    await noFormat(codeframe, 'no');
+});
+```
+
 ### formatMany(formatter, [filename1, filename2])
+
 check file name formatting (pass `process.env.UPDATE=1` to save fixture)
 
+```js
+test('formatter: dump: many', async ({formatMany}) => {
+    await formatMany(dump, ['var', 'var']);
+});
+```
+
 #### Usage Example
 
 Here is example of tests for [remove-console](https://github.com/coderaiser/putout/tree/master/packages/plugin-remove-console):
@@ -92,27 +212,11 @@ test('remove-console: report', (t) => {
     t.end();
 });
 
-test('remove-console: property identifier: code', (t) => {
-    t.transformCode('console.log()', '');
-    t.end();
-});
-
 test('remove-console: property identifier', (t) => {
     t.transform('property-identifier');
     t.end();
 });
 
-test('remove-console: property literal', (t) => {
-    t.transform('property-literal', '\n\n');
-    t.end();
-});
-
-// when file should not be transformed
-test('test: declared', (t) => {
-    t.noTransform('declared');
-    t.end();
-});
-
 // when code should not be transformed
 test('test: declared', (t) => {
     t.noTransformCode('alert()');
@@ -146,12 +250,12 @@ const test = createTest(__dirname, {
 Example:
 
 ```js
-test('putout: processor: json', async (t) => {
-    await t.process('eslintrc');
+test('putout: processor: json', async ({process}) => {
+    await process('eslintrc');
 });
 
-test('putout: processor: json', async (t) => {
-    await t.process('package', ['package-json']);
+test('putout: processor: json', async ({process}) => {
+    await process('package', ['package-json']);
 });
 ```
 
@@ -162,16 +266,16 @@ 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)
 
 ```js
-test('putout: processor: css: places', async (t) => {
-    await t.comparePlaces('style', [{
+test('putout: processor: css: places', async ({comparePlaces}) => {
+    await comparePlaces('style', [{
         message: 'Expected indentation of 4 spaces (indentation)',
         position: {
             column: 1,
@@ -185,4 +289,3 @@ test('putout: processor: css: places', async (t) => {
 ## License
 
 MIT
-

package/lib/processor/index.js

@@ -12,13 +12,11 @@ const processFile = require('putout/process-file');
 const {runProcessors} = require('@putout/engine-processor');
 
 const isStr = (a) => typeof a === 'string';
-const buildOptions = ({options, plugins, processors}) => {
-    return {
-        ...options,
-        plugins: plugins || options.plugins,
-        processors: processors || options.processors,
-    };
-};
+const buildOptions = ({options, plugins, processors}) => ({
+    ...options,
+    plugins: plugins || options.plugins,
+    processors: processors || options.processors,
+});
 
 const addDot = (a) => a ? `.${a}` : '';
 module.exports._addDot = addDot;

package/lib/test.js

@@ -66,7 +66,7 @@ module.exports = (dir, plugin, 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 +75,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 +87,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 +105,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 +124,7 @@ const formatMany = currify(({dir, plugins, rules}, t, formatter, names, formatte
             rules,
         });
         
-        result += report(formatter, {
+        result += await report(formatter, {
             name,
             formatterOptions,
             source: input,
@@ -142,52 +142,44 @@ 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 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 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);
     
@@ -209,17 +201,19 @@ const transform = currify(({dir, plugins, rules}, t, name, transformed = null, a
     
     addons = addons || {};
     
-    plugins[0] = {
-        ...plugins[0],
-        ...addons,
-    };
-    
-    const {code} = putout(input, {isTS, plugins, rules});
+    const {code} = putout(input, {
+        isTS,
+        rules,
+        plugins: [{
+            ...plugins[0],
+            ...addons,
+        }],
+    });
     
     if (UPDATE)
         writeFileSync(`${full}-fix.js`, code);
     
-    return t.equal(code, output, 'should equal');
+    return t.equal(code, output);
 });
 
 const transformWithOptions = currify(({dir, plugins}, t, name, options) => {
@@ -239,7 +233,7 @@ const transformWithOptions = currify(({dir, plugins}, t, name, options) => {
     if (UPDATE)
         writeFileSync(`${full}-fix.js`, code);
     
-    return t.equal(code, output, 'should equal');
+    return t.equal(code, output);
 });
 
 const noTransformWithOptions = currify(({dir, plugins}, t, name, options) => {
@@ -255,7 +249,7 @@ const noTransformWithOptions = currify(({dir, plugins}, t, name, options) => {
     
     const {code} = putout(input, {isTS, plugins, rules});
     
-    return t.equal(code, input, 'should equal');
+    return t.equal(code, input);
 });
 
 const noTransform = currify(({dir, plugins, rules}, t, name, addons = {}) => {
@@ -267,12 +261,12 @@ const noTransform = currify(({dir, plugins, rules}, t, name, addons = {}) => {
 
 const transformCode = currify(({plugins, rules}, t, input, output, isTS = false) => {
     const {code} = putout(input, {isTS, plugins, rules});
-    return t.equal(code, output, 'should equal');
+    return t.equal(code, output);
 });
 
 const noTransformCode = currify(({plugins, rules}, t, input) => {
     const {code} = putout(input, {plugins, rules});
-    return t.equal(code, input, 'should equal');
+    return t.equal(code, input);
 });
 
 const getMessage = ({message}) => message;
@@ -342,7 +336,7 @@ const reportCode = currify(({plugins, rules, isTS}, t, source, message) => {
     if (isArray(message))
         return t.deepEqual(resultMessages, message, 'should equal');
     
-    return t.equal(resultMessages[0], message, 'should equal');
+    return t.equal(resultMessages[0], message);
 });
 
 const noReportCode = currify(({plugins, rules, isTS}, t, source) => {
@@ -393,7 +387,7 @@ function preTest(test, plugin) {
         test(`${name}: rules is an object`, (t) => {
             t.equal(typeof rules, 'object', 'should export "rules" object');
             t.end();
-        });
+        }, {checkDuplicates: false});
         
         const entries = Object.entries(rules);
         for (const [entryName, plugin] of entries) {

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@putout/test",
-  "version": "3.7.2",
+  "version": "4.0.0",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "test runner for putout plugins ",
-  "homepage": "http://github.com/coderaiser/putout",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/test#readme",
   "main": "lib/test.js",
   "bin": {
     "tape": "bin/test.mjs"
@@ -44,16 +44,17 @@
     "runner"
   ],
   "devDependencies": {
-    "@cloudcmd/stub": "^3.0.0",
-    "@putout/formatter-dump": "^2.0.1",
-    "@putout/formatter-progress": "^2.0.0",
-    "@putout/plugin-remove-console": "^3.1.0",
-    "@putout/plugin-remove-empty": "^5.1.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": "^9.0.0",
+    "eslint-plugin-putout": "^12.0.0",
     "lerna": "^4.0.0",
     "madrun": "^8.0.1",
     "mock-require": "^3.0.3",