ewinslow / elgg-grunt Goto Github PK

View Code? Open in Web Editor NEW

0.0 3.0 0.0 280 KB

Shared grunt configuration for Elgg 2.0 plugins and sites

License: MIT License

JavaScript 100.00%

elgg-grunt's Introduction

elgg-grunt

Shared grunt configuration for Elgg 2.0 plugins and sites.

Usage

1. Put this as your project's Gruntfile.js:

module.exports = require('elgg-grunt');

2. Add a profiles.local.json

Your local server needs to point to the /dist/ directory, which is where the built files will end up.

{
  "baseUrl": "http://localhost:8080/dist/"
}

3. Run `grunt watch`

Just grunt watch; no flags or subcommands.

This gives you the default local build, and automatically updates as you make changes. Load up the app at baseUrl to see it in action.

NB: You need to start the server yourself. How to do that is different based on each environment.

TODO(evan): Provide a default local server.

Releasing

This project and any project that relies on this one to provide its Gruntfile configuration can use the following commands to quickly push new versions to NPM.

# Bugfix releases (e.g. 1.0.x)
grunt release:patch
npm publish

# New feature releases (e.g. 1.x.0)
grunt release:minor
npm publish

# Backwards-incompatible releases (e.g. x.0.0)
grunt release:major
npm publish

Each of these will generate the appropriate changelog updates assuming you have been diligent to adhere to the recommended commit message format.

Continuous Testing

Add .travis.yml to your app:

language: node_js
node_js:
- '0.11'
script: grunt travis
branches:
  only:
  - master

Continuous Deployment

Travis-CI can push your app to gh-pages/staging/production every time all your tests pass. This example walks you through auto-pushing to GitHub pages:

Setup a gh-pages branch for deployment

You can follow the instructions here:

https://github.com/X1011/git-directory-deploy

Add a `.travis.yml` file

language: node_js
node_js:
- '0.11'
script: grunt travis
after_success: bin/deploy.sh gh-pages
branches:
  only:
  - master

Note that this also includes a after_success: bin/deploy.sh script. You need to copy deploy.sh from the ng-elgg repo until continuous deployment is supported out of the box.

Give Travis-CI your credentials

gem install travis
cd my_project
travis encrypt GITHUB_TOKEN=XXXXX --add

Replace XXXXX with your GitHub command line token for the repository.

Make sure Travis is running on commits to your repo

elgg-grunt's People

Contributors

Watchers

elgg-grunt's Issues

feature(tests): set up automatic karma/jasmine testing

Should be trivial for devs:

auto-detect and run all *_test.js and *Test.js files as tests
integrate with grunt travis
integrate with grunt watch

fix(profiles): emit clearer warning when profiles.local.json is not present

feature(dev): add `grunt watch` for continuous development

This should continuously:

lint/test source code
update the local demo

feature(dev): auto-generate CSP configurations

Right now we have to manually keep the different variations in sync.

Also, it's not very pluggable -- not possible to merge CSP requirements from several modules.

feature(travis): make `grunt travis` fail if commit message is malformed

See https://docs.google.com/a/elgg.org/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit

feature(dev): Support ES6 modules

These are the future of JS, so would prefer to switch to these from AMD when possible. Should compile to AMD for compatibility with older (and even modern!) browsers.

Problems blocking this move:

CSS/HTML dependencies -- ES6 doesn't come with plugin support the same way that AMD does.
more?

Use peer dependencies instead of grunt collection

grunt collection is causing errors to show up in the console and peer dependencies is more semantically correct.

fix(lint): projects should not have to include .jshintrc manually

This should just be included for them. This will help with keeping coding standards consistent across several projects.

feature(deploy): Support `grunt deploy --profile=XXXXX`

We want to easily support continuous deployment out of the box. Currently you still have to copy the deploy.sh script to each repo you want to deploy from. Copy/paste is evil. Best to keep everyone up-to-date by bundling the script with elgg-grunt.

Support a src/ dir in addition to app/

Add cp src/* dist/some/ns in build process where ns is defined in volo.namespace.

The idea is that app/ contains a demo app that shows off the features of the library. If the project is for a website, it just contains the actual site itself. src/ would contain all the reusable stuff that can be added to vendors dirs of other projects.

This will allow us to break out ng-require and ng-elgg from cbcoverseas.org.

Use uglify2 with angular pass for production

Uglify2 now supports @ngInject annotations, so we can do a full compilation of the initial JS and get the size way down.