const firstCommit = require('{%= name %}');
The main export is an async function that takes a callback or returns a promise when no callback is passed. A .sync method is also exposed.
Default behavior
The following steps can be customized with options:
- Creates a new git repository
- Adds a
.gitkeep
file if the cwd is empty. git add .
- do a first commit with the message
"first commit"
Returns a promise if a callback is not passed.
firstCommit(cwd[, options])
.then(res => {
console.log('stdout: ' + res.stdout);
console.log('stderr: ' + res.stderr);
})
.catch(err => console.log('Error: ', err));
firstCommit(cwd[, options], function(err, stdout, stderr) {
if (err) {
console.error('exec error: ' + err);
return;
}
console.log('stdout: ' + stdout);
console.log('stderr: ' + stderr);
});
firstCommit.sync(cwd[, options]);
Type: object|boolean
Default: { path: '.gitkeep', contents: '' }
firstCommit.sync('foo/bar', { file: false })
Type: string
Default: 'first commit'
var options = {message: 'my amazing first commit'};
firstCommit('foo/bar', options, function(err) {
if (err) {
console.log(err);
} else {
console.log('done!');
}
});
Type: object
Default: undefined
Options to pass to execSync.
var options = {
message: 'my amazing first commit',
exec: {
timeout: 3000,
killSignal: 'SIGTERM'
}
};
firstCommit.sync('foo/bar', options);