joycollector / groovy-beautify Goto Github PK

View Code? Open in Web Editor NEW

9.0 1.0 5.0 886 KB

A simple beautifier which allows formatting and indenting Groovy scripts

License: MIT License

JavaScript 4.45% TypeScript 95.55%

groovy-beautify's Introduction

groovy-beautify

A simple zero-dependency beautifier which allows formatting and indenting Groovy scripts

Demo

You can test how it works on the Demo Website

Installation

npm install groovy-beautify

Usage

import groovyBeautify from "groovy-beautify";

const groovy = `
    def bumpVersion(String target,    String version_type, Boolean reset =   false) {    def
    versionMap =
    ['major':0, 'minor' : 1, 'patch':   2]
                def versionArray = target.findAll(/\d+\.\d+\.\d+/)[0].tokenize('.')
            try
    {        def   index =     versionMap.get(version_type);
    versionArray[index] =versionArray[index].toInteger() + 1
    if(   reset )
    {
        for(int i=2;i>index;     i--) {
            versionArray[i]    =    0            }        }
    } catch(       Exception e) {        println("Unrecognized version type \\"version_type\\" (should be major, minor or patch)")    }
    return             versionArray.join(                   '.'                       )
    }
    println(bumpVersion('1.2.3', 'minor', true))
`;

const formatted = groovyBeautify(groovy);

This will produce the following output

def bumpVersion(String target, String version_type, Boolean reset = false) {
    def versionMap = ['major': 0, 'minor': 1, 'patch': 2]
    def versionArray = target.findAll(/d+.d+.d+/)[0].tokenize('.')
    try {
        def index = versionMap.get(version_type);
        versionArray[index] = versionArray[index].toInteger() + 1
        if (reset)
        {
            for (int i = 2; i > index; i--) {
                versionArray[i] = 0
            }
        }
    } catch (Exception e) {
        println("Unrecognized version type \"version_type\" (should be major, minor or patch)")
    }
    return versionArray.join('.')
}

println(bumpVersion('1.2.3', 'minor', true))

License

You are free to use this in any way you want, in case you find this useful or working for you but you must keep the copyright notice and license. (MIT)

Credits

Created by Sergei Kasoverskij, [email protected]

groovy-beautify's People

Contributors

Stargazers

Watchers

Forkers

ekeel jinly2 aseara mediatech15 oleksiismerdov

groovy-beautify's Issues

Option to print closure parameters on single line

First of all, thank you for open sourcing this library, it could be a great help for us!

Given code like:

[].each { item ->
println item
}

It would be nice to format it as:

[].each { item ->
    println item
}

Right now, the closure parameters are moved down a line by default:

[].each {
    item -> println item
}

Format string as single-quote unless it contains an interpolation expression

For example: String myVar = "my text" could be formatted to String myVar = 'my text', but String myVar = "my ${anotherVar}" not.

PS: Groovy Lint has this feature.

Cannot find module '../parser/types' or its corresponding type declarations.

After install npm install groovy-beautify dependency is added successfully but getting this error when using the beautify

Not equals operator is not properly formatted

Example
a != b produces a ! = b

Improve if/for/while expressions formatting

if (true)
    test()

produces

if (true)
test()

Keywords are not properly formatted when used as methods

When it needs to use a keyword as a method, such as .with(), the script encloses it in whitespace and the code next to the keyword in curly braces.

LocalDate
    .parse("2018-12-06")
    .with(Month.MARCH)
    .with(TemporalAdjusters.lastDayOfMonth())