dd-common - AngularJS services, utilities and directives common among our projects
Do you want to see these modules in action? Visit http://drivr.github.io/dd-common/!
If you use jspm run jspm install dd-common=github:drivr/dd-common
import 'dd-common';
// ...
angular.module('myModule', ['dd.common']);
- After your PR is merged switch to master and pull latests changes
- Bump up package.json version and jspm main file version in
package.json
. If you don't understand this please see previous release commits and look at package.json changes. - Open command line and run
grunt release-start
- Verify changes are correct and run
grunt release-push
- Run
grunt gh-pages
to update demo site
Components from this repository are automatically tested with the following browsers:
- Chrome (stable and canary channel)
- Firefox
- IE 9 and 10
- Opera
- Safari
Modern mobile browsers should work without problems.
Components should work. All the time and in all browsers. This is why all the components have a comprehensive suite of unit tests. All the automated tests are executed on each checkin. In fact we are fortunate enough to benefit from the same testing infrastructure as AngularJS!
Project's issue on GitHub should be used discuss bugs and features.
We are always looking for the quality contributions! Please check the CONTRIBUTING.md for the contribution guidelines.
- Install Node.js and NPM (should come with)
- Install global dev dependencies:
npm install -g grunt-cli karma
- Install local dev dependencies:
npm install
while current directory is dd-common repo
- Build the whole project:
grunt
- this will runlint
,test
, andconcat
targets - To build modules, first run
grunt html2js
thengrunt build:module1:module2...:moduleN
You can generate a custom build, containing only needed modules, from the project's homepage. Alternatively you can run local Grunt build from the command line and list needed modules as shown below:
grunt build:modal:tabs:alert:popover:dropdownToggle:buttons:progressbar
Check the Grunt build file for other tasks that are defined for this project.
- Run test:
grunt watch
This will start Karma server and will continuously watch files in the project, executing tests upon every change.
Add the --coverage
option (e.g. grunt test --coverage
, grunt watch --coverage
) to see reports on the test coverage. These coverage reports are found in the coverage folder.
As mentioned components from this repository have all the markup externalized in templates. You might want to customize default templates to match your desired look & feel, add new functionality etc.
The easiest way to override an individual template is to use the <script>
directive:
<script id="template/alert/alert.html" type="text/ng-template">
<div class='alert' ng-class='type && "alert-" + type'>
<button ng-show='closeable' type='button' class='close' ng-click='close()'>Close</button>
<div ng-transclude></div>
</div>
</script>
If you want to override more templates it makes sense to store them as individual files and feed the $templateCache
from those partials.
For people using Grunt as the build tool it can be easily done using the grunt-html2js
plugin. You can also configure your own template url.
Let's have a look:
Your own template url is views/partials/ui-bootstrap-tpls/alert/alert.html
.
Add "html2js" task to your Gruntfile
html2js: {
options: {
base: '.',
module: 'ui-templates',
rename: function (modulePath) {
var moduleName = modulePath.replace('app/views/partials/dd-common-tpls/', '').replace('.html', '');
return 'template' + '/' + moduleName + '.html';
}
},
main: {
src: ['app/views/partials/dd-common-tpls/**/*.html'],
dest: '.tmp/ui-templates.js'
}
}
Make sure to load your template.js file
<script src="/ui-templates.js"></script>
Inject the ui-templates
module in your app.js
angular.module('myApp', [
'dd.common',
'ui-templates'
]);
Then it will work fine!
For more information visit: https://github.com/karlgoldstein/grunt-html2js
- Bump up version number in
package.json
- Commit the version change with the following message:
chore(release): [version number]
- tag
- push changes and a tag (
git push --tags
) - switch to the
gh-pages
branch:git checkout gh-pages
- copy content of the dist folder to the main folder
- Commit the version change with the following message:
chore(release): [version number]
- push changes
- switch back to the
main branch
and modifypackage.json
to bump up version for the next iteration - commit (
chore(release): starting [version number]
) and push - publish Bower and NuGet packages
Well done! (If you don't like repeating yourself open a PR with a grunt task taking care of the above!)