@putout/printer 1.3.1 → 1.4.1

package/ChangeLog

@@ -0,0 +1,15 @@
+2023.03.17, v1.4.1
+
+feature:
+- 1948ce5 @putout/printer: improve support of ObjectExpression
+- 09e1a5c @putout/printer: improve support of ObjectExpression
+- 2d13bc2 @putout/printer: ArrayExpression: newlines
+- 9fc6a00 @putout/printer: improve support of ArrayExpression
+- b91d908 @putout/printer: UnaryExpression: add support of delete
+- 337492b @putout/printer: improve support of NumericLiteral
+- 166085c @putout/printer: add support of hex numbers
+
+2023.03.17, v1.4.0
+
+feature:
+- 1faf3ff @putout/printer: add support of leadingComments

package/README.md

@@ -3,7 +3,7 @@
 [NPMIMGURL]: https://img.shields.io/npm/v/@putout/printer.svg?style=flat&longCache=true
 [NPMURL]: https://npmjs.org/package/@putout/printer "npm"
 
-**EasyPrint** prints [**Babel AST**](https://github.com/coderaiser/estree-to-babel) to readable **JavaScript**.
+**@putout/printer** prints [**Babel AST**](https://github.com/coderaiser/estree-to-babel) to readable **JavaScript**.
 
 - ☝️ Similar to **Recast**, but 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**.

package/lib/tokenize/comments.js

@@ -0,0 +1,17 @@
+'use strict';
+
+module.exports.parseComments = (path, {write}) => {
+    const {leadingComments} = path.node;
+    
+    if (leadingComments)
+        parseLeadingComments(path, {write});
+};
+
+function parseLeadingComments(path, {write}) {
+    const {leadingComments} = path.node;
+    
+    for (const {value}of leadingComments) {
+        write(`//${value}`);
+        write.newline();
+    }
+}

package/lib/tokenize/expressions/array-expression.js

@@ -1,16 +1,17 @@
 'use strict';
 
+const {isObjectProperty} = require('@babel/types');
 const {entries} = Object;
 const isForOf = ({parentPath}) => parentPath.isForOfStatement();
 
-module.exports.ArrayExpression = (path, {write, indent, maybe, traverse}) => {
-    write('[');
-    
+module.exports.ArrayExpression = (path, {write, maybe, traverse}) => {
     const elements = path.get('elements');
+    const elementIsObject = isElementObject(path);
     
-    indent.inc();
+    write('[');
+    maybe.indent.inc(!elementIsObject);
     
-    const isNewLine = !isNumbers(elements) && !isForOf(path);
+    const isNewLine = !isNumbers(elements) && !isForOf(path) && isLastArg(path) && !isParentProperty(path);
     const n = elements.length - 1;
     
     maybe.write(isNewLine && elements.length, '\n');
@@ -24,8 +25,7 @@ module.exports.ArrayExpression = (path, {write, indent, maybe, traverse}) => {
         maybe.write(!isNewLine && index < n, ', ');
     }
     
-    indent.dec();
-    
+    maybe.indent.dec(!elementIsObject);
     maybe.indent(elements.length && isNewLine);
     
     write(']');
@@ -40,3 +40,27 @@ function isNumbers(elements) {
     return false;
 }
 
+function isLastArg(path) {
+    const {parentPath} = path;
+    
+    if (!parentPath.isCallExpression())
+        return true;
+    
+    const args = parentPath.get('arguments');
+    const n = args.length - 1;
+    
+    return path === args[n];
+}
+
+function isParentProperty(path) {
+    return path.find(isObjectProperty);
+}
+
+function isElementObject(path) {
+    const elements = path.get('elements');
+    
+    if (!elements.length)
+        return false;
+    
+    return elements[0].isObjectExpression();
+}

package/lib/tokenize/expressions/array-pattern.js

@@ -9,6 +9,7 @@ module.exports.ArrayPattern = (path, {write, indent, maybe, traverse}) => {
     const elements = path.get('elements');
     
     indent.inc();
+    
     const isNewLine = !isForOf(path) && elements.length > 2;
     const n = elements.length - 1;
     

package/lib/tokenize/expressions/call-expression.js

@@ -1,16 +1,17 @@
 'use strict';
 
-const {hasPrevNewline, isMarkedParent} = require('../mark');
+const {
+    isMarkedParentBefore,
+    isMarkedPrevAfter,
+} = require('../mark');
 
 const {entries} = Object;
 
 module.exports.CallExpression = (path, {traverse, indent, write, incIndent, decIndent, maybeWrite}) => {
     const isParentCall = toLong(path) && path.parentPath.isCallExpression();
     
-    if (shouldAddNewLine(path) && !hasPrevNewline(path.parentPath) && !isMarkedParent(path)) {
-        write.newline();
-        write.indent();
-    }
+    if (shouldAddNewLine(path) && !isMarkedParentBefore(path) && !isMarkedPrevAfter(path.parentPath))
+        write.linebreak();
     
     traverse(path.get('callee'));
     write('(');

package/lib/tokenize/expressions/functions.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const {isMarkedPrevAfter} = require('../mark');
 const isFirst = (path) => path.node === path.parentPath.node.body[0];
 
 module.exports.ArrowFunctionExpression = (path, {write, traverse}) => {
@@ -38,7 +39,7 @@ module.exports.ObjectMethod = (path, {write, traverse}) => {
 };
 
 module.exports.FunctionDeclaration = (path, {write, traverse}) => {
-    if (!isFirst(path))
+    if (!isFirst(path) && !isMarkedPrevAfter(path))
         write('\n');
     
     write('function ');

package/lib/tokenize/expressions/index.js

@@ -13,8 +13,8 @@ const {AssignmentExpression} = require('./assignment-expression');
 const {ArrayExpression} = require('./array-expression');
 const {ArrayPattern} = require('./array-pattern');
 const {AssignmentPattern} = require('./assignment-pattern');
-const {RestElement} = require('./RestElement');
-const {SpreadElement} = require('./SpreadElement');
+const {RestElement} = require('./rest-element');
+const {SpreadElement} = require('./spread-element');
 
 module.exports = {
     ...functions,

package/lib/tokenize/expressions/object-expression.js

@@ -1,36 +1,33 @@
 'use strict';
 
+const {isCoupleLines} = require('../is');
 const isBodyOfArrow = (path) => path.parentPath.node.body === path.node;
 const isForOf = (path) => {
     if (path.parentPath.isForOfStatement())
         return true;
     
-    if (path.parentPath?.parentPath?.isForOfStatement())
-        return true;
-    
-    return false;
+    return path.parentPath?.parentPath?.isForOfStatement();
 };
 
 module.exports.ObjectExpression = (path, {traverse, write, maybe, indent}) => {
     indent.inc();
     
     const properties = path.get('properties');
-    const parens = isBodyOfArrow(path);
-    const isCall = path.parentPath.isCallExpression();
     const {length} = properties;
-    const isOneLine = !length || (isCall && length < 2 || isForOf(path));
+    const parens = isBodyOfArrow(path);
+    const manyLines = !isOneLine(path);
     
     maybe.write(parens, '(');
     write('{');
     
-    maybe.write(!isOneLine, '\n');
+    maybe.write(manyLines, '\n');
     
     for (const property of properties) {
         if (property.isSpreadElement()) {
-            maybe.indent(properties.length > 1);
+            maybe.indent(length > 1);
             traverse(property);
             
-            if (properties.length > 1) {
+            if (length > 1) {
                 write(',');
                 write.newline();
             }
@@ -40,7 +37,7 @@ module.exports.ObjectExpression = (path, {traverse, write, maybe, indent}) => {
         
         const {shorthand, computed} = property.node;
         
-        maybe.indent(!isOneLine);
+        maybe.indent(manyLines);
         
         if (property.isObjectMethod()) {
             traverse(property);
@@ -56,11 +53,27 @@ module.exports.ObjectExpression = (path, {traverse, write, maybe, indent}) => {
             traverse(property.get('value'));
         }
         
-        maybe.write(!isOneLine, ',\n');
+        maybe.write(manyLines, ',\n');
     }
     
     indent.dec();
-    maybe.indent(!isOneLine);
+    
+    maybe.indent(manyLines);
     write('}');
     maybe.write(parens, ')');
 };
+function isOneLine(path) {
+    const isCall = path.parentPath.isCallExpression();
+    const {length} = path.get('properties');
+    
+    if (isCoupleLines(path))
+        return false;
+    
+    if (!length)
+        return true;
+    
+    if (isCall && length < 2)
+        return true;
+    
+    return isForOf(path);
+}

package/lib/tokenize/expressions/unary-expressions.js

@@ -3,12 +3,15 @@
 module.exports.UnaryExpression = unaryExpressions;
 module.exports.UpdateExpression = unaryExpressions;
 
-function unaryExpressions(path, {traverse, write}) {
+const isWord = (a) => /delete|typeof/.test(a);
+
+function unaryExpressions(path, {traverse, write, maybe}) {
     const {prefix, operator} = path.node;
     
     if (prefix)
         write(operator);
     
+    maybe.write(isWord(operator), ' ');
     traverse(path.get('argument'));
     
     if (!prefix)

package/lib/tokenize/is.js

@@ -1,4 +1,11 @@
 'use strict';
 
+module.exports.isFirst = (path) => path.node === path.parentPath.node.body[0];
 module.exports.isPrevBody = (path) => path.getPrevSibling().isBlockStatement();
 module.exports.isNext = (path) => path.getNextSibling().node;
+module.exports.isCoupleLines = (path) => {
+    const start = path.node?.loc?.start.line;
+    const end = path.node?.loc?.end.line;
+    
+    return end > start;
+};

package/lib/tokenize/literals/index.js

@@ -5,7 +5,8 @@ const {TemplateLiteral} = require('./template-literal');
 module.exports = {
     TemplateLiteral,
     NumericLiteral(path, {write}) {
-        write(path.node.value);
+        const {extra, raw} = path.node;
+        write(raw || extra.raw);
     },
     BooleanLiteral(path, {write}) {
         write(path.node.value);

package/lib/tokenize/mark.js

@@ -1,25 +1,40 @@
 'use strict';
 
-const WATER_MARK = '__putout_newline';
+const WATER_MARK_BEFORE = '__putout_newline_before';
+const WATER_MARK_AFTER = '__putout_newline_after';
 
-module.exports.mark = mark;
+module.exports.markBefore = markBefore;
+module.exports.markAfter = markAfter;
 
-function mark(path) {
-    path[WATER_MARK] = true;
+function markBefore(path) {
+    path[WATER_MARK_BEFORE] = true;
 }
 
-module.exports.isMarked = isMarked;
+function markAfter(path) {
+    path[WATER_MARK_AFTER] = true;
+}
+
+module.exports.isMarkedBefore = isMarkedBefore;
+module.exports.isMarkedAfter = isMarkedAfter;
+
+function isMarkedBefore(path) {
+    return path[WATER_MARK_BEFORE];
+}
 
-function isMarked(path) {
-    return path[WATER_MARK];
+function isMarkedAfter(path) {
+    return path[WATER_MARK_AFTER];
 }
 
 module.exports.hasPrevNewline = (path) => {
-    return isMarked(path.getPrevSibling());
+    return isMarkedAfter(path.getPrevSibling());
 };
 
-module.exports.maybeMark = (a, path) => a && mark(path);
+module.exports.maybeMarkAfter = (a, path) => a && markAfter(path);
+
+module.exports.isMarkedParentBefore = (path) => {
+    return isMarkedBefore(path.parentPath);
+};
 
-module.exports.isMarkedParent = (path) => {
-    return isMarked(path.parentPath);
+module.exports.isMarkedPrevAfter = (path) => {
+    return isMarkedAfter(path.getPrevSibling());
 };

package/lib/tokenize/statements/expression-statement.js

@@ -1,10 +1,16 @@
 'use strict';
 
-const {mark} = require('../mark');
+const {
+    markBefore,
+    markAfter,
+    isMarkedPrevAfter,
+} = require('../mark');
+const {isNext} = require('../is');
+
 module.exports.ExpressionStatement = (path, {write, indent, traverse}) => {
-    if (isCoupleLinesExpression(path) && !isFirst(path) && shouldAddNewLine(path)) {
+    if (isCoupleLinesExpression(path) && !isFirst(path) && shouldAddNewLine(path) && !isMarkedPrevAfter(path)) {
         write.linebreak();
-        mark(path);
+        markBefore(path);
     }
     
     const expressionPath = path.get('expression');
@@ -14,8 +20,10 @@ module.exports.ExpressionStatement = (path, {write, indent, traverse}) => {
     write(';');
     write.newline();
     
-    if (isStrictMode(path))
+    if (isStrictMode(path) || isCoupleLinesExpression(path) && isNext(path)) {
         write.newline();
+        markAfter(path);
+    }
 };
 
 function isCoupleLinesExpression(path) {

package/lib/tokenize/statements/for-of-statement.js

@@ -1,17 +1,10 @@
 'use strict';
 
-const {isMarked} = require('../mark');
-const isPrevNewLine = (path) => {
-    const prev = path.getPrevSibling();
-    
-    if (!prev.node)
-        return true;
-    
-    return isMarked(prev);
-};
+const {isMarkedPrevAfter} = require('../mark');
+const {isFirst} = require('../is');
 
 module.exports.ForOfStatement = (path, {write, indent, traverse}) => {
-    if (!isPrevNewLine(path)) {
+    if (!isFirst(path) && !isMarkedPrevAfter(path)) {
         write.indent();
         write.newline();
     }

package/lib/tokenize/statements/if-statement.js

@@ -1,6 +1,7 @@
 'use strict';
 
 const {hasPrevNewline} = require('../mark');
+const {isFirst} = require('../is');
 
 module.exports.IfStatement = (path, {write, indent, traverse, incIndent, decIndent}) => {
     if (!isFirst(path) && !hasPrevNewline(path)) {
@@ -36,7 +37,3 @@ module.exports.IfStatement = (path, {write, indent, traverse, incIndent, decInde
     write('\n');
 };
 
-function isFirst(path) {
-    return path.node === path.parentPath.node.body[0];
-}
-

package/lib/tokenize/statements/variable-declaration.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const {isNext} = require('../is');
+const {isNext, isCoupleLines} = require('../is');
 const isNextAssign = (path) => {
     const nextPath = path.getNextSibling();
     
@@ -27,21 +27,25 @@ module.exports.VariableDeclaration = (path, {write, maybe, maybeIndent, traverse
     traverse(initPath);
     maybe.write(isParentBlock, ';\n');
     
-    const is = isNext(path) && isCoupleLinesExpression(path) && !isNextAssign(path);
+    const is = isNext(path) && isCoupleLines(path) && !isNextAssign(path);
     
     maybe.indent(is);
     maybe.write(is, '\n');
-    maybe.mark(is, path);
+    maybe.markAfter(is, path);
 };
-function isCoupleLinesExpression(path) {
-    const start = path.node?.loc?.start.line;
-    const end = path.node?.loc?.end.line;
-    
-    return end > start;
-}
 
 function shouldAddNewLine(path) {
     const prevPath = path.getPrevSibling();
+    
+    if (prevPath.isStatement() && !prevPath.isExpressionStatement() && !prevPath.isBlockStatement())
+        return false;
+    
+    if (prevPath.isExpressionStatement() && prevPath.get('expression').isStringLiteral())
+        return false;
+    
+    if (isCoupleLines(path))
+        return true;
+    
     const nextPath = path.getNextSibling();
     const nextNextPath = nextPath.getNextSibling();
     
@@ -50,12 +54,6 @@ function shouldAddNewLine(path) {
     if (!twoNext)
         return false;
     
-    if (prevPath.isVariableDeclaration() || prevPath.isExpressionStatement() && prevPath.get('expression').isStringLiteral())
-        return false;
-    
-    if (prevPath.isIfStatement())
-        return false;
-    
     return true;
 }
 

package/lib/tokenize/tokenize.js

@@ -6,7 +6,11 @@ const statements = require('./statements');
 const literals = require('./literals');
 const {TYPES} = require('../types');
 const {createDebug} = require('./debug');
-const {maybeMark} = require('./mark');
+const {
+    maybeMarkAfter,
+    maybeMarkBefore,
+} = require('./mark');
+const {parseComments} = require('./comments');
 
 const {assign} = Object;
 
@@ -28,11 +32,12 @@ module.exports.tokenize = (ast) => {
     
     const maybeWrite = (a, b) => a && write(b);
     const maybeIndent = (a) => a && indent();
+    const maybeIndentInc = (a) => a && indent.inc();
+    const maybeIndentDec = (a) => a && indent.dec();
     
     let i = 0;
     const incIndent = () => ++i;
     const decIndent = () => --i;
-    
     const indent = () => {
         tokens.push({
             type: TYPES.INDENT,
@@ -68,9 +73,15 @@ module.exports.tokenize = (ast) => {
     const maybe = {
         write: maybeWrite,
         indent: maybeIndent,
-        mark: maybeMark,
+        markBefore: maybeMarkBefore,
+        markAfter: maybeMarkAfter,
     };
     
+    assign(maybe.indent, {
+        inc: maybeIndentInc,
+        dec: maybeIndentDec,
+    });
+    
     const printer = {
         incIndent,
         decIndent,
@@ -101,6 +112,7 @@ module.exports.tokenize = (ast) => {
         if (!currentTraverse)
             throw Error(`Node type '${type}' is not supported yet: '${path}'`);
         
+        parseComments(path, printer);
         currentTraverse(path, printer);
         debug(path.type);
     }

package/package.json

@@ -1,14 +1,11 @@
 {
   "name": "@putout/printer",
-  "version": "1.3.1",
+  "version": "1.4.1",
   "type": "commonjs",
   "author": "coderaiser <mnemonic.enemy@gmail.com> (https://github.com/coderaiser)",
   "description": "Easiest possible opinionated Babel AST printer made with ❤️  to use in 🐊Putout",
   "homepage": "https://github.com/putoutjs/printer#readme",
   "main": "./lib/printer.js",
-  "release": false,
-  "tag": false,
-  "changelog": false,
   "exports": {
     ".": "./lib/printer.js"
   },
@@ -25,11 +22,13 @@
     "lint:fresh": "madrun lint:fresh",
     "fix:lint": "madrun fix:lint",
     "coverage": "madrun coverage",
+    "coverage:html": "madrun coverage:html",
     "report": "madrun report"
   },
   "dependencies": {
     "@babel/parser": "^7.19.0",
     "@babel/traverse": "^7.21.2",
+    "@babel/types": "^7.21.3",
     "just-snake-case": "^3.2.0"
   },
   "keywords": [
@@ -46,6 +45,7 @@
     "eslint": "^8.0.1",
     "eslint-plugin-n": "^15.2.4",
     "eslint-plugin-putout": "^17.0.0",
+    "estree-to-babel": "^5.0.1",
     "just-kebab-case": "^4.2.0",
     "lerna": "^6.0.1",
     "madrun": "^9.0.0",