This repository has been archived by the owner on Jan 24, 2019. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 546
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(grunt): use Angular UI Publisher
Merge branch 'douglasduteil-ft-component-publisher' Closes #153
- Loading branch information
Showing
47 changed files
with
510 additions
and
307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,7 @@ | ||
bower_components/ | ||
node_modules/ | ||
.rcs | ||
*.swp | ||
out/ | ||
dist/ | ||
|
||
# don't track generated/copied html demo files | ||
demo/*.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
{ | ||
"boss": true, | ||
"browser": true, | ||
"eqnull": true, | ||
"expr": true, | ||
"globalstrict": true, | ||
"immed": true, | ||
"laxbreak": true, | ||
"loopfunc": true, | ||
"newcap": true, | ||
"noarg": true, | ||
"noempty": true, | ||
"nonew": true, | ||
"quotmark": true, | ||
"smarttabs": true, | ||
"sub": true, | ||
"trailing": true, | ||
"undef": true, | ||
"unused": true, | ||
"globals": { | ||
"angular": false | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,87 @@ | ||
# AngularUI - The companion suite for AngularJS | ||
# UI.Utils [![Build Status](https://travis-ci.org/angular-ui/ui-utils.png?branch=master)](https://travis-ci.org/angular-ui/ui-utils) | ||
|
||
*** | ||
The companion suite for AngularJS | ||
|
||
[![Build Status](https://travis-ci.org/angular-ui/ui-utils.png?branch=master)](https://travis-ci.org/angular-ui/ui-utils) | ||
## Requirements | ||
|
||
- AngularJS | ||
|
||
## Usage | ||
|
||
### Requirements | ||
|
||
* **AngularJS v1.0.0+** is currently required. | ||
* **jQuery*** Until the refactor is complete, some directives still require jQuery | ||
You can get it from [Bower](http://bower.io/) | ||
|
||
```sh | ||
# All the modules | ||
bower install angular-ui-utils\#bower | ||
|
||
# A specific module | ||
# bower install angular-ui-utils\#bower-<moduleName> | ||
bower install angular-ui-utils\#bower-event | ||
bower install angular-ui-utils\#bower-keypress | ||
... | ||
|
||
# A specific version | ||
bower install angular-ui-utils\#v0.0.4 | ||
# A specific module version | ||
bower install angular-ui-utils\#event-0.0.4 | ||
bower install angular-ui-utils\#keypress-0.0.4 | ||
... | ||
|
||
# If you want the sources with it | ||
bower install angular-ui-utils | ||
# or for a specific source version | ||
bower install angular-ui-utils\#src0.0.4 | ||
``` | ||
|
||
This will copy the UI.Utils files into a `bower_components` folder, along with its dependencies. Load the script files in your application: | ||
|
||
```html | ||
<script type="text/javascript" src="bower_components/angular/angular.js"></script> | ||
<!-- for all the modules --> | ||
<script type="text/javascript" src="bower_components/angular-ui-utils/ui-utils.js"></script> | ||
|
||
## Installation | ||
<!-- or just specific one--> | ||
<script type="text/javascript" src="bower_components/angular-ui-event/event.js"></script> | ||
<script type="text/javascript" src="bower_components/angular-ui-keypress/keypress.js"></script> | ||
<!-- ... --> | ||
``` | ||
|
||
Add the specific modules to your dependencies, or add the entire lib by depending on `ui.utils` | ||
|
||
```javascript | ||
angular.module('myApp', ['ui.keypress', 'ui.event', ...]) | ||
// or if ALL modules are loaded along with modules/utils.js | ||
angular.module('myApp', ['ui.utils']) | ||
var myAppModule = angular.module('MyApp', ['ui.utils']); | ||
``` | ||
|
||
Each directive and filter is now it's own module and will have a relevant README.md in their respective folders | ||
|
||
## Development | ||
|
||
At this time, we do not have a build script. You must include all `.js` files you wish to work on. | ||
We will likely be adding a `Gruntfile.js` in the near future for this | ||
We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt: | ||
|
||
### Requirements | ||
```sh | ||
npm install -g grunt-cli | ||
npm install && bower install | ||
grunt | ||
``` | ||
|
||
0. Install [Node.js](http://nodejs.org/) and NPM (should come with) | ||
The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in `test\karma.conf.js` | ||
|
||
1. Install global dependencies `grunt-cli`, `bower`, and `karma`: | ||
|
||
```bash | ||
$ npm install -g karma grunt-cli bower | ||
``` | ||
### Grunt Serve | ||
|
||
2. Install local dependencies: | ||
We have one task to serve them all ! | ||
|
||
```bash | ||
$ npm install | ||
$ bower install | ||
``` | ||
```sh | ||
grunt serve | ||
``` | ||
|
||
### Running Tests | ||
It's equal to run separately: | ||
|
||
Make sure all tests pass in order for your Pull Request to be accepted | ||
* `grunt connect:server` : giving you a development server at [http://127.0.0.1:8000/](http://127.0.0.1:8000/). | ||
|
||
You can choose what browsers to test in: `Chrome,ChromeCanary,Firefox,PhantomJS` | ||
* `grunt karma:server` : giving you a Karma server to run tests (at [http://localhost:9876/](http://localhost:9876/) by default). You can force a test on this server with `grunt karma:unit:run`. | ||
|
||
```bash | ||
$ karma start --browsers=Chrome,Firefox test/karma.conf.js --single-run=true | ||
``` | ||
* `grunt watch` : will automatically test your code and build your demo. You can demo generation with `grunt build:gh-pages`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.