backbone-boilerplate / generator-bbb

Backbone Boilerplate Yeoman generator.

Backbone Boilerplate

This boilerplate is the product of much research and frustration. Existing boilerplates freely modify Backbone core, lack a build process, and are very prescriptive; Backbone Boilerplate changes that.

The Backbone Boilerplate is a way of organizing a web application with some opinionated defaults, such as: Backbone, jQuery, Lodash, Grunt, Babel, Combyne, Karma, Mocha, and PureCSS for styles.

Organize your application with a logical file structure, develop your Models/Collections/Views/Routers inside modules, and build knowing you have efficient code that will not bottleneck your users.

Thanks to our Contributors! Special Thanks to: cowboy, iros, nimbupani, wookiehangover, and jugglinmike for helping me create this project. Extra Special Thanks to: Paul Guinan for giving me usage rights to his fantastic Boilerplate character.

Documentation

Backbone Boilerplate Wiki

Getting started

The easiest way to get started is to install Git and clone the repository:

# Using Git, fetch only the latest commits.  You won't need the full history
# for your project.
git clone --depth 1 https://github.com/tbranyen/backbone-boilerplate

# Move the repository to your own project name.
mv backbone-boilerplate my-project

You will need to download and install Node to fetch the dependencies and use the build tools.

Updating dependencies

Third party packages may update independently from this main repo, so it's a good idea to update after fetching.

npm install

Build process

The build process consists of numerous Grunt plugin tasks that work together to optimize your application.

# To run the build process, run the NPM start script. This will automatically
# run JSHint, the development Connect server, and watch your files for changes.
npm start

# Run a build and test the now optimized assets.
npm run test-prod

Working with tests

Create an ES6 module in the test/tests directory and add an import in the test/runner.js file. You'll see existing examples in there to make it easy to follow.

Run the tests with:

npm test

If you want to continuously test, run npm start and open the test/index.html file in your browser. The tests will re-run whenever you change source files.

By default, the test runner is BDD Mocha and uses Node's assert.

License

Copyright © 2015 Tim Branyen (@tbranyen)
Licensed under the MIT license.

generator-bbb's Issues

Fix Packages managers

Right now BBB rely on both Bower and JamJS to fetch dependencies. So we'll revert the package manager option for now until we add more control over scaffholding correct dependencies via different package mananager.

Also should check availability of the packages managers command line program and throw error/notifications otherwise.

unable to run yo bbb:app

$ yo bbb:app

    .-~0~-.
   /   ___ \ 
   |  ( _ )|       ~~ Backbone-Boilerplate ~~
 .-' (C) (C)`-  Welcome to the project generator
   |   .---.           Have a good time!
   |  / .-. \ 
   |  \ `-' / 
   |   `---'
 __|_______|___ 

identical index.html
 conflict favicon.ico

