feature: @putout/engine-runner: get rid of mock-require

Author: coderaiser

packages/engine-runner/lib/debug.js

@@ -0,0 +1,20 @@
+'use strict';
+
+const debug = require('debug');
+
+module.exports.createDebug = (namespace) => {
+    const log = debug(namespace);
+    
+    return new Proxy(log, {
+        apply(target, thisArg, args) {
+            global.__putout_debug(namespace, ...args);
+            return target(...args);
+        },
+        get(target, prop) {
+            if (global.__putout_debug?.[prop])
+                return true;
+            
+            return target[prop];
+        },
+    });
+};

packages/engine-runner/lib/replacer/index.js

@@ -11,10 +11,15 @@ const {
     setValues,
 } = require('@putout/compare');
 
-const debug = require('debug')('putout:runner:replace');
 const maybeArray = require('../maybe-array');
-
 const watermark = require('./watermark');
+const {createDebug} = require('../debug');
+const debug = createDebug('putout:runner:replace');
+
+const log = (from, path) => {
+    debug.enabled && debug(`${from} -> ${path}\n`);
+};
+
 const {
     isExpression,
     isStatement,
@@ -34,10 +39,6 @@ const PRINT_OPTIONS = {
 
 const isString = (a) => typeof a === 'string';
 
-const log = (from, path) => {
-    debug.enabled && debug(`${from} -> ${path}\n`);
-};
-
 const {keys, entries} = Object;
 const {stringify} = JSON;
 

packages/engine-runner/lib/run-fix.js

@@ -1,12 +1,13 @@
 'use strict';
 
 const tryCatch = require('try-catch');
-const debug = require('debug')('putout:runner:fix');
-const {enabled} = debug;
+const {createDebug} = require('./debug');
+
 const {stringify} = JSON;
 
 const isFn = (a) => typeof a === 'function';
 const getPath = (path) => path.path || path;
+const debug = createDebug('putout:runner:fix');
 
 const chooseFixArgs = ({path, pathOptions, options}) => {
     if (pathOptions)
@@ -51,7 +52,7 @@ module.exports = (is, fix, {path, pathOptions, rule, position, options}) => {
     if (!is)
         return;
 
-    if (enabled)
+    if (debug.enabled)
         debug(`fix: ${rule}`, position, getPath(path).toString());
 
     validate('fix', fix);

packages/engine-runner/lib/run-fix.spec.js

@@ -1,15 +1,10 @@
 'use strict';
 
-const mockRequire = require('mock-require');
-
 const {test, stub} = require('supertape');
-
 const tryCatch = require('try-catch');
 const fix = require('./run-fix');
 
-const {stopAll, reRequire} = mockRequire;
-
-test('fix: error', (t) => {
+test('engine-runner: fix: error', (t) => {
     const remove = () => {
         throw Error('hello');
     };
@@ -40,9 +35,8 @@ test('fix: error: nested path: debug', (t) => {
     const debugFn = stub();
 
     debugFn.enabled = true;
-    const debug = stub().returns(debugFn);
 
-    mockRequire('debug', debug);
+    global.__putout_debug = stub().returns(debugFn);
 
     const remove = () => {
         throw Error('hello');
@@ -60,26 +54,25 @@ test('fix: error: nested path: debug', (t) => {
     };
 
     const is = true;
-    const fix = reRequire('./run-fix');
 
     const [e] = tryCatch(fix, is, fn, {
         path,
         position,
     });
 
-    stopAll();
+    delete global.__putout_debug;
 
     t.equal(e.loc, position);
     t.end();
 });
 
 test('fix: error: nested path: debug: nested path', (t) => {
+    const {__putout_debug} = global;
     const debugFn = stub();
 
     debugFn.enabled = true;
-    const debug = stub().returns(debugFn);
 
-    mockRequire('debug', debug);
+    global.__putout_debug = stub().returns(debugFn);
 
     const remove = () => {
         throw Error('hello');
@@ -99,14 +92,13 @@ test('fix: error: nested path: debug: nested path', (t) => {
     };
 
     const is = true;
-    const fix = reRequire('./run-fix');
 
     const [e] = tryCatch(fix, is, fn, {
         path,
         position,
     });
 
-    stopAll();
+    global.__putout_debug = __putout_debug;
 
     t.equal(e.loc, position);
     t.end();

packages/engine-runner/lib/template/index.js

@@ -10,7 +10,8 @@ const {
 } = require('@putout/compare');
 
 const maybeArray = require('../maybe-array');
-const debug = require('debug')('putout:runner:template');
+const {createDebug} = require('../debug');
+const debug = createDebug('putout:runner:template');
 
 const {entries} = Object;
 const isFn = (a) => typeof a === 'function';

packages/engine-runner/lib/template/index.spec.js

@@ -3,11 +3,8 @@
 const {test, stub} = require('supertape');
 
 const putout = require('putout');
-const mockRequire = require('mock-require');
-
 const {runPlugins} = require('..');
-
-const {reRequire, stopAll} = mockRequire;
+const {_log} = require('.');
 
 test('putout: plugin: traverse: template', (t) => {
     const exp = {
@@ -440,28 +437,27 @@ test('putout: plugin: traverse: template: log', (t) => {
 
 test('putout: engine: runner: template: log', (t) => {
     const debug = stub();
+    const {__putout_debug} = global;
 
-    mockRequire('debug', stub().returns(debug));
-    const {_log} = reRequire('.');
+    global.__putout_debug = stub().returns(debug);
 
     _log();
-    stopAll();
+    global.__putout_debug = __putout_debug;
 
     t.notCalled(debug, 'should call debug');
     t.end();
 });
 
 test('putout: engine: runner: template: log: enabled', (t) => {
+    const {__putout_debug} = global;
     const debug = stub();
 
     debug.enabled = true;
-    
-    mockRequire('debug', stub().returns(debug));
-    const {_log} = reRequire('.');
+    global.__putout_debug = debug;
 
     _log('rule', 'path');
-    stopAll();
+    global.__putout_debug = __putout_debug;
 
-    t.calledWith(debug, ['rule', 'path'], 'should call debug');
+    t.calledWith(debug, ['putout:runner:template', 'rule', 'path'], 'should call debug');
     t.end();
 });

packages/engine-runner/package.json

@@ -58,7 +58,6 @@
     "eslint-plugin-putout": "^26.0.0",
     "just-camel-case": "^6.2.0",
     "madrun": "^11.0.0",
-    "mock-require": "^3.0.3",
     "montag": "^1.0.0",
     "nodemon": "^3.0.1",
     "putout": "*",

packages/engine-runner/test/runner.js

@@ -5,13 +5,11 @@ const montag = require('montag');
 const tryCatch = require('try-catch');
 const {test, stub} = require('supertape');
 const putout = require('putout');
-const mockRequire = require('mock-require');
 const {loadPlugins} = require('@putout/engine-loader');
 
 const {readFixtures} = require('./fixture');
 const {runPlugins} = require('..');
 const noop = () => {};
-const {reRequire, stopAll} = mockRequire;
 const {parse} = putout;
 
 const fixture = readFixtures([
@@ -693,13 +691,8 @@ test('putout: runner: debug', (t) => {
     const debugFn = stub();
 
     debugFn.enabled = true;
-    const debug = stub().returns(debugFn);
 
-    mockRequire('debug', debug);
-    reRequire('../lib/run-fix');
-    
-    const {runPlugins} = reRequire('..');
-    const putout = reRequire('putout');
+    global.__putout_debug = stub().returns(debugFn);
 
     const {code} = putout(fixture.debug, {
         fix: true,
@@ -711,7 +704,7 @@ test('putout: runner: debug', (t) => {
 
     process.env.DEBUG = DEBUG;
 
-    stopAll();
+    delete process.env.__putout_debug;
 
     t.equal(code, expected);
     t.end();
@@ -720,30 +713,25 @@ test('putout: runner: debug', (t) => {
 test('putout: runner: debug: replace', (t) => {
     const {DEBUG} = process.env;
 
-    process.env.DEBUG = 'putout:runner:fix';
-    
     const debugFn = stub();
 
     debugFn.enabled = true;
-    const debug = stub().returns(debugFn);
-    
-    mockRequire('debug', debug);
-    reRequire('../lib/replacer/index.js');
+    global.__putout_debug = debugFn;
 
-    const {runPlugins} = reRequire('..');
-    const putout = reRequire('putout');
+    process.env.DEBUG = 'putout:runner:fix';
 
     putout('debugger', {
         fix: true,
-        runPlugins,
         plugins: ['remove-debugger'],
     });
 
-    const expected = [`debugger -> ''\n`];
+    const expected = [
+        'putout:runner:replace',
+        `debugger -> ''\n`,
+    ];
 
     process.env.DEBUG = DEBUG;
-    
-    stopAll();
+    delete global.__putout_debug;
 
     t.calledWith(debugFn, expected);
     t.end();