samypesse/gitkit-js

Pure javascript implementation of Git (Node.js and Browser)

gitkit-js's Issues

Add operation complains about a missing index file

The add operation should create the .git/index file if it doesn't already exist.

It is due to this call from the WorkingUtils.add function:

https://github.com/SamyPesse/gitkit-js/blob/master/lib/models/workingIndex.js#L82-L94

Add table of comparison with nodegit.org

What is the effective difference between this and NodeGit? Maybe the fact it runs in the browser? Can we have a table of comparison between both in the README so that we can understand what are the differences and adapt to our use cases?

Thanks.

Please provide TypeScript definitions for the library

Library looks really cool, but given the size of the API (and lack of docs), it could be extremely helpful to have TypeScript definitions that editors could use for suggestions on the method names, types etc.

Add support for npm

As stated at NodeOS/NodeOS#67 (comment), add support to make gitkit capable to be used by npm as a valid git cli command. Needed functionality is:

• git config --get remote..url
• git rev-list -n1 master
• git checkout [something]
• git clone [param] [param]
• git clone --template=[value] --mirror [param] [param]

Incorrect link to license file in README.md

The README points to LICENSE.md, but this repository has LICENSEinstead of LICENSE.md, thus resulting in a 404 error when clicking it on GitHub.

Trying to get in touch regarding a security issue

Hey there!

I'd like to report a security issue but cannot find contact instructions on your repository.

If not a hassle, might you kindly add a SECURITY.md file with an email, or another contact method? GitHub recommends this best practice to ensure security issues are responsibly disclosed, and it would serve as a simple instruction for security researchers in the future.

Thank you for your consideration, and I look forward to hearing from you!

(cc @huntr-helper)

API methods

Hi! Very interesting project. Thanks a lot for sharing!

I was wondering whether you'd consider revising naming conventions to be a bit less verbose and closer to git's syntax. What I mean is:

const git = new GitKit({
  repo: REPOSITORY_URL,
  user: REPOSITORY_USER
});

git.commit('initial commit, '*');
git.commit('initial commit, [
  'app.js',
  'scripts.js'
]);

git.branch.current()
git.branch.checkout('develop/feature/profile-update')

Not all of them would be as simple of course, since checkout() might also need to be accompanied by checkoutNew etc. but I hope you know what I mean.

How to use gitkit inside the browser?

Please update the README with guidance about How to use gitkit inside the browser.

Path must be a string. Received undefined

Using GitKit v0.1.0 to clone a repository with isBare = false I get the aforementioned error. Setting isBare to true doesn't give the error.

var isBare = false;
var repo = GitKit.Repository.createWithFS(NodeFS('/tmp/repo'), isBare);
var transport = new GitKit.HTTPTransport('https://github.com/marcuswhybrow/marcus.codes.git');

GitKit.RepoUtils.init(repo)
    .then(() => GitKit.TransferUtils.clone(repo, transport))

This is my stack trace:

"assertPath (path.js:8:11)",
"Object.posix.join (path.js:479:5)",
"Record.Repository.getGitPath (/var/task/node_modules/gitkit/lib/models/repo.js:65:43)",
"Record.Repository.readGitFile (/var/task/node_modules/gitkit/lib/models/repo.js:75:21)",
"Function.Ref.readFromRepo (/var/task/node_modules/gitkit/lib/models/ref.js:85:17)",
"Object.checkout (/var/task/node_modules/gitkit/lib/RepoUtils/checkout.js:79:16)",
"/var/task/node_modules/gitkit/lib/TransferUtils/clone.js:18:26",
"_fulfilled (/var/task/node_modules/gitkit/node_modules/q/q.js:834:54)",
"self.promiseDispatch.done (/var/task/node_modules/gitkit/node_modules/q/q.js:863:30)",
"Promise.promise.promiseDispatch (/var/task/node_modules/gitkit/node_modules/q/q.js:796:13)"

[bounty] Shallow Clone a Tag

I'd like to be able to point to an https url such as https://git.coolaj86.com/greenlock.js retrieve a list of branches and tags, such as v.2.2 and v2.2.3, and then shallow clone that tag.

I'd like to know

A) if this is already possible
B) what it would cost for it to be built if it isn't

Remove requirement for git for installation

It looks like this requires a command line git before it can be installed because when I try to install this in a container on https://hyperdev.com/, I get the following in error logs:

 ERR! git clone --template=/app/.npm/_git-remotes/_templates --mirror [email protected]:deoxxa/dissolve.git /app/.npm/_git-remotes/git-github-com-deoxxa-dissolve-git-4ec7095e: undefined
npm ERR! git clone --template=/app/.npm/_git-remotes/_templates --mirror [email protected]:deoxxa/dissolve.git /app/.npm/_git-remotes/git-github-com-deoxxa-dissolve-git-4ec7095e: undefined
 ERR! Linux 4.4.8-fc
npm ERR! argv "/app/.nodejs/bin/node" "/app/.nodejs/bin/npm" "install"
npm ERR! node v4.4.3
npm ERR! npm  v2.15.1
 ERR! code ENOGIT

npm ERR! not found: git
npm ERR!

npm 
ERR! Failed using git.
npm 
ERR! This is most likely not a problem with npm itself.
npm ERR! Please check if you have git installed and in your PATH.

Implement fs instance for browser

GitKit currently only implements an FS for Node.js, it should provides an FS storing file in the localstorage/memory.

Comparison with js-git: https://github.com/creationix/js-git

What are the major differences?

Publish a complete documentation as a GitBook