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

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

// Indentation
// Warning CodeNarc does not like tabs, better replace them by spaces ...

import { getVariable } from "../utils.js";

const rule = {
    triggers: ["IndentationClosingBraces", "IndentationComments"],

    variables: [
        {
            name: "EXPECTED",
            regex: /The (.*) is at the incorrect indent level: Expected column (.*) but was (.*)/,
            regexPos: 2,
            type: "number",
        },
        {
            name: "EXPECTED_LIST",
            regex: /The (.*) is at the incorrect indent level: Expected one of columns (.*) but was (.*)/,
            regexPos: 2,
            type: "array",
        },
        {
            name: "EXPECTED_LIST_CHAINING",
            regex: /The (.*) is at the incorrect indent level: Depending on your chaining style, expected one of (.*) or one of (.*) columns, but was (.*)/,
            regexPos: 2,
            type: "array",
        },
        {
            name: "FOUND",
            regex: /The (.*) is at the incorrect indent level: Expected column (.*) but was (.*)/,
            regexPos: 3,
            type: "number",
        },
    ],
    range: {
        type: "function",
        func: (errLine, errItem, evaluatedVars) => {
            return {
                start: { line: errItem.line, character: 0 },
                end: { line: errItem.line, character: getVariable(evaluatedVars, "FOUND") - 1 },
            };
        },
    },
    fix: {
        label: "Correct Indentation",
        type: "function",
        func: (line, evaluatedVars) => {
            let expected = parseInt(getVariable(evaluatedVars, "EXPECTED", { mandatory: false, line: line }), 10);
            if (expected == null || isNaN(expected)) {
                expected = parseInt((getVariable(evaluatedVars, "EXPECTED_LIST", { mandatory: false, line: line }) || [null])[0], 10);
            }
            if (expected == null || isNaN(expected)) {
                expected = parseInt((getVariable(evaluatedVars, "EXPECTED_LIST_CHAINING", { mandatory: false, line: line }) || [null])[0], 10);
            }
            const startSpaces = expected === 0 ? 0 : expected - 1;
            line = " ".repeat(startSpaces) + line.trimStart();
            return line;
        },
    },
    tests: [
        {
            sourceBefore: `
if (a == 2){
x = 1
}`,
            sourceAfter: `
if (a == 2){
    x = 1
}`,
        },
        {
            sourceBefore: `
docker.withRegistry("https://"+ envVars.GetDockerRegistry(), envVars.GetDockerRegistryCredsId()) {
  docker.image(envVars.GetFullImageName()).inside("--entrypoint=''") {
  withCredentials(credentials) {
            if (deploy == 'yes'){
                // Send start build notification
                if( it.config.containsKey("notifChannelCredsId")) {
                    p.k8sStage("\${it.config['name']} - Send notification",it, {
                        withCredentials([string(credentialsId: it.config['notifChannelCredsId'], variable: 'TEAMS_WEBHOOK')]) {
                                 office365ConnectorSend message : "\${env.JOB_BASE_NAME}", status :"Started", webhookUrl: "\${env.TEAMS_WEBHOOK}"
                        }
                                             })
                }
                            }
        }
             }
}
`,
            sourceAfter: `
docker.withRegistry("https://"+ envVars.GetDockerRegistry(), envVars.GetDockerRegistryCredsId()) {
    docker.image(envVars.GetFullImageName()).inside("--entrypoint=''") {
        withCredentials(credentials) {
            if (deploy == 'yes'){
                // Send start build notification
                if( it.config.containsKey("notifChannelCredsId")) {
                    p.k8sStage("\${it.config['name']} - Send notification",it, {
                        withCredentials([string(credentialsId: it.config['notifChannelCredsId'], variable: 'TEAMS_WEBHOOK')]) {
                            office365ConnectorSend message : "\${env.JOB_BASE_NAME}", status :"Started", webhookUrl: "\${env.TEAMS_WEBHOOK}"
                        }
                    })
                }
            }
        }
    }
}
`,
        },
    ],
};

export { rule };