redlint 2.1.2 → 3.0.1

package/ChangeLog

@@ -1,3 +1,15 @@
+2023.12.18, v3.0.1
+
+feature:
+- 0afe4be redlint: scan:frame
+- 62a8307 redlint: improve formatter
+- 5d62840 redlint: strip-ansi v7.1.0
+
+2023.12.18, v3.0.0
+
+feature:
+- 0a8d5f1 redlint: move generate to separete option, show help by default
+
 2023.12.18, v2.1.2
 
 fix:

package/README.md

@@ -13,11 +13,13 @@
 >
 > **(c) The Book of Kon, PoKon and ZaKon**
 
-![image](https://github.com/putoutjs/redlint/assets/1573141/120df37e-cc7d-420d-a73d-777455335c9c)
+![image](https://github.com/putoutjs/redlint/assets/1573141/ec0efee1-0bfc-4595-ba85-aaaabe274a34)
 
-Lint Filesystem with 🐊[**Putout**](https://github.com/coderaiser/putout). Creates [`.filesystem.json`](https://github.com/putoutjs/redlint/blob/master/.filesystem.json) file for further lint.
+What if **Filesystem** was a simple **JSON** file [`.filesystem.json`](https://github.com/putoutjs/redlint/blob/master/.filesystem.json). What if you can transform **JSON** file with 🐊[**Putout**](https://github.com/coderaiser/putout) code transformer and this changes modify **Filesystem**?
 
-Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/0614c2da35a1864b59ac284f18656328/695a9960c401d4e8f6744f58eac591d8f9185235).
+What if I tell you it is possible? 😱 Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/0614c2da35a1864b59ac284f18656328/695a9960c401d4e8f6744f58eac591d8f9185235).
+
+First time ever! Linter for you **Filesystem** 😏💾.
 
 ## Install
 
@@ -25,33 +27,21 @@ Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/0614c2da35
 npm i redlint -g
 ```
 
-## Usage Example
+## Scan
 
-To produce `.filesystem.json` file use:
+To scan your files use `redlint scan`:
 
-```sh
-redlint
-```
+![image](https://github.com/putoutjs/redlint/assets/1573141/c17de523-66ea-49a1-b65d-4872ff1ecb37)
 
-Scan filesystem:
+## Scan
 
-```sh
-redlint scan
-```
+To fix your files use `redlint fix`:
 
-Fix filesystem:
+![image](https://github.com/putoutjs/redlint/assets/1573141/5ce7a8de-b5c1-44b7-8302-918b9e58b185)
 
-```sh
-redlint fix
-```
-
-When you want `simple filesystem` format use:
-
-```sh
-redlint simple
-```
+## Generate
 
-![image](https://github.com/putoutjs/redlint/assets/1573141/cad02be5-f1b9-43da-a55c-a58ff16cad42)
+You can also generate `.filesystem.json` file with `putout generate`.
 
 ## License
 

package/bin/redlint.js

@@ -3,22 +3,41 @@
 import {lintJSON} from 'putout/lint/json';
 import process from 'node:process';
 import {writeFile} from 'node:fs/promises';
+import stripAnsi from 'strip-ansi';
+import formatterCodeFrame from '@putout/formatter-codeframe';
+import formatterDump from '@putout/formatter-dump';
 import ora from 'ora';
-import logo from '../lib/logo.js';
+import {help} from '../lib/help.js';
+import {start} from '../lib/start.js';
 import {buildTree} from '../lib/redlint.js';
 import {convertToSimple} from '../lib/simple.js';
 import {masterLint} from '../lib/master.js';
 import {lint} from '../lib/lint.js';
+import {logo} from '../lib/logo.js';
 
 const {stringify} = JSON;
 
-const [arg] = process.argv.slice(2);
+let [arg] = process.argv.slice(2);
+let header = true;
+
+if (!arg) {
+    const cmd = await start();
+    
+    if (!cmd)
+        process.exit(1);
+    
+    [arg] = stripAnsi(cmd).split(' ');
+    header = false;
+}
 
 if (arg === 'help') {
-    logo();
+    help({
+        header,
+    });
     process.exit();
 }
 
+console.log('Running:');
 const spinner = ora('index filesystem').start();
 const result = await buildTree(process.cwd());
 
@@ -32,21 +51,67 @@ if (arg === 'simple') {
 const filesystem = lintJSON(stringify(result));
 
 if (arg === 'scan') {
-    const result = await masterLint(filesystem, {
+    const places = await masterLint(filesystem, {
         fix: false,
     });
     
-    console.log(result);
-    process.exit();
+    if (!places.length)
+        process.exit();
+    
+    console.log('');
+    const dump = await formatterDump({
+        name: '.filesystem.json',
+        source: filesystem,
+        places,
+        index: 0,
+        count: places.length,
+        filesCount: 1,
+        errorsCount: places.length,
+    });
+    
+    process.stderr.write(dump);
+    
+    process.exit(1);
+}
+
+if (arg === 'scan:frame') {
+    const places = await masterLint(filesystem, {
+        fix: true,
+    });
+    
+    const result = await formatterCodeFrame({
+        name: '.filesystem.json',
+        source: filesystem,
+        places,
+        index: 0,
+        count: places.length,
+        filesCount: 1,
+        errorsCount: places.length,
+    });
+    
+    process.stderr.write(result);
+    process.exit(1);
 }
 
 if (arg === 'lint') {
-    const result = lint(filesystem, {
+    const places = lint(filesystem, {
         fix: true,
     });
     
-    console.log(result);
-    process.exit();
+    console.log(logo);
+    
+    const result = await formatterCodeFrame({
+        name: '.filesystem.json',
+        source: filesystem,
+        places,
+        index: 0,
+        count: places.length,
+        filesCount: 1,
+        errorsCount: places.length,
+    });
+    
+    process.stderr.write(result);
+    process.exit(1);
 }
 
 if (arg === 'fix') {
@@ -57,4 +122,5 @@ if (arg === 'fix') {
     process.exit();
 }
 
-await writeFile('.filesystem.json', filesystem);
+if (arg === 'generate')
+    await writeFile('.filesystem.json', filesystem);

package/lib/help.js

@@ -0,0 +1,22 @@
+import {logo} from './logo.js';
+import process from 'node:process';
+
+export const help = ({header = true}) => {
+    if (header) {
+        console.log('Lint your files according to 🐊Putout rules.\n');
+        process.stdout.write(logo);
+        console.log('');
+    }
+    
+    console.log(`Usage: redlint [command]`);
+    
+    console.log(`Commands:
+  scan          - scan files according to 🐊Putout rules
+  scan:frame    - scan files, show results in code frame
+  fix           - fix files according to 🐊Putout rules
+  help          - show help screen and exit
+  generate      - generate .filesystem.json file and exit
+`);
+    
+    console.log('');
+};

package/lib/logo.js

@@ -1,5 +1,4 @@
 import chalk from 'chalk';
-import process from 'node:process';
 
 /*
 console.log(`
@@ -10,10 +9,10 @@ ${chalk.red('██   ██ ██      ██   ██')} ${chalk.white('█
 ${chalk.red('██   ██ ███████ ██████ ')} ${chalk.white('███████ ██ ██   ████    ██    ')}
 `);
 */
-export default () => process.stdout.write(`
+export const logo = `
 ${chalk.red('██████  ███████ ██████ ')} ██      ██ ███    ██ ████████ 
 ${chalk.red('██   ██ ██      ██   ██')} ██      ██ ████   ██    ██    
 ${chalk.red('██████  █████   ██   ██')} ██      ██ ██ ██  ██    ██    
 ${chalk.red('██   ██ ██      ██   ██')} ██      ██ ██  ██ ██    ██    
 ${chalk.red('██   ██ ███████ ██████ ')} ███████ ██ ██   ████    ██    
-`.slice(1));
+`.slice(1);

package/lib/start.js

@@ -0,0 +1,21 @@
+import {logo} from './logo.js';
+import process from 'node:process';
+import {choose} from '@putout/cli-choose';
+
+export const start = async () => {
+    console.log('Lint your files according to 🐊Putout rules.\n');
+    process.stdout.write(logo);
+    console.log('');
+    
+    const command = await choose('Command:', [
+        'scan',
+        'scan:frame',
+        'fix',
+        'help',
+        'generate',
+    ]);
+    
+    console.log('');
+    
+    return command;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redlint",
-  "version": "2.1.2",
+  "version": "3.0.1",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Lint Filesystem with 🐊Putout",
@@ -30,13 +30,17 @@
     "report": "madrun report"
   },
   "dependencies": {
+    "@putout/cli-choose": "^1.1.1",
     "@putout/engine-runner": "^20.1.0",
+    "@putout/formatter-codeframe": "^6.0.0",
+    "@putout/formatter-dump": "^4.0.1",
     "@putout/processor-filesystem": "^3.0.0",
     "chalk": "^5.3.0",
     "fullstore": "^3.0.0",
     "ignore": "^5.2.4",
     "ora": "^7.0.1",
-    "putout": "^34.0.0"
+    "putout": "^34.0.0",
+    "strip-ansi": "^7.1.0"
   },
   "keywords": [
     "putout",