redlint 3.1.2 → 3.2.0

package/ChangeLog

@@ -1,3 +1,9 @@
+2023.12.20, v3.2.0
+
+feature:
+- 333f321 redlint: debug: back
+- 955f5d3 redlint: pack: add
+
 2023.12.19, v3.1.2
 
 feature:

package/README.md

@@ -13,13 +13,13 @@
 >
 > **(c) The Book of Kon, PoKon and ZaKon**
 
-![image](https://github.com/putoutjs/redlint/assets/1573141/a34a7e75-b30f-4e79-b132-1d411d96ba15)
+![image](https://github.com/putoutjs/redlint/assets/1573141/09bed270-cbf5-484f-bdd6-dd031ae38703)
 
 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**?
 
 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** 😏💾.
+First time ever! Linter for your **Filesystem** 😏💾.
 
 ## Install
 
@@ -31,7 +31,7 @@ npm i redlint -g
 
 You can choose interactively when run `redlint`:
 
-![image](https://github.com/putoutjs/redlint/assets/1573141/1d3c26a6-14f2-43f9-8115-29b28d5d5f26)
+![image](https://github.com/putoutjs/redlint/assets/1573141/c5d3a231-6caf-4dcb-9410-1d4dda48d9e0)
 
 ## Scan
 

package/bin/redlint.js

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
 
-import {lintJSON} from 'putout/lint/json';
+import {join} from 'node:path';
 import process from 'node:process';
 import {
     readFile,
     writeFile,
 } from 'node:fs/promises';
+import {lintJSON} from 'putout/lint/json';
 import stripAnsi from 'strip-ansi';
 import formatterCodeFrame from '@putout/formatter-codeframe';
 import formatterDump from '@putout/formatter-dump';
@@ -15,127 +16,144 @@ import {choose} from '../lib/choose.js';
 import {buildTree} from '../lib/redlint.js';
 import {convertToSimple} from '../lib/simple.js';
 import {masterLint} from '../lib/master.js';
+import {masterPack} from '../lib/pack/master.js';
 import {lint} from '../lib/lint.js';
-import {logo} from '../lib/logo.js';
+import {pack} from '../lib/pack/pack.js';
+import {debug} from '../lib/debug.js';
 
 const {stringify, parse} = JSON;
 
-let [arg] = process.argv.slice(2);
+const [arg] = process.argv.slice(2);
 let header = true;
 
-if (!arg) {
-    const cmd = await choose();
+await uiLoop(arg);
+
+async function uiLoop(arg) {
+    if (!arg) {
+        const cmd = await choose();
+        
+        if (!cmd)
+            process.exit(1);
+        
+        [arg] = stripAnsi(cmd).split(' ');
+        header = false;
+    }
     
-    if (!cmd)
-        process.exit(1);
+    if (arg === 'debug') {
+        arg = await debug();
+        
+        if (arg === 'back')
+            return await uiLoop();
+    }
     
-    [arg] = stripAnsi(cmd).split(' ');
-    header = false;
-}
-
-if (arg === 'exit')
-    process.exit();
-
-if (arg === 'version') {
-    const packagePath = new URL('../package.json', import.meta.url);
-    const packageData = await readFile(packagePath);
-    const {version} = parse(packageData);
+    if (arg === 'exit')
+        process.exit();
     
-    console.log(`v${version}`);
-    process.exit();
-}
-
-if (arg === 'help') {
-    help({
-        header,
-    });
-    process.exit();
-}
-
-console.log('Running:');
-const spinner = ora('index filesystem').start();
-const result = await buildTree(process.cwd());
-
-spinner.succeed();
-
-if (arg === 'generate:simple') {
-    await writeFile('.filesystem.json', lintJSON(stringify(convertToSimple(result))));
-    process.exit(0);
-}
-
-const filesystem = lintJSON(stringify(result));
-
-if (arg === 'scan') {
-    const places = await masterLint(filesystem, {
-        fix: false,
-    });
+    if (arg === 'version') {
+        const packagePath = new URL('../package.json', import.meta.url);
+        const packageData = await readFile(packagePath);
+        const {version} = parse(packageData);
+        
+        console.log(`v${version}`);
+        process.exit();
+    }
     
-    if (!places.length)
+    if (arg === 'help') {
+        help({
+            header,
+        });
         process.exit();
+    }
     
-    console.log('');
-    const dump = await formatterDump({
-        name: '.filesystem.json',
-        source: filesystem,
-        places,
-        index: 0,
-        count: places.length,
-        filesCount: 1,
-        errorsCount: places.length,
-    });
+    console.log('Running:');
+    const spinner = ora('index filesystem').start();
+    const CWD = process.cwd();
+    const result = await buildTree(CWD);
     
-    process.stderr.write(dump);
+    spinner.succeed();
     
-    process.exit(1);
-}
-
-if (arg === 'scan:frame') {
-    const places = await masterLint(filesystem, {
-        fix: true,
-    });
+    if (arg === 'generate:simple') {
+        await writeFile('.filesystem.json', lintJSON(stringify(convertToSimple(result))));
+        process.exit(0);
+    }
     
-    const result = await formatterCodeFrame({
-        name: '.filesystem.json',
-        source: filesystem,
-        places,
-        index: 0,
-        count: places.length,
-        filesCount: 1,
-        errorsCount: places.length,
-    });
+    const filesystem = lintJSON(stringify(result));
     
-    process.stderr.write(result);
-    process.exit(1);
-}
-
-if (arg === 'lint') {
-    const places = lint(filesystem, {
-        fix: true,
-    });
+    if (arg === 'scan') {
+        const places = await masterLint(filesystem, {
+            fix: false,
+        });
+        
+        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);
+    }
     
-    console.log(logo);
+    if (arg === 'pack') {
+        const result = await masterPack(CWD, filesystem);
+        await writeFile(join(CWD, 'filesystem.red'), result);
+        const spinner = ora(`pack 'filesystem.red'`).start();
+        
+        spinner.succeed();
+        process.exit();
+    }
     
-    const result = await formatterCodeFrame({
-        name: '.filesystem.json',
-        source: filesystem,
-        places,
-        index: 0,
-        count: places.length,
-        filesCount: 1,
-        errorsCount: places.length,
-    });
+    if (arg === 'pack:debug') {
+        const result = pack(CWD, filesystem);
+        await writeFile(join(CWD, 'filesystem.red'), result);
+        
+        done(`pack 'filesystem.red'`);
+        process.exit();
+    }
     
-    process.stderr.write(result);
-    process.exit(1);
-}
-
-if (arg === 'fix') {
-    await masterLint(filesystem, {
-        fix: true,
-    });
+    if (arg === 'scan:debug') {
+        const places = lint(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);
+    }
     
-    process.exit();
+    if (arg === 'fix') {
+        await masterLint(filesystem, {
+            fix: true,
+        });
+        
+        process.exit();
+    }
+    
+    if (arg === 'generate')
+        await writeFile('.filesystem.json', filesystem);
+    
+    done(`generate '.filesystem.json'`);
 }
 
-if (arg === 'generate')
-    await writeFile('.filesystem.json', filesystem);
+function done(message) {
+    const spinner = ora(message).start();
+    spinner.succeed();
+}

package/lib/choose.js

@@ -9,12 +9,13 @@ export const choose = async () => {
     
     const command = await chooseDialog('Command:', [
         'scan',
-        'scan:frame',
         'fix',
+        'pack',
         'generate',
         'generate:simple',
         'help',
         'version',
+        'debug',
         'exit',
     ]);
     

package/lib/debug.js

@@ -0,0 +1,14 @@
+import {choose as chooseDialog} from '@putout/cli-choose';
+
+export const debug = async () => {
+    const command = await chooseDialog('Debug:', [
+        'scan:debug',
+        'pack:debug',
+        'back',
+        'exit',
+    ]);
+    
+    console.log('');
+    
+    return command;
+};

package/lib/help.js

@@ -12,10 +12,12 @@ export const help = ({header = true}) => {
     
     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
+  pack              - pack 'filesystem.red' with directory contents
   help              - show help screen and exit
   generate          - generate .filesystem.json file and exit
   generate:simple   - generate simple .filesystem.json file and exit
+  version           - show version and exit
+  debug             = run commands without workers
 `);
 };

package/lib/pack/master.js

@@ -0,0 +1,136 @@
+import {Worker} from 'node:worker_threads';
+import ora from 'ora';
+import chalk from 'chalk';
+import fullstore from 'fullstore';
+
+export function masterPack(cwd, filesystem, {
+    start = setStart,
+    end = setEnd,
+    push = setPush,
+    fail = setFail,
+    success = setSuccess,
+} = {}) {
+    return run(cwd, filesystem, {
+        start,
+        end,
+        push,
+        fail,
+        success,
+    });
+}
+
+function setStart(rule, store) {
+    const spinner = ora(rule).start();
+    
+    spinner.suffixText = '';
+    
+    store({
+        rule,
+        count: 0,
+        spinner,
+    });
+}
+
+function setPush(store) {
+    const {
+        rule,
+        count,
+        spinner,
+    } = store();
+    
+    store({
+        rule,
+        count: count + 1,
+        spinner,
+    });
+}
+
+function setFail(store) {
+    const {
+        rule,
+        count,
+        spinner,
+    } = store();
+    
+    spinner.suffixText = chalk.red(count);
+    spinner.fail();
+    
+    store({
+        rule,
+        count,
+        spinner,
+    });
+}
+
+function setSuccess(store) {
+    const {spinner} = store();
+    
+    spinner.succeed();
+    spinner.suffixText = '';
+    
+    store({
+        ...store(),
+        spinner: null,
+    });
+}
+
+function setEnd(data, resolve) {
+    resolve(data);
+}
+
+function run(cwd, filesystem, {start, end, fail, success}) {
+    return new Promise((resolve, reject) => {
+        const worker = new Worker(new URL('./slave.js', import.meta.url), {
+            workerData: {
+                cwd,
+                filesystem,
+            },
+        });
+        
+        const store = fullstore({});
+        
+        worker.on('message', ([event, data]) => {
+            if (event === 'end') {
+                end(data, resolve);
+                return;
+            }
+            
+            if (event === 'rule:start') {
+                start(data, store);
+                return;
+            }
+            
+            const {
+                rule,
+                count,
+                spinner,
+            } = store();
+            
+            if (!spinner)
+                return;
+            
+            store({
+                rule,
+                count,
+                spinner,
+            });
+            
+            const endFail = count && event === 'rule:end';
+            const endSuccess = !count && event === 'rule:end';
+            
+            if (endFail) {
+                fail(store);
+                return;
+            }
+            
+            if (endSuccess) {
+                success(store);
+                return;
+            }
+        });
+        worker.on('error', reject);
+        worker.on('exit', (code) => {
+            reject(Error(`Worker stopped with exit code ${code}`));
+        });
+    });
+}

package/lib/pack/pack.js

@@ -0,0 +1,39 @@
+import {
+    parse,
+    transform,
+    print,
+} from 'putout';
+import {createProgress} from '@putout/engine-runner/progress';
+import * as pluginFilesystem from '@putout/plugin-filesystem';
+import {
+    branch,
+    merge,
+} from '@putout/processor-filesystem';
+
+const [, readAllFiles] = pluginFilesystem.rules['read-all-files'];
+const [, replaceCwd] = pluginFilesystem.rules['replace-cwd'];
+
+export const pack = (from, filesystem, {progress = createProgress()} = {}) => {
+    const [{source}] = branch(filesystem);
+    const ast = parse(source);
+    
+    transform(ast, filesystem, {
+        fix: true,
+        fixCount: 1,
+        progress,
+        rules: {
+            'replace-cwd': ['on', {
+                from,
+                to: '/',
+            }],
+        },
+        plugins: [
+            ['read-all-files', readAllFiles],
+            ['replace-cwd', replaceCwd],
+        ],
+    });
+    
+    const code = print(ast);
+    
+    return merge(filesystem, [code]);
+};

package/lib/pack/slave.js

@@ -0,0 +1,25 @@
+import {
+    parentPort,
+    workerData,
+} from 'node:worker_threads';
+import {pack} from './pack.js';
+import {createProgress} from '@putout/engine-runner/progress';
+
+const {filesystem, cwd} = workerData;
+const progress = createProgress();
+
+progress.on('start', ({rule}) => {
+    parentPort.postMessage(['rule:start', rule]);
+});
+
+progress.on('push', ({rule}) => {
+    parentPort.postMessage(['rule:push', rule]);
+});
+
+progress.on('end', ({rule}) => {
+    parentPort.postMessage(['rule:end', rule]);
+});
+
+parentPort.postMessage(['end', pack(cwd, filesystem, {
+    progress,
+})]);

package/lib/slave.js

@@ -5,7 +5,7 @@ import {
 import {lint} from './lint.js';
 import {createProgress} from '@putout/engine-runner/progress';
 
-const {filesystem, fix} = workerData;
+const {fix, filesystem} = workerData;
 
 const progress = createProgress();
 

package/package.json

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