npm-groovy-lint/lib/rules/BracesForMethod.js

Lint, format and auto-fix your Groovy / Jenkinsfile / Gradle files

// Braces for method

import { moveOpeningBracket, findRangeBetweenStrings, getVariable } from "../utils.js";

const rule = {
    scope: "file",
    unitary: true,
    variables: [
        {
            name: "METHOD_NAME",
            regex: /Opening brace for the method (.*) should start on the same line/,
        },
    ],
    range: {
        type: "function",
        func: (_errLine, errItem, evaluatedVars, allLines) => {
            const methodName = getVariable(evaluatedVars, "METHOD_NAME", { mandatory: true });
            return findRangeBetweenStrings(allLines, errItem, methodName, "{");
        },
    },
    fix: {
        label: "Move opening brace on the same line",
        type: "function",
        func: (allLines, variables) => {
            return moveOpeningBracket(allLines, variables);
        },
    },
    tests: [
        {
            sourceBefore: `
def someMethodName (String toto)
{
    def a = 1
}
`,
            sourceAfter: `
def someMethodName (String toto) {
    def a = 1
}
`,
        },
        {
            sourceBefore: `
def someMethodName (String toto)
{    def a = 1
}
`,
            sourceAfter: `
def someMethodName (String toto) {
    def a = 1
}
`,
        },
        {
            sourceBefore: `
class VersionHandler implements Serializable {

    /**
     * Gets a list of versions from the changelog
     *
     * @return List
     */
    List changelogVersions(String changelog='CHANGELOG.md')
    {
        changelog = context.readFile "\${changelog}"
        def versions = getVersionsFromChangeLog(changelog)
        return this.sort(versions)
    }

}
`,
            sourceAfter: `
class VersionHandler implements Serializable {

    /**
     * Gets a list of versions from the changelog
     *
     * @return List
     */
    List changelogVersions(String changelog='CHANGELOG.md') {
        changelog = context.readFile "\${changelog}"
        def versions = getVersionsFromChangeLog(changelog)
        return this.sort(versions)
    }

}
`,
        } /*
        NV: Disable fix while not detected by CodeNarc
        ,
        {
            sourceBefore: `
def someMethodName (String toto,
                    String tata,
                    String tutu )
{   
    def a = 1
}
`,
            sourceAfter: `
def someMethodName (String toto,
                    String tata,
                    String tutu ) {   
    def a = 1
}
`
        } */,
    ],
};

export { rule };