gfc

v2.0.2

Published

2 years ago

Simple way to initialize a new git repository in an empty directory, add a file and do a first commit (or skip that part in a directory with files). Useful for unit tests and generators.

Downloads

154

0High
0Medium
0Low

johno

jonschlinkert

add commit first first-commit git git-add git-commit git-init init

gfc

Simple way to initialize a new git repository in an empty directory, add a file and do a first commit (or skip that part in a directory with files). Useful for unit tests and generators.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save gfc

Usage

const firstCommit = require('gfc');

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"

promise usage

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));

async usage

firstCommit(cwd[, options], function(err, stdout, stderr) {
  if (err) {
    console.error('exec error: ' + err);
    return;
  }
  console.log('stdout: ' + stdout);
  console.log('stderr: ' + stderr);
});

sync usage

firstCommit.sync(cwd[, options]);

Options

options.file

Type: object|boolean

Default: { path: '.gitkeep', contents: '' }

firstCommit.sync('foo/bar', { file: false })

options.message

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!');
  }
});

options.exec

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);

About

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

git-branch: Get the current branch for a local git repository. | homepage
git-user-name: Get a user's name from git config at the project or global scope, depending on… more | homepage
git-username: Get the username (or 'owner' name) from a git/GitHub remote origin URL. | homepage
list-git-remotes: List the remotes for a local git repository. Sync and async. | homepage

Contributors

| Commits | Contributor | | --- | --- | | 6 | johno | | 6 | jonschlinkert |

Author

Jon Schlinkert

License

This file was generated by verb-generate-readme, v0.6.0, on March 09, 2018.