sfdx-hardis/lib/commands/hardis/project/lint.js

Swiss-army-knife Toolbox for Salesforce. Allows you to define a complete CD/CD Pipeline. Orchestrate base commands and assist users with interactive wizards

/* jscpd:ignore-start */
import { SfCommand, Flags, optionalOrgFlagWithDeprecations } from '@salesforce/sf-plugins-core';
import { Messages, SfError } from '@salesforce/core';
import { isCI, uxLog } from '../../../common/utils/index.js';
import c from 'chalk';
import fs from 'fs-extra';
import { MegaLinterRunner } from 'mega-linter-runner/lib/index.js';
Messages.importMessagesDirectoryFromMetaUrl(import.meta.url);
const messages = Messages.loadMessages('sfdx-hardis', 'org');
export default class Lint extends SfCommand {
    static title = 'Lint';
    static description = 'Apply syntactic analysis (linters) on the repository sources, using Mega-Linter';
    static examples = ['$ sf hardis:project:lint', '$ sf hardis:project:lint --fix'];
    static flags = {
        fix: Flags.boolean({
            char: 'f',
            default: false,
            description: 'Apply linters fixes',
        }),
        debug: Flags.boolean({
            char: 'd',
            default: false,
            description: messages.getMessage('debugMode'),
        }),
        websocket: Flags.string({
            description: messages.getMessage('websocket'),
        }),
        skipauth: Flags.boolean({
            description: 'Skip authentication check when a default username is required',
        }),
        'target-org': optionalOrgFlagWithDeprecations,
    };
    static requiresProject = false;
    fix = false;
    debugMode = false;
    /* jscpd:ignore-end */
    async run() {
        const { flags } = await this.parse(Lint);
        this.fix = flags.fix || false;
        this.debugMode = flags.debug || false;
        // Check if Mega-Linter is configured
        if (!fs.existsSync('.mega-linter.yml')) {
            if (isCI) {
                throw new SfError(c.red('[sfdx-hardis] You must run sf hardis:project:lint locally to install Mega-Linter configuration before being able to run it from CI'));
            }
            else {
                // Configure Mega-Linter (yeoman generator)
                uxLog(this, c.cyan('Mega-Linter needs to be configured. Please select Salesforce flavor in the following wizard'));
                const megaLinter = new MegaLinterRunner();
                const installRes = megaLinter.run({ install: true });
                console.assert(installRes.status === 0, 'Mega-Linter configuration incomplete');
            }
        }
        // Run MegaLinter
        const megaLinter = new MegaLinterRunner();
        const megaLinterOptions = { flavor: 'salesforce', fix: this.fix };
        const res = await megaLinter.run(megaLinterOptions);
        process.exitCode = res.status;
        if (res.status === 0) {
            uxLog(this, c.green(`Mega-Linter has been successful`));
        }
        else {
            uxLog(this, c.red(`Mega-Linter found error(s)`));
        }
        // Return an object to be displayed with --json
        return { outputString: 'Linted project sources', linterStatusCode: res.status };
    }
}
//# sourceMappingURL=lint.js.map