redlint 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,326 @@
+# Printer [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
+
+[NPMURL]: https://npmjs.org/package/@putout/printer "npm"
+[NPMIMGURL]: https://img.shields.io/npm/v/@putout/printer.svg?style=flat&longCache=true
+[BuildStatusURL]: https://github.com/putoutjs/printer/actions/workflows/nodejs.yml "Build Status"
+[BuildStatusIMGURL]: https://github.com/putoutjs/printer/actions/workflows/nodejs.yml/badge.svg
+[LicenseURL]: https://tldrlegal.com/license/mit-license "MIT License"
+[LicenseIMGURL]: https://img.shields.io/badge/license-MIT-317BF9.svg?style=flat
+[CoverageURL]: https://coveralls.io/github/putoutjs/printer?branch=master
+[CoverageIMGURL]: https://coveralls.io/repos/putoutjs/printer/badge.svg?branch=master&service=github
+
+Prints [**Babel AST**](https://github.com/coderaiser/estree-to-babel) to readable **JavaScript**. For **ESTree** use [`estree-to-babel`](https://github.com/coderaiser/estree-to-babel).
+
+- ☝️ Similar to **Recast**, but [twice faster](#speed-comparison), also simpler and easier in maintenance, since it supports only **Babel**.
+- ☝️ As opinionated as **Prettier**, but has more user-friendly output and works directly with **AST**.
+- ☝️ Like **ESLint** but works directly with **Babel AST**.
+- ☝️ Easily extendable with help of [Overrides](#overrides).
+
+Supports:
+
+- ✅ **ES2023**;
+- ✅ **JSX**;
+- ✅ **TypeScript**;
+- ✅ [**JSON**](https://github.com/coderaiser/putout/tree/master/packages/processor-json#readme);
+
+## Install
+
+```
+npm i @putout/printer
+```
+
+## 🐊 Support of Printer
+
+**Printer** has first class support from 🐊**Putout** with help of [`@putout/plugin-printer`](https://github.com/coderaiser/putout/tree/master/packages/plugin-printer#putoutplugin-printer-). So install:
+
+```sh
+npm i @putout/plugin-printer -aD
+```
+
+And update `.putout.json`:
+
+```json
+{
+    "printer": "putout",
+    "plugins": ["printer"]
+}
+```
+
+To benefit from it.
+
+## Example
+
+```js
+const {print} = require('@putout/printer');
+const {parse} = require('@babel/parser');
+const ast = parse('const a = (b, c) => {const d = 5; return a;}');
+
+print(ast);
+// returns
+`
+const a = (b, c) => {
+    const d = 5;
+    return a;
+};
+`;
+```
+
+## Overrides
+
+When you need to extend syntax of `@putout/printer` just pass a function which receives:
+
+- `path`, Babel Path
+- `write`, a function to output result of printing into token array;
+
+When `path` contains to dashes `__` and name, it is the same as: `write(path.get('right'))`, and this is
+actually `traverse(path.get('right'))` shortened to simplify read and process.
+
+Here is how you can override `AssignmentPattern`:
+
+```js
+const ast = parse('const {a = 5} = b');
+
+print(ast, {
+    format: {
+        indent: '    ',
+        newline: '\n',
+        space: ' ',
+        splitter: '\n',
+        roundBraceOpen: '(',
+        roundBraceClose: ')',
+        quote: `'`,
+        endOfFile: '\n',
+    },
+    semantics: {
+        comments: true,
+        maxSpecifiersInOneLine: 2,
+        maxElementsInOneLine: 3,
+        maxVariablesInOneLine: 4,
+        maxPropertiesInOneLine: 2,
+        trailingComma: true,
+    },
+    visitors: {
+        AssignmentPattern(path, {print}) {
+            print('/* [hello world] */= ');
+            print('__right');
+        },
+    },
+});
+
+// returns
+'const {a/* [hello world] */= 5} = b;\n';
+```
+
+### `format`
+
+Options related to visuals and not related to logic of output can be changed with help of `format`,
+you can override next options:
+
+```js
+const overrides = {
+    format: {
+        indent: '    ',
+        newline: '\n',
+        space: ' ',
+        splitter: '\n',
+        roundBraceOpen: '(',
+        roundBraceClose: ')',
+        endOfFile: '\n',
+    },
+};
+```
+
+- `indent` - use two spaces, tabs, or anything you want;
+- `newline` - symbol for used for line separation;
+- `space` - default symbol used for space character;
+- `splitter` - mandatory symbol that used inside of statements like this:
+- `roundBraceOpen` and `roundBraceClose` symbols to output braces in a  single argument arrow function expressions: `(a) => {}`.
+
+Default options produce:
+
+```js
+if (a > 3)
+    console.log('ok');
+else
+    console.log('not ok');
+```
+
+But you can override them with:
+
+```js
+const overrides = {
+    format: {
+        indent: '',
+        newline: '',
+        space: '',
+        splitter: ' ',
+    },
+};
+```
+
+And have minified code:
+
+```
+if(a>3)console.log('ok');else console.log('not ok');
+```
+
+### Semantics
+
+Options used to configure logic of output, similar to ESLint rules:
+
+- ✅ `maxElementsInOneLine` - count of `ArrayExpression` and `ArrayPattern` elements placed in one line.
+- ✅ `maxVariablesInOneLine` - count of `VariableDeclarators` in one line.
+- ✅ `maxPropertiesInOneLine` - count of `ObjectProperties` in one line.
+
+## Visitors API
+
+When you want to improve support of existing visitor or extend **Printer** with a new ones, you need next base operations:
+
+### override
+
+When you need to override behavior of existing visitor use:
+
+```js
+import {
+    print,
+    visitors as v,
+} from '@putout/printer';
+
+print(ast, {
+    visitors: {
+        CallExpression(path, printer, semantics) {
+            const {print} = printer;
+            
+            if (!path.node.goldstein)
+                return v.CallExpression(path, printer, semantics);
+            
+            print('__goldstein');
+        },
+    },
+});
+```
+
+### `print`
+
+Used in previous example `print` can be used for a couple purposes:
+
+- to write `string`;
+- to write `node` when `object` passed;
+- to write `node` when `string` started with `__`;
+
+```js
+print(ast, {
+    visitors: {
+        AssignmentPattern(path, {print, maybe}) {
+            maybe.write.newline(path.parentPath.isCallExpression());
+            print('/* [hello world] */= ');
+            print('__right');
+        },
+    },
+});
+```
+
+### `maybe`
+
+When you need some condition use `maybe`. For example, to add newline only when parent node is `CallExpression` you
+can use `maybe.write.newline(condition)`:
+
+```js
+print(ast, {
+    visitors: {
+        AssignmentPattern(path, {write, maybe}) {
+            maybe.write.newline(path.parentPath.isCallExpression());
+            write(' /* [hello world] */= ');
+            write('__right');
+        },
+    },
+});
+```
+
+### `write`
+
+When you going to output string you can use low-level function `write`:
+
+```js
+print(ast, {
+    visitors: {
+        BlockStatement(path, {write}) {
+            write('hello');
+        },
+    },
+});
+```
+
+### `indent`
+
+When you need to add indentation use `indent`, for example when you output body,
+you need to increment indentation, and then decrement it back:
+
+```js
+print(ast, {
+    visitors: {
+        BlockStatement(path, {write, indent}) {
+            write('{');
+            indent.inc();
+            indent();
+            write('some;');
+            indent.dec();
+            write('{');
+        },
+    },
+});
+```
+
+### `traverse`
+
+When you need to traverse node path, you can use `traverse`:
+
+```js
+print(ast, {
+    visitors: {
+        AssignmentExpression(path, {traverse}) {
+            traverse(path.get('left'));
+        },
+    },
+});
+```
+
+This is the same as `print('__left')` but more low-level, and supports only objects.
+
+## Speed Comparison
+
+About speed, for file `speed.js`:
+
+```js
+const {readFileSync} = require('fs');
+
+const putout = require('putout');
+const parser = require('@babel/parser');
+
+const code = readFileSync('./lib/tokenize/tokenize.js', 'utf8');
+const ast = parser.parse(code);
+
+speed('recast');
+speed('putout');
+
+function speed(printer) {
+    console.time(printer);
+    
+    for (let i = 0; i < 1000; i++) {
+        putout(code, {
+            printer,
+            plugins: ['remove-unused-variables'],
+        });
+    }
+    
+    console.timeEnd(printer);
+}
+```
+
+With contents of [`tokenize.js`](https://github.com/putoutjs/printer/blob/v1.69.1/lib/tokenize/tokenize.js), we have:
+
+![image](https://user-images.githubusercontent.com/1573141/234004942-8f890da3-a145-425f-9040-25924dcfba7b.png)
+
+## License
+
+MIT

package/bin/redlint.js

@@ -0,0 +1,8 @@
+import process from 'node:process';
+import {writeFile} from 'node:fs/promises';
+import {buildTree} from '../lib/redlint.js';
+
+const result = await buildTree(process.cwd());
+const filesystem = JSON.stringify(result, null, 4) + '\n';
+
+await writeFile('.filesystem.json', filesystem);

package/lib/redlint.js

@@ -0,0 +1,58 @@
+import { opendir } from 'node:fs/promises';
+import {relative} from 'node:path';
+import fastGlob from 'fast-glob';
+
+const ignore = [
+    'node_modules',
+    'coverage',
+    '.git',
+    '.idea',
+    'fixture',
+];
+
+export const buildTree = async (filename) => {
+    return {
+        type: 'directory',
+        filename,
+        files: await walk(filename)
+    };
+};
+
+async function walk(cwd, files = []) {
+    const dir = await opendir(cwd);
+    
+    for await (const dirent of dir) {
+        const {path, name} = dirent;
+        
+        if (isIgnored(name))
+            continue;
+        
+        const filename = `${path}/${name}`;
+        
+        if (dirent.isDirectory()) {
+            debugger;
+            files.push({
+                type: 'directory',
+                filename,
+                files: await walk(filename),
+            });
+            continue;
+        }
+        
+        files.push({
+            type: 'file',
+            filename,
+        });
+    }
+    
+    return files;
+}
+
+function isIgnored(name) {
+    for (const current of ignore) {
+        if (RegExp(current).test(name))
+            return true;
+    }
+    
+    return false;
+}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "redlint",
+  "version": "1.0.0",
+  "type": "module",
+  "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
+  "description": "Lint Filesystem with 🐊Putout",
+  "homepage": "https://github.com/putoutjs/redlint#readme",
+  "main": "./lib/redlint.js",
+  "exports": {
+    ".": "./lib/redlint.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/putoutjs/redlint.git"
+  },
+  "scripts": {
+    "wisdom": "madrun wisdom",
+    "test": "madrun test",
+    "test:dts": "madrun test:dts",
+    "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",
+    "coverage:html": "madrun coverage:html",
+    "report": "madrun report"
+  },
+  "dependencies": {
+    "@putout/babel": "^1.1.1",
+    "@putout/compare": "^13.0.0",
+    "@putout/operate": "^11.0.0",
+    "@putout/processor-json": "^7.0.0",
+    "fullstore": "^3.0.0",
+    "just-snake-case": "^3.2.0",
+    "parse-import-specifiers": "^1.0.1",
+    "rendy": "^4.0.0"
+  },
+  "keywords": [
+    "putout",
+    "redlint",
+    "AST",
+    "babel",
+    "api",
+    "traverse",
+    "generate"
+  ],
+  "devDependencies": {
+    "@babel/plugin-codemod-object-assign-to-object-spread": "^7.10.4",
+    "@putout/plugin-minify": "^5.0.0",
+    "@putout/plugin-redlint": "^3.0.0",
+    "@putout/plugin-promises": "^13.0.0",
+    "@putout/plugin-react-hook-form": "^4.0.0",
+    "@putout/plugin-react-hooks": "^5.0.0",
+    "acorn": "^8.8.2",
+    "c8": "^8.0.0",
+    "check-dts": "^0.7.2",
+    "escover": "^3.0.0",
+    "eslint": "^8.0.1",
+    "eslint-plugin-n": "^16.0.0",
+    "eslint-plugin-putout": "^21.0.1",
+    "estree-to-babel": "^8.0.0",
+    "just-kebab-case": "^4.2.0",
+    "madrun": "^9.0.0",
+    "mock-require": "^3.0.3",
+    "montag": "^1.0.0",
+    "nodemon": "^3.0.1",
+    "putout": "^32.0.4",
+    "supertape": "^8.0.0",
+    "try-catch": "^3.0.0"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=16"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}