GithubHelp home page GithubHelp logo

umayr / generator-ng-bat Goto Github PK

View Code? Open in Web Editor NEW
2.0 3.0 4.0 122 KB

Yeoman generator for Angular 1.x powered by Webpack.

Home Page: https://github.com/umayr/generator-ng-bat

License: MIT License

JavaScript 95.18% HTML 3.53% CSS 1.29%

generator-ng-bat's Introduction

generator-ng-bat Build Status

Yeoman generator for Angular 1.x powered by Webpack.

Usage

  # install yeoman and generator globally
  $ npm install -g yo generator-ng-bat
  
  # create an empty directory
  $ mkdir dummy && cd $_
  
  # invoke generator
  $ yo ng-bat

Features

The directory structure is based on John Papa's style guide with a minor addition of stylesheets being included in the module directory.

Structure:

.
├── app
│   ├── images
│   │   ├── angular.png
│   │   └── webpack.png
│   ├── index.html
│   └── src
│       ├── app.module.js
│       ├── common
│       │   ├── common.module.js
│       │   └── common.scss
│       ├── core
│       │   ├── core.module.js
│       │   ├── core.scss
│       │   ├── restangular.config.js
│       │   ├── router.config.js
│       │   └── router.run.js
│       └── welcome
│           ├── welcome.controller.js
│           ├── welcome.html
│           ├── welcome.module.js
│           └── welcome.scss
├── LICENSE
├── package.json
└── webpack.config.js

Development:

To start development server, try:

  $ npm start

It starts a webpack-dev-server instance with hot module loading.

Linting:

  $ npm run lint

It uses eslint for linting that includes angularjs-eslint plugin that makes sure you're properly following John Papa's guidelines. Although it uses shareable configuration so things that you don't agree with can be changed.

Sub-generators:

While generator creates an app structure, sub-generators create parts of app for e.g. controller, service etc.

Controller:

Invoked by:

  $ yo ng-bat:controller dashboard.user

Creates a user.controller.js file in the dashboard module:

'use strict';

module.exports = controller;

/* @ngInject */
function controller($log) {
  var vm = this;

  vm.welcomeMessage = 'Yet another generator for angular powered by webpack.';
  vm.testFunction = testFunction;

  if (__DEV__) { // eslint-disable-line no-undef
    $log.info('Initializing controller');
  }

  function testFunction(num) {
    $log.info('This is a test function number ' + num);
  }
}

When provided with flag --with-view, it also creates a view with same name in the provided module:

  $ yo ng-bat:controller dashboard.user --with-view
Factory:

Invoked by:

  $ yo ng-bat:factory dashboard.utils

Creates a utils.factory.js in the dashboard module:

'use strict';

module.exports = factory;

/* @ngInject */
function factory($log) {
  return {
    testFunction: testFunction
  };

  function testFunction() {
    $log.info('This is a test function.');
  }
}
View:

Invoked by:

  $ yo ng-bat:view dashboard.nav

Creates a nav.html file in the dashboard module:

<div class="container">
  <p>A very empty view.</p>
</div>
Directive:

Invoked by:

  $ yo ng-bat:directive common.ui-submit

Creates a uiSubmit.directive.js file in common module:

'use strict';

module.exports = directive;

/* @ngInject */
function directive($log) {

  return {
    link: link,
    restrict: 'E',
    template: '<div></div>',
    scope: {
      test: '='
    }
  };

  function link(/*scope, elem, attrs*/) {
    if (__DEV__) { // eslint-disable-line no-undef
      $log.info('Initializing directive');
    }
  }
}
Filter:

Invoked by:

  $ yo ng-bat:filter common.currency 

Creates a currency.filter.js file in the common module:

'use strict';

module.exports = filter;

/* @ngInject */
function filter() {
  return function (input) {
    return 'currency filter: ' + input;
  };
}
Constant:

Invoked by:

  $ yo ng-bat:constant common.http-codes

Creates a httpCodes.constant.js file in the common module:

'use strict';

module.exports = {
  ConstantKey: 'CONSTANTVALUE'
};
Value:

Invoked by:

  $ yo ng-bat:value common.messages

Creates a messages.value.js file in the common module:

'use strict';

module.exports = {
  key: 'value'
};

Production:

To create a build:

  $ npm run build

License

The MIT License (MIT)

Copyright (c) 2015 Umayr Shahid <[email protected]> (https://bandooqwala.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

generator-ng-bat's People

Contributors

mohuk avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

generator-ng-bat's Issues

Generator not working on windows.

Node v4.2.2

Error:

λ yo ng-bat
module.js:339
    throw err;
    ^

Error: Cannot find module '../../utils'
    at Function.Module._resolveFilename (module.js:337:15)
    at Function.Module._load (module.js:287:25)
    at Module.require (module.js:366:17)
    at require (module.js:385:17)
    at Object.<anonymous> (C:\Users\uzair.ali\AppData\Roaming\nvm\v4.2.2\node_modules\generator-ng-bat\generators\app\index.js:8:13)
    at Module._compile (module.js:435:26)
    at Object.Module._extensions..js (module.js:442:10)
    at Module.load (module.js:356:32)
    at Function.Module._load (module.js:311:12)
    at Module.require (module.js:366:17)

Support for Angular's .component

Since angular 1.5.0, component is introduced as special kind of directive with sensible default values.

Add a subgenerator to create components.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.