Expose lower-level AST functions

Author: appgurueu

Diff for: Readme.md

@@ -28,7 +28,36 @@ npm install @appguru/luafmt
 And import it like this:
 
 ```javascript
-const { formatChunk, formatter } = require("@appguru/luafmt");
+const { ast, formatChunk, formatter } = require("@appguru/luafmt")
+```
+
+#### `ast`
+
+Abstract syntax tree methods.
+
+##### `fixRanges`
+
+Makes luaparse ranges be from `if` to `end` and not from `if` to `then` for all IfClauses of the AST.
+
+##### `insertComments(chunk)`
+
+Inserts comments into the top-level abstract syntax tree provided by luaparse.
+
+##### `formatter(conf)`
+
+Provides a formatter which returns a function `format(ast, [indent])` taking a luaparse AST & optionally the base indentation as number.
+Note that you have to call [`fixRanges`] and [`insertComments`] on the AST yourself before using it:
+
+```javascript
+const { ast } = require("@appguru/luafmt")
+const { parse } = require("luaparse") 
+const srcAST = parse(`-- hello world
+if true then print'hello world!'
+else _ = _ end`)
+const formatter = ast.formatter()
+ast.fixRanges(srcAST)
+ast.insertComments(srcAST)
+console.log(formatter(srcAST))
 ```
 
 #### `formatChunk(text)`
@@ -101,4 +130,6 @@ const configuredFormatChunk = formatter({
   * Fixed (removed) trailing commas after fields followed by comments
   * Fixed (removed) obsolete (possibly invalid) bracketing (precedencies)
 * `v1.4.3`
-  * Tweaked: Obsolete brackets are omitted in the case of concatenation, but not for exponentation
+  * Tweaked: Obsolete brackets are omitted in the case of concatenation, but not for exponentation
+* `v1.5.0`
+  * Exposed AST-functions `fixRanges` & `insertComments` as well as lower-level AST formatter

Diff for: index.js

@@ -199,7 +199,11 @@ const formatter = conf => {
 		let left_pp = prettyPrint(left, indent)
 		let right_pp = prettyPrint(right, indent)
 		if (isBinaryExpression(left) && precedency[left.operator] < op_precedency) left_pp = "(" + left_pp + ")"
-		if (isBinaryExpression(right) && precedency[right.operator] < op_precedency || (right.operator !== ".." && precedency[right.operator] == op_precedency)) right_pp = "(" + right_pp + ")"
+		if (
+			(isBinaryExpression(right) && precedency[right.operator] < op_precedency) ||
+			(right.operator !== ".." && precedency[right.operator] == op_precedency)
+		)
+			right_pp = "(" + right_pp + ")"
 		return left_pp + " " + operator + " " + right_pp
 	}
 
@@ -322,7 +326,7 @@ const formatter = conf => {
 			const end_spacing = inline ? " " : indentationNewline(indent - 1)
 			let table = [end_spacing + "}"]
 			let beforeField = false
-			for (let i = length -1; i > -1; i--) {
+			for (let i = length - 1; i > -1; i--) {
 				const field = node.fields[i]
 				const isField = field.type !== "Comment"
 				if (beforeField && isField) {
@@ -389,15 +393,23 @@ const formatter = conf => {
 		return nodeFormatter(node, indent)
 	}
 
+	return prettyPrint
+}
+
+const astFormatter = conf => (ast, indent) => formatter(conf)(ast, indent === undefined ? 0 : indent)
+
+const textFormatter = conf => {
+	const formatter = astFormatter(conf)
 	return text => {
 		const ast = parse(text)
 		fixRanges(ast)
 		insertComments(ast)
-		return prettyPrint(ast, 0)
+		return formatter(ast)
 	}
 }
 
 module.exports = {
-	formatChunk: formatter(),
-	formatter
+	ast: { fixRanges, insertComments, formatter: astFormatter },
+	formatChunk: textFormatter(),
+	formatter: textFormatter
 }

Diff for: package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appguru/luafmt",
-  "version": "1.4.3",
+  "version": "1.5.0",
   "esversion": 6,
   "description": "A small Lua formatter / pretty printer",
   "main": "./index.js",