gulp-app-clonify

0.1.3 • Public • Published

gulp-app-clonify

Clone application files or directory with the capability to replace all existence of a key value pair you defined in the settings

Can be useful if you want to generate new codebase similar to an existing just the only difference is their namespace or something. or generate a new codebase base on your template.

To run Demo:

$ cd demo
$ gulp clone --baseApp=Uu --cloneApp=NewClone

Just make sure the you already install all node modules including Dev Dependencies

Install 🚥

$ npm install gulp-app-clonify --save

Pipe :neckbeard:

Like any other gulp plugin, transformed source files will flow onward to the destination of your choice.

In your gulpfile.js

/gulpfile.js

var gulp = require('gulp');
var clonify = require('gulp-app-clonify');

gulp.task('clone', function(){
    gulp.src('path/to/the/directory/you/want/to/clone/**/*')
        .pipe(clonify({
            base : 'baseName',
            clone : 'CloneName',
            replaceValues : [
                {
                    key : 'stringYouWantToChange',
                    value : 'newValueAfterChange'
                },
                {
                    key : 'couldBeARegularExpression',
                    value : 'newValueAfterChange'
                }
            ]
        }))
        .pipe(gulp.dest('.'))
});

Options

  • base - Name of Base Application

  • clone - Name of Clone Application

  • file - File related options

    • rename [default: false] - Whether or not rename the output filename
    • name - if defined, the module will use this to rename the filename. Note that this will not totally replace the whole filename but only replace the string in relation to the host.
     Ex:
     filename : BASE-whatever.js
     output :  NEWNAME-whatever.js
     
    
    • stringCase [default: nc] - If you want to change case of filename
      • nc = Neutral Case
      • lc = Lower Case
      • uc = Upper Case
  • replaceValues

    • array of key value object
      • key : Can be a string or a regular expression
      • value : string
  • directory - Directory related options. Basically its the same as the file option. same parameters, same rule:

{
	rename : 'false',
	name : '',
	stringCase : 'nc'
}

Usage

You may look at the demo for clearer understanding of how can you use this module.


MIT LICENSE
copyright © 2016 Scripts and Pixels.

Package Sidebar

Install

npm i gulp-app-clonify

Weekly Downloads

1

Version

0.1.3

License

MIT

Last publish

Collaborators

  • johnturingan