salesforce-lightning-cli/commands/lint.js

/*
 * Copyright (C) 2016 salesforce.com, inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

'use strict';

var linter = require('../lib/linter.js');

module.exports = {
    topic: 'lightning',
    command: 'lint',
    description: 'Linter for Lightning Components',
    help: 'Example:\n  $ heroku lightning:lint ./path/to/be/linted/',
    args: [
        {
            name: 'path'
        }
    ],
    flags: [
        {
            name: 'ignore',
            char: 'i',
            hasValue: true,
            description: 'Pattern to ignore some folders. Example: --ignore **/foo/**'
        },
        {
            name: 'files',
            hasValue: true,
            description: 'Pattern to include specific files. Defaults to all .js files. Example: --files **/*Controller.js'
        },
        {
            name: 'json',
            char: 'j',
            hasValue: false,
            description: 'Output JSON to facilitate integration with other tools. Defaults to standard text output format. Example: --json'
        },
        {
            name: 'config',
            hasValue: true,
            description: 'Path to a custom ESLint configuration. Only code styles rules will be picked up, the rest will be ignored. Example: --config path/to/.eslintrc'
        },
        {
            name: 'verbose',
            hasValue: false,
            description: 'Report warnings in addition to errors. Defaults to reporting only errors. Example: --verbose'

        }
    ],
    run: function(context) {
        linter(context.args.path, context.flags, {
            cwd: context.cwd
        });
    }
};