@putout/engine-reporter 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) coderaiser
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,16 @@
+# @putout/engine-reporter [![NPM version][NPMIMGURL]][NPMURL]
+
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/engine-reporter.svg?style=flat&longCache=true
+[NPMURL]: https://npmjs.org/package/@putout/engine-reporter "npm"
+
+Run 🐊[**Putout**](https://github.com/coderaiser/putout) formatters.
+
+## Install
+
+```
+npm i @putout/engine-reporter
+```
+
+## License
+
+MIT

package/lib/formatter/formatter.cjs

@@ -0,0 +1,28 @@
+'use strict';
+
+const {simpleImport} = require('../simple-import.cjs');
+const {createAsyncLoader} = require('@putout/engine-loader');
+
+const tryToCatch = require('try-to-catch');
+const {
+    NO_FORMATTER,
+    CANNOT_LOAD_FORMATTER,
+} = require('putout/exit-codes/cjs');
+
+const {isArray} = Array;
+const maybeArray = (a) => isArray(a) ? a : [a, {}];
+
+module.exports.getFormatter = async (formatterOptional, exit) => {
+    const [formatterName, formatterOptions] = maybeArray(formatterOptional);
+    const loadFormatter = createAsyncLoader('formatter');
+    
+    const [error, formatter] = await tryToCatch(loadFormatter, formatterName, simpleImport);
+    
+    if (formatter)
+        return [formatter, formatterOptions];
+    
+    if (error.code === 'ERR_MODULE_NOT_FOUND')
+        return exit(NO_FORMATTER, error);
+    
+    exit(CANNOT_LOAD_FORMATTER, error);
+};

package/lib/index.js

@@ -0,0 +1,54 @@
+import module from 'node:module';
+import tryCatch from 'try-catch';
+import getOptions from 'putout/cli/get-options';
+import {
+    INTERACTIVE_CANCELED,
+    INVALID_CONFIG,
+} from 'putout/exit-codes';
+
+import {getFormatter} from './formatter/formatter.cjs';
+import Report from './report.cjs';
+
+const {createRequire} = module;
+const require = createRequire(import.meta.url);
+const {formatter: defaultFormatter} = require('putout/putout.json');
+const {dependencies} = require('putout/package.json');
+
+const {keys} = Object;
+
+export const createReport = async ({args, cwd, exit}) => {
+    const {interactive, format} = args;
+    
+    const report = Report();
+    const noConfig = !args.config;
+    
+    const [configError, config] = tryCatch(getOptions, {
+        name: `${cwd()}/*`,
+        noConfig,
+    });
+    
+    if (configError)
+        exit(INVALID_CONFIG, configError);
+    
+    const {formatter} = config;
+    
+    let newFormatter;
+    
+    if (interactive) {
+        const {chooseFormatter} = await import('@putout/cli-choose-formatter');
+        
+        [newFormatter] = await chooseFormatter(defaultFormatter, keys(dependencies));
+        
+        if (!newFormatter)
+            exit(INTERACTIVE_CANCELED);
+    }
+    
+    const [currentFormat, formatterOptions] = await getFormatter(newFormatter || format || formatter, exit);
+    
+    return async (a) => {
+        return await report(currentFormat, {
+            ...a,
+            formatterOptions,
+        });
+    };
+};

package/lib/report.cjs

@@ -0,0 +1,54 @@
+'use strict';
+
+const {isArray} = Array;
+const noop = () => {};
+
+module.exports = () => {
+    let filesCount = 0;
+    let errorsCount = 0;
+    
+    return async (formatter, options) => {
+        const {
+            name,
+            rule,
+            source,
+            places,
+            index = 0,
+            count = 1,
+            trace = noop,
+            formatterOptions = {},
+        } = options;
+        
+        if (!isArray(places))
+            throw Error(`☝️ Looks like for 'places: Places[]' you passed the wrong type: '${typeof places}'`);
+        
+        if (places.length)
+            ++filesCount;
+        
+        errorsCount += places.length;
+        
+        trace('progress', {
+            rule,
+            name,
+            options: formatterOptions,
+            source,
+            places,
+            index,
+            count,
+            filesCount,
+            errorsCount,
+        });
+        
+        return await formatter({
+            rule,
+            name,
+            options: formatterOptions,
+            source,
+            places,
+            index,
+            count,
+            filesCount,
+            errorsCount,
+        });
+    };
+};

package/lib/simple-import.cjs

@@ -0,0 +1,6 @@
+'use strict';
+
+module.exports.simpleImport = async (url) => {
+    const result = await import(url);
+    return result.default || result;
+};

package/lib/subscribe.js

@@ -0,0 +1,26 @@
+import keyPress from '@putout/cli-keypress';
+import {createReport} from './index.js';
+
+export const subscribe = async ({write, cwd, args, worker, exit}) => {
+    const {isStop} = keyPress();
+    const report = await createReport({
+        args,
+        cwd,
+        exit,
+    });
+    
+    worker.on('exit', exit);
+    worker.on('message', async ([event, data]) => {
+        if (event !== 'progress')
+            return;
+        
+        //if (isStop())
+        //    data.index = data.count - 1;
+        const line = await report(data);
+        
+        write(line || '');
+        
+        if (isStop())
+            worker.postMessage(['stop']);
+    });
+};

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@putout/engine-reporter",
+  "version": "1.0.0",
+  "type": "module",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "Run 🐊Putout formatters",
+  "homepage": "https://github.com/coderaiser/putout/tree/master/packages/engine-reporter#readme",
+  "main": "./lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./subscribe": "./lib/subscribe.js",
+    "./report": "./lib/report.cjs",
+    "./formatter": "./lib/formatter/formatter.cjs"
+  },
+  "release": false,
+  "tag": false,
+  "changelog": false,
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/coderaiser/putout.git"
+  },
+  "scripts": {
+    "test": "madrun test",
+    "watch:test": "madrun watch:test",
+    "lint": "madrun lint",
+    "fresh:lint": "madrun fresh:lint",
+    "lint:fresh": "madrun lint:fresh",
+    "fix:lint": "madrun fix:lint",
+    "coverage": "madrun coverage",
+    "report": "madrun report"
+  },
+  "dependencies": {
+    "@putout/cli-choose-formatter": "^3.0.0",
+    "@putout/cli-keypress": "^2.0.0",
+    "@putout/engine-loader": "^13.0.0",
+    "fullstore": "^3.0.0",
+    "try-catch": "^3.0.1",
+    "try-to-catch": "^3.0.1"
+  },
+  "keywords": [
+    "putout",
+    "putout-engine"
+  ],
+  "devDependencies": {
+    "@putout/formatter-progress": "^4.0.0",
+    "c8": "^9.0.0",
+    "eslint": "^9.0.0-alpha.0",
+    "eslint-plugin-n": "^17.0.0-0",
+    "eslint-plugin-putout": "^22.0.0",
+    "just-camel-case": "^4.0.2",
+    "lerna": "^6.0.1",
+    "madrun": "^10.0.0",
+    "mock-require": "^3.0.3",
+    "montag": "^1.0.0",
+    "nodemon": "^3.0.1",
+    "putout": "*",
+    "supertape": "^9.0.0"
+  },
+  "peerDependencies": {
+    "putout": "*"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}