Giter VIP home page Giter VIP logo

yeoman-include's Introduction

archived Archived Repository
This code is no longer maintained. Feel free to fork it, but use it at your own risks.

yeoman-include

Grunt task to include static templates with Yeoman

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-include --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('yeoman-include');

The "include" task

Overview

In your project's Gruntfile, add 2 sections named include & include:clean to the data object passed into grunt.initConfig().

grunt.initConfig({
  include: {
      myTask: 'source/*.html'
  },

  "include:clean": {
      myTask: 'source/*.html'
  },

  "include:clean-dest": {
      myTask: 'dest/*.html'
  },
})

grunt.registerTask('build', [
    'include:myTask',
    // Run task like cssmin, ugligy ...
    'include:clean:myTask',
    'include:clean-dest:myTask'
]);

Usage Examples

Default Options

grunt.initConfig({
	  include: {
	      build: '<%= yeoman.app %>/*.html',
	      tmp: '.tmp/*.html'
	  },

	  "include:clean": {
	      build: '<%= yeoman.app %>/*.html',
	      tmp: '.tmp/*.html'
	  },

	  "include:clean-dest": {
	      build: '<%= yeoman.dist %>/*.html',
	      tmp: '.tmp/*.html'
	  }
})

grunt.registerTask('build', [
    'clean:dist',
    'include:build',
    'cssmin',
    'concat',
    'uglify',
    'coffee',
    'copy:dist',
    'rev',
    'usemin',
    'include:clean:build',
    'include:clean-dest:build'
]);

Using grunt with server

Declare connect middleware

// Gruntfile.js
module.exports = function (grunt) {
    // load all grunt tasks
    require('matchdep').filterDev('grunt-*').forEach(grunt.loadNpmTasks);

    // configurable paths
    var yeomanConfig = {
        app: 'app',
        dist: 'dist'
    };

		var includeMiddleware = require('yeoman-include/middleware')(__dirname+'/'+yeomanConfig.app);

		// ...

		connect: {
				livereload: {
				    options: {
				        middleware: function (connect) {
				            return [
				                includeMiddleware,
				                // ...
				            ];
				        }
				    }
				},
});

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • v0.1 (08/14/2013) : Add simple yeoman include task
  • v0.2 (09/08/2013) : Allows multiple task (eg. include:build, include:tmp)
  • v0.3 (01/02/2014) : Use grunt.file.expand to be crossplatform

yeoman-include's People

Contributors

alexisjanvier avatar manuquentin avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Forkers

gruntjs-updater

yeoman-include's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.