import { MrCliCommandDefinition } from '@cirrusct/mr-core';

export const lint: MrCliCommandDefinition = {
    name: 'lint',
    description: 'Lint Package(s)',
    arguments: [
        {
            name: 'files',
            description: 'list of files to lint',
            isVariadic: true,
            isOptional: true,
        },
    ],
    options: [
        {
            name: 'fix',
            valueType: 'boolean',
            description: 'Fixes linting errors for select rules. This may overwrite linted files',
        },
        {
            name: 'format',
            valueType: 'string',
            description:
                'The formatter to use to format the results of the linter before outputting it to stdout or the file passed in',
        },
        {
            name: 'gitStaged',
            description: 'Format git staged files only',
        },
        {
            name: 'out',
            valueType: 'string',
            description:
                "A filename to output the results to. By default, tslint outputs to stdout, which is usually the console where you're running it from",
        },
    ],
};