redlint 2.1.2 → 3.0.0

package/ChangeLog

@@ -1,3 +1,8 @@
+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,8 +3,9 @@
 import {lintJSON} from 'putout/lint/json';
 import process from 'node:process';
 import {writeFile} from 'node:fs/promises';
+import formatterCodeFrame from '@putout/formatter-codeframe';
 import ora from 'ora';
-import logo from '../lib/logo.js';
+import {help} from '../lib/help.js';
 import {buildTree} from '../lib/redlint.js';
 import {convertToSimple} from '../lib/simple.js';
 import {masterLint} from '../lib/master.js';
@@ -14,8 +15,8 @@ const {stringify} = JSON;
 
 const [arg] = process.argv.slice(2);
 
-if (arg === 'help') {
-    logo();
+if (!arg || arg === 'help') {
+    help();
     process.exit();
 }
 
@@ -36,8 +37,11 @@ if (arg === 'scan') {
         fix: false,
     });
     
-    console.log(result);
-    process.exit();
+    if (!result.length)
+        process.exit();
+    
+    console.error(result);
+    process.exit(1);
 }
 
 if (arg === 'lint') {
@@ -45,16 +49,28 @@ if (arg === 'lint') {
         fix: true,
     });
     
-    console.log(result);
+    process.stderr.write(result);
     process.exit();
 }
 
 if (arg === 'fix') {
-    await masterLint(filesystem, {
+    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.stdout.write(result);
     process.exit();
 }
 
-await writeFile('.filesystem.json', filesystem);
+if (arg === 'generate')
+    await writeFile('.filesystem.json', filesystem);

package/lib/help.js

@@ -0,0 +1,18 @@
+import {logo} from './logo.js';
+import chalk from 'chalk';
+import process from 'node:process';
+
+export const help = () => {
+    console.log('Lint your files according to 🐊Putout rules.\n');
+    process.stdout.write(logo);
+    console.log('');
+    console.log(`Usage: redlint ${chalk.bgBlue('command')}`);
+    console.log(`Commands:
+  ${chalk.bgBlue('scan')}     - scan files according to 🐊Putout rules
+  ${chalk.bgBlue('fix')}      - fix files according to 🐊Putout rules
+  ${chalk.bgBlue('help')}     - show help screen and exit
+  ${chalk.bgBlue('generate')} - generate .filesystem.json file and exit
+`);
+    
+    console.log('(c) https://github.com/putoutjs/redlint');
+};

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redlint",
-  "version": "2.1.2",
+  "version": "3.0.0",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Lint Filesystem with 🐊Putout",
@@ -31,6 +31,7 @@
   },
   "dependencies": {
     "@putout/engine-runner": "^20.1.0",
+    "@putout/formatter-codeframe": "^6.0.0",
     "@putout/processor-filesystem": "^3.0.0",
     "chalk": "^5.3.0",
     "fullstore": "^3.0.0",