TypeError: Cannot call method 'setRawMode' of null
    at ReadStream.setRawMode (tty.js:65:16)
    at Interface._setRawMode (readline.js:165:23)
    at new Interface (readline.js:126:10)
    at Object.exports.createInterface (readline.js:39:10)
    at read (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/prompt/node_modules/read/lib/read.js:30:23)
    at EventEmitter.prompt.getInput (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/prompt/lib/prompt.js:503:3)
    at get (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/prompt/lib/prompt.js:322:12)
    at /usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/prompt/lib/prompt.js:281:7
    at iterate (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/prompt/node_modules/utile/node_modules/async/lib/async.js:108:13)
    at Object.async.forEachSeries (/usr/local/lib/node_modules/ge

Set defaults to prevent common errors

Manage updates and `bbb:update`

Manage configuration update and deprecation.

Also, we should settle on how we'll sync the generator version with different BBB versions.

Missing .gitignore file?

Based on the call stack below, it appears to be erroring when the .gitignore file is not included in the installation of the bbb generator. Indeed, when I look in the "/usr/local/lib/node_modules/generator-bbb/node_modules/backbone-boilerplate/ directory, there is no gitignore file.

/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/file.js:253
throw new Error('Unable to read "' + filepath + '" file (Error code: ' + e
      ^
Error: Unable to read "/usr/local/lib/node_modules/generator-bbb/node_modules/backbone-boilerplate/.gitignore" file (Error code: ENOENT).
at Env.File.read (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/file.js:253:11)
at Env.(anonymous function) [as read] (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/env.js:23:41)
at Env.File.copy (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/file.js:306:23)
at Env.copy (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/env.js:31:32)
at generateGit (/usr/local/lib/node_modules/generator-bbb/lib/generators/app/index.js:154:14)
at /usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/lib/base.js:341:43
at /usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:551:21
at /usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:227:13
at iterate (/usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:134:13)
at /usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:145:25

Automatically add test in the test files list in Karma

Check that global dependencies are installed

BBB rely on multiple global tools, on initialization (bbb:app and bbb:init), the generator should check that are installed:

• Bower
• Jam
• Karma

Scaffhold test for each modules created

Title got it all.

Need to automatically add the test to the configuration so it is runned.

Better CLI interface

Might become a separate module, but Yeoman really need a better CLI interface. We're coding interpreted code, we should strive to tell it what to do, not how :-)

Unable to create module

when I try to create a module using

$yo bbb:module test

the following error appeared

Error: Unable to read "/usr/local/lib/node_modules/generator-bbb/templates/module.undefined.js" file (Error code: ENOENT).
at Object.util.error (/usr/local/lib/node_modules/generator-bbb/node_modules/grunt/lib/grunt/util.js:57:39)
at Object.file.read (/usr/local/lib/node_modules/generator-bbb/node_modules/grunt/lib/grunt/file.js:237:22)
at Generator. (/usr/local/lib/node_modules/generator-bbb/base/bbb-generator.js:51:24)
at Generator.module (/usr/local/lib/node_modules/generator-bbb/module/index.js:48:42)
at next (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/lib/base.js:285:18)
at Generator.run (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/lib/base.js:299:4)
at Environment.run (/usr/local/lib/node_modules/yo/node_modules/yeoman-generator/lib/env.js:418:20)
at init (/usr/local/lib/node_modules/yo/bin/yo:72:7)
at pre (/usr/local/lib/node_modules/yo/bin/yo:85:3)
at Object. (/usr/local/lib/node_modules/yo/bin/yo:113:1)

How to solve it? Thanks!

BBB doesn't work anymore

Not sure what's happening but I returned to try out the generator and learn the layout manager and can't get anything to work. Is the project abandoned?

Unable to read error with yo bbb:app [path]

Hi,

I have successfully installed Yeoman (1.1.2) and then installed generator-bbb (as described in the read me). Now when I run yo bbb:app my-app-path I get the following while the files are being created:

/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/file.js:253
    throw new Error('Unable to read "' + filepath + '" file (Error code: ' + e
          ^
Error: Unable to read "/usr/local/lib/node_modules/generator-bbb/node_modules/backbone-boilerplate/.npmignore" file (Error code: ENOENT).
    at Env.File.read (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/file.js:253:11)
    at Env.(anonymous function) [as read] (/usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/node_modules/file-utils/lib/env.js:23:41)
    at generateGit (/usr/local/lib/node_modules/generator-bbb/lib/generators/app/index.js:155:44)
    at /usr/local/lib/node_modules/generator-bbb/node_modules/yeoman-generator/lib/base.js:341:43
    at /usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:551:21
    at /usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:227:13
    at iterate (/usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:134:13)
    at /usr/local/lib/node_modules/generator-bbb/node_modules/async/lib/async.js:145:25
    at /usr/local/lib/no

What am I missing here? Any help will be greatly appreciated. I have the following installed:

Node (0.10.28)
NPM (1.4.9)
yo (1.1.2)

Best,
Farhan

Explore path recursively for `.bbb-rc.json` config file

This will allow the usage of the sub-generator from every where inside a project.

Edit: Also when .bbb-rc.json is found, this directory should became the destination root.

warning: possible EventEmitter memory leak detected

I installed generator-bbb from the git repo and when I try to create a module with the following command, there is an error occurred.

$ yo bbb:module:test
(node) warning: possible EventEmitter memory leak detected. 11 listeners added. Use emitter.setMaxListeners() to increase limit.
Trace
at Stream.EventEmitter.addListener (events.js:160:15)
at Stream.pipe (stream.js:118:10)
at module.exports (/Users/richard/Dropbox/dev/lib/generator-bbb/node_modules/charm/index.js:42:15)
at Object. (/Users/richard/Dropbox/dev/lib/generator-bbb/node_modules/inquirer/lib/prompts/rawlist.js:6:29)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Module.require (module.js:364:17)
at require (module.js:380:17)

You must provide a name for your module

Anyone has an idea on it?

New project cannot run 'debug' grunt task

Using Node 0.10.15, and a fresh installation of [email protected], I am unable to get yo bbb:app to generate a project where grunt debug will succeed. The output is:

$ grunt debug
Running "clean:0" (clean) task

Running "jshint:files" (jshint) task
>> 4 files lint free.

Running "jst:debug" (jst) task
>> Destination not written because compiled files were empty.

Running "requirejs:debug" (requirejs) task
[Error: Error: ERROR: module path does not exist: /home/ccurrie/src/genbbb/dist/app/config.js for module named: config. Path is relative to: /home/ccurrie/src/genbbb
    at /home/ccurrie/src/genbbb/node_modules/grunt-bbb-requirejs/node_modules/requirejs/bin/r.js:24073:35
]

Backbone Version Problem?

Hi,i'm newbie.I follow the github-viewer and make a tiny app.Then i found the collection view not updated.Then i notice the backbone version where in github-viewer is 0.9.9 but in the probject is 1.0.0.I reverse the version to 0.9.9 and it worked.Another method is to delete the code below:
Backbone.Collection.prototype.fetch = function () {

    var fetch = Backbone.Collection.prototype.fetch;
    return function() {
        this.trigger("fetch");
        return fetch.apply(this, arguments);
    };

}();
Can anyone explain the code?

`bbb:init` should re-ask for the settings when run on an initialized project

Build not working due to invalid version of grunt-karma

Log below:

22687 info prepublish [email protected]
22688 error peerinvalid The package karma does not satisfy its siblings' peerDependencies requirements!
22688 error peerinvalid Peer [email protected] wants karma@~0.10.0
22688 error peerinvalid Peer [email protected] wants karma@>=0.9
22688 error peerinvalid Peer [email protected] wants karma@>=0.9
22688 error peerinvalid Peer [email protected] wants karma@>=0.9
22688 error peerinvalid Peer [email protected] wants karma@>=0.9
22688 error peerinvalid Peer [email protected] wants karma@>=0.9
22689 error System Darwin 13.0.2
22690 error command "/Users/drewf/.nvm/v0.10.24/bin/node" "/Users/drewf/.nvm/v0.10.24/bin/npm" "install" "--quiet"
22691 error cwd /Users/drewf/workspace/js/KiteRange
22692 error node -v v0.10.24
22693 error npm -v 1.3.21
22694 error code EPEERINVALID
22695 verbose exit [ 1, true ]

CommonJS style.

At the very least app/app.js and app/router.js need to lose the define wrapper in this mode.

Remove Grunt dependency

Grunt is overkill for the project - but there's some core functionnality missing from Yeoman. We should work to bring these into the BBB generator as a standalone and eventually merge that on Yeoman generators (e.g. like the CLI interface).

Refactoring paths usage

bbb.paths usage is pretty dirty ATM. That should be cleaned up and logic extracted in some helpers.

Better integration with Yeoman core feature: Conflicter and Reporting

ATM there's some good stuff missing from Yeoman: the conflict resolution utility and the file reporting (not all are reported).

This should be fixed :)

Missing component.json error on generation

When I try to generate an app, I get an error regarding a missing "component.json" file in backbone-boilerplate. Do I need to add this manually until BB adds this file?

Error: Unable to read "/home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/backbone-boilerplate/component.json" file (Error code: ENOENT).
    at Object.util.error (/home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/grunt/lib/grunt/util.js:57:39)
    at Object.file.read (/home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/grunt/lib/grunt/file.js:237:22)
    at Object.file.readJSON (/home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/grunt/lib/grunt/file.js:243:18)
    at Generator.<anonymous> (/home/ub/Desktop/yobb/node_modules/generator-bbb/lib/generators/base/bbb-generator.js:60:24)
    at Generator.genPackageManager (/home/ub/Desktop/yobb/node_modules/generator-bbb/lib/generators/app/index.js:136:23)
    at /home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/yeoman-generator/lib/base.js:276:20
    at /home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/async/lib/async.js:548:21
    at /home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/async/lib/async.js:224:13
    at iterate (/home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/async/lib/async.js:131:13)
    at /home/ub/Desktop/yobb/node_modules/generator-bbb/node_modules/async/lib/async.js:142:25

Can't install generator-bbb

I get the following when I execute npm install -gq [email protected]. Not sure what I'm doing wrong.

Any help please?

npm install -gq [email protected]
npm ERR! git fetch -a origin (git://github.com/backbone-boilerplate/backbone-boilerplate) error: cannot open FETCH_HEAD: Permission denied
npm ERR! Error: No compatible version found: backbone-boilerplate@'backbone-boilerplate/backbone-boilerplate#394e861d3c7292ca20d791be04ed0036a04b3cab'
npm ERR! Valid install targets:
npm ERR! ["1.0.0-wip","1.0.0"]
npm ERR!     at installTargetsError (/usr/lib/node_modules/npm/lib/cache.js:719:10)
npm ERR!     at /usr/lib/node_modules/npm/lib/cache.js:638:10
npm ERR!     at saved (/usr/lib/node_modules/npm/node_modules/npm-registry-client/lib/get.js:142:7)
npm ERR!     at /usr/lib/node_modules/npm/node_modules/graceful-fs/polyfills.js:133:7
npm ERR!     at Object.oncomplete (fs.js:107:15)
npm ERR! If you need help, you may report this log at:
npm ERR!     <http://github.com/isaacs/npm/issues>
npm ERR! or email it to:
npm ERR!     <[email protected]>

npm ERR! System Linux 3.8.0-19-generic
npm ERR! command "/usr/bin/node" "/usr/bin/npm" "install" "-gq" "[email protected]"
npm ERR! cwd /mnt/hgfs/www/lognenrollment/frontend_src/public
npm ERR! node -v v0.10.18
npm ERR! npm -v 1.3.8
npm ERR! 
npm ERR! Additional logging details can be found in:
npm ERR!     /mnt/hgfs/www/lognenrollment/frontend_src/public/npm-debug.log
npm ERR! not ok code 0

Template engine choice

Allow choice between Handlebars and Underscore

`fetch` method is broken when using CommonJS style

This is the output from app/app.js:

    fetch: /usr/lib / node_modules / generator - bbb / lib / templates / partial.handlebars - fetch.js

Modules encapsulating UI and data?

Hi @tbranyen !

If I understood correctly from the video of your Backbone talk at Backboneconf, you were advising to use separate files for the UI/View layer and the data layer.

Would this mean we would get a different way to call:

yo bbb:module <name>

e.g.

yo bbb:collection <name>

or

yo bbb:ui <name>

grunt release does not provide a clean release

under /dist/release
there are /app, /debug/, /vendor which I think some of them are not necessary.

Supersede the Yeoman generator-bbb project

Whenever you feel ready, we're happy to deprecate https://github.com/yeoman/generator-bbb/ and hand over the reigns of the bbb namespace so that this project can be run with yo bbb.

The ModuleStyle doesn't show correctly?

Hi,i'm im windows and use the command yo bbb,and it prompt me to choose the modestyle where i choose amd.After installing,i found the moduleStyle is commonJS.
Why is that happend?
Thans for any help..

What's wrong with Jam install Modernizr?

Hey,guys,i install the modernizr with jam.A strange problem is that after it installed,I check the require.config.js in vendor/jam/ and add the main property inside the modernizr config.The problem is that no matter whatever i change the value of main property in modernizr config.When debug it in the browser and it always point to main.js?Can't i change the main property of modernizr config with other name like modernizr.js?
Anyone can help me out ,thanks.

Repeated prompt message

I run $yo bbb:init but it has error message and every prompt appear multiple times.

$ yo bbb:init

.-0-.
/ ___ \
| ( _ )| ~~ Backbone-Boilerplate ~~
.-' (C) (C)- Welcome to the project generator
| .---. Have a good time!
| / .-. \
| -' /
| `---'
|__|

Your project name (default "fastweb"): Your project name (default "fastweb"): Your project name (default "fastweb"): fastwebfastwebfastwebct name (default "fastweb"): Your project name (default "fastweb"):
(node) warning: possible EventEmitter memory leak detected. 11 listeners added. Use emitter.setMaxListeners() to increase limit.
Trace
at Stream.EventEmitter.addListener (events.js:160:15)
at Stream.EventEmitter.once (events.js:179:8)
at module.exports (/usr/local/lib/node_modules/generator-bbb/node_modules/charm/index.js:46:11)
at Object. (/usr/local/lib/node_modules/generator-bbb/node_modules/inquirer/lib/prompts/list.js:6:29)
at Module._compile (module.js:456:26)
at Object.Module._extensions..js (module.js:474:10)
at Module.load (module.js:356:32)
at Function.Module._load (module.js:312:12)
at Module.require (module.js:364:17)
at require (module.js:380:17)
Which test framework do you want to use?
Which test framework do you want to use?
Which test framework do you want to use?
Which test framework do you want to use?
[X] [X] [X] [X] QUnit
QUnit
QUnit
QUnit
[ ] [ ] [ ] [ ] Mocha
Mocha
Mocha
Mocha
[ ] [ ] [ ] [ ] Jasmine
Jasmine
Jasmine
Jasmine
(Use arrow key)(Use arrow key)(Use arrow key)(Use arrow key)

Module format

Give choice between CommonJS and AMD modules style.

Install fails: No compatible version found: ast-query@'>=0.1.0 <0.2.0'

I get the following when I execute npm install -gq generator-bbb :

219 verbose addLocalTarball adding from inside cache /Users/infolock/.npm/backbone-boilerplate/1.0.0/package.tgz
220 silly cache afterAdd [email protected]
221 verbose afterAdd /Users/infolock/.npm/backbone-boilerplate/1.0.0/package/package.json not in flight; writing
222 verbose afterAdd /Users/infolock/.npm/backbone-boilerplate/1.0.0/package/package.json written
223 verbose about to build /usr/local/lib/node_modules/generator-bbb
224 verbose unlock done using /Users/infolock/.npm/_locks/generator-bbb-ec1aaf88d5b7cc7c.lock for /usr/local/lib/node_modules/generator-bbb
225 verbose stack Error: No compatible version found: ast-query@'>=0.1.0 <0.2.0'
225 verbose stack Valid install targets:
225 verbose stack ["0.1.0-pre","0.1.0-pre.1","0.1.0-pre.2","0.2.0","0.2.1","0.2.2","0.2.3","0.2.4","0.2.5","0.3.0"]
225 verbose stack
225 verbose stack     at installTargetsError (/usr/local/lib/node_modules/npm/lib/cache/add-named.js:259:12)
225 verbose stack     at next (/usr/local/lib/node_modules/npm/lib/cache/add-named.js:238:17)
225 verbose stack     at setData (/usr/local/lib/node_modules/npm/lib/cache/add-named.js:215:5)
225 verbose stack     at RES (/usr/local/lib/node_modules/npm/node_modules/inflight/inflight.js:23:14)
225 verbose stack     at f (/usr/local/lib/node_modules/npm/node_modules/once/once.js:17:25)
225 verbose stack     at CachingRegistryClient.get_ (/usr/local/lib/node_modules/npm/lib/cache/caching-client.js:118:16)
225 verbose stack     at /usr/local/lib/node_modules/npm/lib/cache/caching-client.js:87:14
225 verbose stack     at evalmachine.<anonymous>:271:14
225 verbose stack     at /usr/local/lib/node_modules/npm/node_modules/graceful-fs/graceful-fs.js:102:5
225 verbose stack     at Object.oncomplete (evalmachine.<anonymous>:107:15)
226 verbose cwd /www/beaconRegistration/tmp/backbone-boilerplate
227 error Darwin 14.1.0
228 error argv "node" "/usr/local/bin/npm" "install" "-gq" "generator-bbb"
229 error node v0.10.33
230 error npm  v2.1.14
231 error code ETARGET
232 error notarget No compatible version found: ast-query@'>=0.1.0 <0.2.0'
232 error notarget Valid install targets:
232 error notarget ["0.1.0-pre","0.1.0-pre.1","0.1.0-pre.2","0.2.0","0.2.1","0.2.2","0.2.3","0.2.4","0.2.5","0.3.0"]
232 error notarget
232 error notarget This is most likely not a problem with npm itself.
232 error notarget In most cases you or one of your dependencies are requesting
232 error notarget a package version that doesn't exist.
233 verbose exit [ 1, true ]
234 verbose unbuild lib/node_modules/generator-bbb
235 info preuninstall [email protected]
236 info uninstall [email protected]
237 verbose unbuild rmStuff [email protected] from /usr/local/lib/node_modules
238 info postuninstall [email protected]
239 verbose gentlyRm vacuuming /usr/local/lib/node_modules/generator-bbb
240 silly gentlyRm purging /usr/local/lib/node_modules/generator-bbb
241 silly gentlyRm quitting because other entries in /usr/local/lib/node_modules

os: Mac OSX
npm version: 2.1.14
node version: v0.10.33

Error: ERROR: module path does not exist

When I run grunt release:

Running "clean:0" (clean) task

Running "jshint:files" (jshint) task

5 files lint free.

Running "jst:debug" (jst) task

Destination not written because compiled files were empty.

Running "requirejs:debug" (requirejs) task
[Error: Error: ERROR: module path does not exist: /home/sophy/dev/learn/backbone/bbb/dist/app/config.js for module named: config. Path is relative to: /home/sophy/dev/learn/backbone/bbb
at build._run.prim.start.config.modules.(anonymous function)._buildPath (/home/sophy/dev/learn/backbone/bbb/node_modules/grunt-bbb-requirejs/node_modules/requirejs/bin/r.js:24073:35)

What wrong?

`bbb:init` should work in subfolder (like `bbb:app`)

This just mean switching CWD control to init task instead of app and some refactoring around that.