npm install gulp-hg
#gulp-hg
| Package | gulp-hg |
| Description | Hg mercurial plugin for gulp (gulpjs.com) |
* init
* clone
* add
* commit
* branch
* branches
* merge
* log
* pull
* push
* status
* update
* summary
* revert
``javascript
var gulp = require('gulp');
var hg = require('gulp-hg');
// Init repository
gulp.task('init', function() {
hg.init(function(error, stdout) {
if (!error) {
// Repository initialized
}
});
});
// Clone remote repository to current directory
gulp.task('clone', function() {
hg.clone('https://matteovinci@bitbucket.org/matteovinci/gulp-hg-test-repo', function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Clone remote repository to a specific folder
gulp.task('clonesubfolder', function() {
hg.clone('https://matteovinci@bitbucket.org/matteovinci/gulp-hg-test-repo', './sub/folder', function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Add all files within a specific folder (or in the current one ./*)
gulp.task('add', function() {
gulp.src('./my-files/*')
.pipe(hg.add(function(error, stdout) {
if (!error) {
// Completed
}
}));
});
// Commit files within a specific folder (or in the current one ./*)
gulp.task('commit', function() {
gulp.src('./my-files-to-be-committed/*', {buffer: false})
.pipe(hg.commit('initial commit', function(error, stdout) {
if (!error) {
// Completed
}
}));
});
// Commit files with arguments
gulp.task('commitargs', function() {
gulp.src('./my-files-to-be-committed/*')
.pipe(hg.commit('initial commit', {args: '--amend'}, function(error, stdout) {
if (!error) {
// Completed
}
}));
});
// Commit files with raw arguments only
gulp.task('commitargs', function() {
gulp.src('./my-files-to-be-committed/*')
.pipe(hg.commit(undefined, {args: '-m "First commit"', disableMessageRequirement: true}, function(error, stdout) {
if (!error) {
// Completed
}
}));
});
// Branch
// Get the current branch name
gulp.task('branch', function() {
hg.branch({cwd: './myRepoPath'}, function(error, branchName) {
if (!error) {
// Completed
console.log('Current branch name', branchName);
}
});
});
// Create a new branch on the repository
gulp.task('branch', function() {
hg.branch('new-branch', {cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Branch created successfully
}
});
});
// Branches list
gulp.task('branches', function() {
hg.branches({cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
console.log('Branches', stdout);
}
});
});
// Merge
gulp.task('merge', function() {
hg.merge({cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Log
gulp.task('log', function() {
hg.log(function(error, stdout) {
if (!error) {
// Push completed
}
});
});
// Pull from remote repository
gulp.task('pull', function() {
hg.pull({cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Push to remote repository
gulp.task('push', function() {
hg.push('https://matteovinci@bitbucket.org/matteovinci/gulp-hg-test-repo', {cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Status
gulp.task('status', function() {
hg.status({cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Update
// Using a specific branch
gulp.task('update', function() {
hg.update('default', {cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Using the current branch
gulp.task('update', function() {
hg.update({cwd: './myRepoPath'}, function(error, stdout) {
if (!error) {
// Completed
}
});
});
// Summary
gulp.task('summary', function() {
hg.summary(function(error, stdout) {
if (!error) {
// Summary completed
}
});
});
// Revert
gulp.task('revert', function() {
hg.revert(function(error, stdout) {
if (!error) {
// Revert completed
}
});
});
`
Creates an empty hg repository
: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.init({cwd: 'myRepoFolder'}, function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Clones a remote repository for the first time in the current folder
: String, remote urloptions: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.clone('https://matteovinci@bitbucket.org/matteovinci/gulp-hg-test-repo', function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Clones a remote repository to a destination folder
: String, remote urldestination: String, destination folderoptions: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.clone('https://matteovinci@bitbucket.org/matteovinci/gulp-hg-test-repo', './my-sub-folder', function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Adds files to repository
: Object (optional) {args: 'options'}
: function, passed error (if any) and command stdout
`js
gulp.src('./*')
.pipe(hg.add(function(error, stdout) {
if (!error) {
// Add completed
console.log('stdout', stdout);
}
}));
`$3
Commits changes to repository
: String, commit messageoptions: Object (optional) {args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024}: function, passed error (if any) and command stdout`js
gulp.src('./*')
.pipe(hg.commit('commit message', function(error, stdout) {
if (!error) {
// Commit completed
}
}));
`
$3
Creates a new branch but doesn't switch to it
: String (optional), branch to create (if not defined the function will return the current tip branch)options: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.branch('development', function(error, stdout) {
if (!error) {
// Branch added
}
});
`$3
Returns the current branch name
: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.branch(function(error, stdout) {
if (!error) {
// Completed
console.log('Current branch', stdout);
}
});
`$3
List repository named branches
: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.branches(function(error, stdout) {
if (!error) {
// Completed
console.log('Branches', stdout);
}
});
`$3
Merges a branch into the current branch
: String, source branchoptions: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.merge('development', function(error, stdout) {
if (!error) {
// branch completed
}
});
`$3
Show the working tree log
: Object (optional) {args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024}: function (optional), passed error and command stdout`js
hg.log({args : '-v'}, function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Pulls changes from remote repository
: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.pull(function(error, stdout) {
if (!error) {
// Commit completed
}
});
`$3
Pushes changes to remote repository
: String, branch, default: default: Object (optional) {args: 'options', cwd: '/cwd/path'}: function, passed error (if any) and command stdout`js
hg.push('default', function(error, stdout) {
if (!error) {
// Commit completed
}
});
`$3
Show the working tree status
: Object (optional) {args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024}: function (optional), passed error (if any) and command stdout`js
hg.status({args : '--tag'}, function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Update the repository to a specific branch
: String (optional), branchoptions: Object (optional) {args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024}: function (optional), passed error (if any) and command stdout`js
// Using a specific branch
gulp.task('update', function() {
hg.update('default', function(error, stdout) {
if (!error) {
// Completed
}
});
});// Using the current branch
gulp.task('update', function() {
hg.update(function(error, stdout) {
if (!error) {
// Completed
}
});
});
`$3
Summarize working directory state
: Object (optional) {args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024}: function (optional), passed error and command stdout`js
hg.summary(function (error, stdout) {
if (!error) {
// Operation completed
}
});hg.summary({args: '--remote'}, function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Restore files to their checkout state
: Object (optional) {args: 'options', cwd: '/cwd/path', maxBuffer: 200 * 1024}: function (optional), passed error and command stdout`js
hg.revert({args: '--all'}, function (error, stdout) {
if (!error) {
// Operation completed
}
});
`$3
Show the working tree log
: Object (optional) {args: 'options', cwd: '/cwd/path'}: function (optional), passed error and command stdout`js
hg.pull({args : '--branch my-branch'}, function (error, stdout) {
if (!error) {
//pull completed
}
});
`##Utils
$3
Check if the current directory is a mercurial repository
: Object (optional) {cwd: '/cwd/path'}js
var isHg = hg.utils.isHg({cwd: './pathToMyCurrentRepoFolder'});
``(MIT License)
Copyright (c) 2017 Matteo Vinci
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.