feature: @putout/cli-keypress: migrate to ESM

Author: coderaiser

packages/cli-keypress/.madrun.mjs packages/cli-keypress/.madrun.jspackages/cli-keypress/.madrun.mjs renamed to packages/cli-keypress/.madrun.js

@@ -14,8 +14,8 @@ npm i @putout/cli-keypress
 ## Examples
 
 ```js
-const keyPress = require('keypress');
-const {isStop} = keyPress();
+import {keypress} from 'keypress';
+const {isStop} = keypress();
 
 // do some stuff until ctrl+c pressed
 async function again() {

packages/cli-keypress/README.md

@@ -1,9 +1,7 @@
-'use strict';
-
-const process = require('node:process');
-const readline = require('node:readline');
-const fullstore = require('fullstore');
-const {isCI} = require('ci-info');
+import process from 'node:process';
+import readline from 'node:readline';
+import fullstore from 'fullstore';
+import {isCI as _isCI} from 'ci-info';
 
 const isStop = fullstore(false);
 
@@ -18,8 +16,13 @@ const isSet = (a, b) => a
     .filter(isKeypress)
     .length;
 
-module.exports = (stream = process.stdin) => {
-    if (!stream.isTTY || isCI && KEYPRESS !== '1')
+export const keypress = (stream = process.stdin, overrides = {}) => {
+    const {
+        isCI = _isCI,
+        keypress = KEYPRESS,
+    } = overrides;
+    
+    if (!stream.isTTY || isCI && keypress !== '1')
         return {
             isHandlerSet: IS_NOT_SET,
             isStop,
@@ -44,4 +47,4 @@ const onKeyPress = (isStop) => function __keypress(str, key) {
         isStop(true);
 };
 
-module.exports._onKeyPress = onKeyPress;
+export const _onKeyPress = onKeyPress;

packages/cli-keypress/eslint.config.mjs packages/cli-keypress/eslint.config.jspackages/cli-keypress/eslint.config.mjs renamed to packages/cli-keypress/eslint.config.js

@@ -1,20 +1,16 @@
-'use strict';
+import process from 'node:process';
+import {Readable} from 'node:stream';
+import {test, stub} from 'supertape';
+import {keypress, _onKeyPress} from './keypress.js';
 
-const process = require('node:process');
-const {Readable} = require('node:stream');
-const {test, stub} = require('supertape');
-const mockRequire = require('mock-require');
-
-const {reRequire, stopAll} = mockRequire;
 const {assign} = Object;
 
 test('putout: cli: on halt: no isTTY', (t) => {
     const {isTTY} = process.stdin;
 
     process.stdin.isTTY = false;
 
-    const onHalt = reRequire('./keypress');
-    const {isHandlerSet} = onHalt();
+    const {isHandlerSet} = keypress();
 
     process.stdin.isTTY = isTTY;
 
@@ -27,19 +23,14 @@ test('putout: cli: on halt: isTTY', (t) => {
 
     process.env.CI = true;
 
-    mockRequire('ci-info', {
+    const stream = createStream();
+    
+    const {isHandlerSet} = keypress(stream, {
         isCI: false,
     });
 
-    const onHalt = reRequire('./keypress');
-    
-    const stream = createStream();
-    const {isHandlerSet} = onHalt(stream);
-    
     process.env.CI = CI;
 
-    stopAll();
-    
     t.ok(isHandlerSet(), 'should set handler');
     t.end();
 });
@@ -49,52 +40,34 @@ test('putout: cli: on halt: isTTY: double call', (t) => {
 
     process.env.CI = true;
 
-    mockRequire('ci-info', {
+    const stream = createStream();
+    const {isHandlerSet} = keypress(stream, {
         isCI: false,
     });
 
-    const onHalt = reRequire('./keypress');
-    
-    const stream = createStream();
-    const {isHandlerSet} = onHalt(stream);
-    
-    onHalt(stream);
+    keypress(stream);
     process.env.CI = CI;
 
-    stopAll();
-    
     t.ok(isHandlerSet(), 'should set handler');
     t.end();
 });
 
 test('putout: cli: on halt: CI, KEYPRESS', (t) => {
-    const {KEYPRESS} = process.env;
-    
-    process.env.KEYPRESS = '1';
-    
-    mockRequire('ci-info', {
+    const stream = createStream();
+    const {isHandlerSet} = keypress(stream, {
         isCI: true,
+        keypress: '1',
     });
 
-    const onHalt = reRequire('./keypress');
-    const stream = createStream();
-    const {isHandlerSet} = onHalt(stream);
-    
-    onHalt(stream);
-    process.env.KEYPRESS = KEYPRESS;
-    
-    stopAll();
+    keypress(stream);
 
     t.ok(isHandlerSet(), 'should set handler');
     t.end();
 });
 
 test('putout: cli: on halt: onKeyPress: Ctrl+C', (t) => {
-    const {_onKeyPress} = reRequire('./keypress');
     const isStop = stub();
-    
     const fn = _onKeyPress(isStop);
-    
     const str = '^c';
 
     const key = {
@@ -109,7 +82,6 @@ test('putout: cli: on halt: onKeyPress: Ctrl+C', (t) => {
 });
 
 test('putout: cli: on halt: onKeyPress: not Ctrl+C', (t) => {
-    const {_onKeyPress} = reRequire('./keypress');
     const isStop = stub();
 
     const fn = _onKeyPress(isStop);

packages/cli-keypress/lib/keypress.js

@@ -1,7 +1,7 @@
 {
   "name": "@putout/cli-keypress",
   "version": "2.0.0",
-  "type": "commonjs",
+  "type": "module",
   "author": "coderaiser <[email protected]> (https://github.com/coderaiser)",
   "description": "handle keypress",
   "homepage": "https://github.com/coderaiser/putout/tree/master/packages/cli-keypress#readme",
@@ -34,7 +34,6 @@
     "gitignore"
   ],
   "devDependencies": {
-    "@putout/eslint-flat": "^3.0.0",
     "c8": "^10.0.0",
     "eslint": "^9.0.0",
     "eslint-plugin-n": "^17.0.0",
@@ -47,7 +46,7 @@
   },
   "license": "MIT",
   "engines": {
-    "node": ">=16"
+    "node": ">=20"
   },
   "publishConfig": {
     "access": "public"

packages/cli-keypress/lib/keypress.spec.js

@@ -1,8 +1,8 @@
-import keyPress from '@putout/cli-keypress';
+import {keypress} from '@putout/cli-keypress';
 import {createReport} from './index.js';
 
 export const subscribe = async ({write, cwd, args, worker, exit}) => {
-    const {isStop} = keyPress();
+    const {isStop} = keypress();
     const report = await createReport({
         args,
         cwd,

packages/cli-keypress/package.json

@@ -15,7 +15,7 @@ const {
     defaultProcessors,
 } = require('@putout/engine-processor');
 
-const keyPress = require('@putout/cli-keypress');
+const {keypress: _keypress} = require('@putout/cli-keypress');
 
 const supportedFiles = require('./supported-files');
 const getOptions = require('./get-options');
@@ -56,17 +56,32 @@ const getExitCode = (wasStop) => wasStop() ? WAS_STOP : OK;
 const isStr = (a) => typeof a === 'string';
 const isNoop = (a) => String(a) === String(noop);
 
-const parseIsStop = (passedIsStop) => {
+const parseIsStop = (passedIsStop, {keypress}) => {
     if (!isNoop(passedIsStop))
         return passedIsStop;
 
-    const {isStop} = keyPress();
+    const {isStop} = keypress();
 
     return isStop;
 };
 
-module.exports = async ({argv, halt, log, write, logError, readFile, writeFile, trace = noop, isStop = noop}) => {
-    isStop = parseIsStop(isStop);
+module.exports = async (overrides = {}) => {
+    const {
+        argv,
+        halt,
+        log,
+        write,
+        logError,
+        readFile,
+        writeFile,
+        trace = noop,
+        keypress = _keypress,
+    } = overrides;
+    
+    const isStop = parseIsStop(overrides.isStop || noop, {
+        keypress,
+    });
+    
     trace('start');
 
     const wasStop = fullstore();

packages/engine-reporter/lib/subscribe.js

@@ -1935,7 +1935,6 @@ test('putout: cli: get files: was stop', async (t) => {
 
     mockRequire('./get-options', getOptions);
     mockRequire('./get-files', getFiles);
-    mockRequire('@putout/cli-keypress', keypress);
 
     reRequire('./runner/writer.js');
     reRequire('./runner/runner.js');
@@ -1945,6 +1944,7 @@ test('putout: cli: get files: was stop', async (t) => {
         cli,
         argv,
         halt,
+        keypress,
     });
 
     stopAll();
@@ -2407,6 +2407,7 @@ async function runCli(options) {
         cli = _cli,
         readFile = stub().returns(''),
         writeFile = stub(),
+        keypress,
     } = options;
 
     await cli({
@@ -2418,5 +2419,6 @@ async function runCli(options) {
         readFile,
         writeFile,
         isStop,
+        keypress,
     });
 }