grunt-appc-js

    2.1.0 • Public • Published

    grunt-appc-js

    Linting and style checks for Appcelerator JavaScript

    Build Status Dependency Status devDependency Status NPM version

    Getting Started

    This plugin requires Grunt ~0.4.5

    If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

    npm install grunt-appc-js --save-dev

    Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

    grunt.loadNpmTasks('grunt-appc-js');

    The "appcJs" task

    Overview

    In your project's Gruntfile, add a section named appcJs to the data object passed into grunt.initConfig().

    grunt.initConfig({
        appcJs: {
            options: {
                force: false,
                fix: false,
                globals: {
                    "$config": true
                }
            }
        src: ['paths', 'to', 'js', 'files'],
        }
    });
    • force (optional): If set to true, don't fail the task on errors
    • fix (optional): If set to true, fix the style errors as reported by JSCS (to the best of its ability)
    • globals (optional): A list of globally-defined variables to ignore

    Mutliple targets

    You may not wisht to fix all source files:

    grunt.initConfig({
        appcJs: {
            options: {force: true},
            check: {
                src: ['paths', 'to', 'js', 'files']
            },
            fix: {
                options: {fix: true},
                src: ['paths', 'to', 'js', 'files']
            }
        }
    });
     
    ## Contributing
    Add unit tests for any new or changed functionality. Run `npm test` to ensure your added code matches existing style standards.

    Keywords

    Install

    npm i grunt-appc-js

    DownloadsWeekly Downloads

    11

    Version

    2.1.0

    License

    Apache-2.0

    Unpacked Size

    9.84 kB

    Total Files

    14

    Last publish

    Collaborators

    • appcelerator
    • ingo