redlint 1.0.0 → 1.0.2

package/ChangeLog

@@ -0,0 +1,11 @@
+2023.11.05, v1.0.2
+
+feature:
+- dfc4a49 redlint: putout v32.15.1
+- f3ac849 redlint: ignore
+
+2023.11.05, v1.0.1
+
+fix:
+- 5b8a3bd lint
+- 4cbe917 docs

package/README.md

@@ -1,7 +1,7 @@
-# Printer [![License][LicenseIMGURL]][LicenseURL] [![NPM version][NPMIMGURL]][NPMURL] [![Build Status][BuildStatusIMGURL]][BuildStatusURL] [![Coverage Status][CoverageIMGURL]][CoverageURL]
+# Redlint [![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
+[NPMURL]: https://npmjs.org/package/redlint "npm"
+[NPMIMGURL]: https://img.shields.io/npm/v/redlint.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"
@@ -9,318 +9,20 @@
 [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);
+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.
 
 ## Install
 
 ```
-npm i @putout/printer
+npm i redlint -g
 ```
 
-## 🐊 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:
+## Usage Example
 
 ```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');
-        },
-    },
-});
+redlint
 ```
 
-### `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

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

package/lib/redlint.js

@@ -1,8 +1,9 @@
-import { opendir } from 'node:fs/promises';
-import {relative} from 'node:path';
-import fastGlob from 'fast-glob';
+import ignore from 'ignore';
+import {opendir} from 'node:fs/promises';
 
-const ignore = [
+const resolveName = (name, cwd) => name.replace(`${cwd}/`, '');
+
+const ignoreList = [
     'node_modules',
     'coverage',
     '.git',
@@ -10,31 +11,28 @@ const ignore = [
     'fixture',
 ];
 
-export const buildTree = async (filename) => {
-    return {
-        type: 'directory',
-        filename,
-        files: await walk(filename)
-    };
-};
+const ig = ignore().add(ignoreList);
 
-async function walk(cwd, files = []) {
-    const dir = await opendir(cwd);
-    
-    for await (const dirent of dir) {
+export const buildTree = async (cwd) => ({
+    type: 'directory',
+    filename: cwd,
+    files: await walk(cwd, cwd),
+});
+
+async function walk(cwd, dir, files = []) {
+    for await (const dirent of await opendir(dir)) {
         const {path, name} = dirent;
+        const filename = `${path}/${name}`;
+        const resolved = resolveName(filename, cwd);
         
-        if (isIgnored(name))
+        if (resolved && ig.ignores(resolved))
             continue;
         
-        const filename = `${path}/${name}`;
-        
         if (dirent.isDirectory()) {
-            debugger;
             files.push({
                 type: 'directory',
                 filename,
-                files: await walk(filename),
+                files: await walk(cwd, filename),
             });
             continue;
         }
@@ -47,12 +45,3 @@ async function walk(cwd, files = []) {
     
     return files;
 }
-
-function isIgnored(name) {
-    for (const current of ignore) {
-        if (RegExp(current).test(name))
-            return true;
-    }
-    
-    return false;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redlint",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Lint Filesystem with 🐊Putout",
@@ -27,14 +27,8 @@
     "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"
+    "ignore": "^5.2.4",
+    "putout": "^32.15.1"
   },
   "keywords": [
     "putout",
@@ -46,16 +40,7 @@
     "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",
@@ -65,7 +50,6 @@
     "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"
   },