gulp-ng-inject
v0.1.0
Published
Add dependencies to your main Angular.js project file automatically
Downloads
178
Maintainers
Readme
gulp-ng-inject
I love using gulp-inject. It's a great tool that can take care of including your JavaScript and bower files into your index.html
file.
When working with Angular.js
, I also wanted to include all my modules names as a depedency of my application automatically. So that I don't have to include each module name by hand. gulp-ng-inject
does that for you.
You can also watch files & when they change it can reload the browser for you in combination with gulp-watch and BrowserSync.
##Install
npm install gulp-ng-inject --save-dev
##Usage
- This is the only depedency you'll need into your
Angular.js
project: 'gulp-ng-inject'
// app/src/main.js
angular.module('app', ['ng-inject']);
- Create a task to run:
// gulpfile.js
var gulp = require("gulp");
var ngInject = require("gulp-ng-inject");
gulp.task("default", function() {
var options = {
name: "ng-inject", // The name of the module to use in your main Angular.js
modules: ['ui.router'] // Any extra modules that you want to include.
};
return gulp.src(["!app/src/templates/*", "app/src/**/*.js"])
.pipe(ngInject("ng-inject.js", options)) // Name of the file generated
.pipe(gulp.dest("app/src/init/")) // Destination folder
});
- Make sure that the module path it's added to your index.html
<script src="app/src/init/ng-inject.js">
API
ngInject(fileName, options)
fileName
Type: string
The destination fileName.
options
name
Type: string
The name of the module that you want to use.
modules
Type: array
List of additional modules to include.
Example
var browserSync = require('browser-sync');
var gulp = require('gulp');
var inject = require('gulp-inject');
var ngInject = require('gulp-ng-inject');
var watch = require('gulp-watch');
var config = {
baseDir: './app/src',
jsFiles: './app/src/js/**/*.js',
port: 3030
}
gulp.task('ngInject', function() {
return gulp.src([config.jsFiles])
.pipe(ngInject("ng-inject.js", {name: "ng-inject", modules: ['ui.router']}))
.pipe(gulp.dest("app/src/init"));
});
gulp.task('server', function() {
browserSync({
server: {
baseDir: config.baseDir
},
port: config.port
});
});
gulp.task('watch', function () {
watch(config.jsFiles, function() {
browserSync.reload();
gulp.start('js');
});
});
gulp.task('js', ['ngInject'], function () {
return gulp.src(config.baseDir + '/index.html')
.pipe(inject(gulp.src([config.jsFiles], {base: config.baseDir, read: true}), {relative: true}))
.pipe(gulp.dest(config.baseDir));
});
gulp.task('default', ['js', 'watch', 'server']);
HTML with Inject tags.
<html>
<head>
</head>
<body>
<script src="../../bower_components/angular/angular.js"></script>
<!-- inject:js -->
<!-- endinject -->
</body>
</html>