atangeman / angularjs-builder

A simple linux command-line script to set up working directories and base files for AngularJs projects.

AngularJs Builder

Build your standard and stick to it!

This repo contains a set of simple linux command-line scripts to set up working directories and base files to AngularJs standards. You can customize these scripts to build your own working directory standard, or use as is.

Standards:

Templated classes and working directories are built using standards outlined in The Angular 1 Style Guide.

How it Works

The /.build directory contains all of the default scripts to setup your working directory, and also generate common angularjs files on demand.

Setup Script

_setup.sh 

This script uses simple bash commands to setup the working directory, generate default js files and downloads common angularjs and bootstrap src js to the ./assets/lib/ directory.

Libs Downloaded to ./assets/lib/:

• angular.js
• angular.min.js
• angular-resource.js
• angular-resource.min.js
• angular-route.js
• angular-route.min.js
• angular-sanitize.js
• angular-sanitize.min.js

Building in same working directory:

.build/_setup.sh ./

Building in alternate directory:

.build/_setup.sh ~/{PATH_TO_DIR}

GenerateJs Script

generatejs.sh

This script will automatically generate the following default angular js files to a prespecified directory:

• Controllers (-c)
• Directives (-d)
• Services (-s)

Generating a Controller:

.build/generatejs.sh -c ./defaultController

Sample Output:

/**
 * @file
 */
(function () {

    "use strict";

    angular
        .module('app')
        .controller('DefaultCtrl', DefaultCtrl);

    DefaultCtrl.$inject = ['defaultService', 'logger'];

    function DefaultCtrl(defaultService, logger) {
        var vm = this;
        vm.load = load;
        vm.data = [];
        vm.title = 'Default';

        activate();

        function activate() {
            return getData().then(function() {
                logger.info('Activated Default View');
            });
        }

        function getData() {
            return defaultService.getData().then(function(data) {
                vm.data = data;
                return vm.data;
            });
        }
    }
})();

Generating a Service:

.build/generatejs.sh -s ./defaultService

Sample Output:

/**
 * @file
 */
(function () {

    "use strict";

    function defaultService($http, logger) {
        var service = {
            getData: getData
        };

        return service;

        /////////////

        function getData() {
            // implementation details go here
        }
    }
})();

Generating a Directive

.build/generatejs.sh -d ./defaultDirective

Sample Output:

/**
 * @file
* @example <div default-function></div>
 */
(function () {

    "use strict";

    angular
        .module('app')
        .directive('defaultFunction', defaultFunction);

    function defaultFunction() {
        /* implementation details */
    }

})();

License

• AngularJS builder - Copyright © Andrew Tangeman

• Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.