A pure JavaScript implementation of git for node and browsers!
JavaScript Shell Roff
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add instructions to add yourself using all-contributors in the PR tem… May 19, 2018
__tests__ perf(ci): Skip building and testing for PRs with only cosmetic changes ( May 17, 2018
spec/support playing around with nock Mar 1, 2018
src feat: Added new 'authUsername' & 'authPassword' argument to getRemote… May 18, 2018
.all-contributorsrc feat: Added new 'authUsername' & 'authPassword' argument to getRemote… May 18, 2018
.babelrc chore(ci): Enable ChromeHeadless on Travis (#182) May 12, 2018
.editorconfig Add .editorconfig Aug 11, 2017
.gitignore Always generate __fixtures__/index.json dynamically. Mar 14, 2018
.releaserc perf(ci): Auto-tweet release announcements (#184) May 14, 2018
.travis.yml perf(ci): Skip building and testing for PRs with only cosmetic changes ( May 17, 2018
CODE_OF_CONDUCT.md chore: Add a code of conduct to foster sense of community (#175) May 11, 2018
CONTRIBUTING.md Add instructions to add yourself using all-contributors in the PR tem… May 19, 2018
LICENSE.md fix: Switch from The Unlicense to The MIT License (#105) Mar 19, 2018
README.md Use SVG version of Gitter icon in README.md (#200) May 19, 2018
cli.js Revert "REVERT RELEASE v0.0.34" Dec 28, 2017
karma.conf.js chore(ci): Enable ChromeHeadless on Travis (#182) May 12, 2018
package-lock.json feat: Added 'branch' command May 17, 2018
package-scripts.js feat: Replace browserify with webpack 4 (#142) Apr 26, 2018
package.json Add instructions to add yourself using all-contributors in the PR tem… May 19, 2018
renovate.json chore: Rename "dev-dependency" group to "devDependencies" for clarity ( May 12, 2018
rollup.config.js feat: Replace browserify with webpack 4 (#142) Apr 26, 2018
webpack.config.js feat: Replace browserify with webpack 4 (#142) Apr 26, 2018

README.md

isomorphic-git

A pure JavaScript implementation of git for node and browsers!

Latest release:

current npm version required node version written in ECMAScript 2017+ license gzip size install size

Master branch status:

semantic-release Build Status codecov dependencies Known Vulnerabilities FOSSA Status

Social:

Gitter chat Backers on Open Collective Sponsors on Open Collective

Browser Support:

Sauce Labs Test Status (for master branch)

isomorphic-git is a pure JavaScript implementation of git that works in node and browser environments (including WebWorkers and ServiceWorkers). This means it can be used to read and write to to git repositories, as well as fetch from and push to git remotes like Github.

Isomorphic-git aims for 100% interoperability with the canonical git implementation. This means it does all its operations by modifying files in a ".git" directory just like the git you are used to. The included isogit CLI can operate on git repositories on your desktop or server.

isomorphic-git aims to be a complete solution with no assembly required. I've tried carefully to design the API so it is easy to use all the features, without paying a penalty in bundle size. By providing functionality as separate functions instead of an object oriented API, code bundlers like Webpack will only include the functionality your application actually uses. (Or at least that's the goal.)

I am working on adding type definitions so you can enjoy static type-checking and intelligent code completion in editors like CodeSandbox.

Getting Started

The "isomorphic" in isomorphic-git means it works equally well on the server or the browser. That's tricky to do since git uses the file system, and browsers don't have an fs module. So rather than relying on the fs module, isomorphic-git is BYOFS (Bring Your Own File System). When creating a new Git object, you pass it the fs module to use.

If you're only using isomorphic-git in Node, you can just use the native fs module.

const git = require('isomorphic-git');
const fs = require('fs');
git.listFiles({fs, dir: __dirname});

If you're writing code for the browser though, you'll need something that emulates the fs API. At the time of writing, the most complete option is BrowserFS. It has a few more steps involved to set up than in Node, as seen below:

<script src="https://unpkg.com/browserfs"></script>
<script src="https://unpkg.com/isomorphic-git"></script>
<script>
BrowserFS.configure({ fs: "IndexedDB", options: {} }, function (err) {
  if (err) return console.log(err);
  window.fs = BrowserFS.BFSRequire("fs");
  git.listFiles({fs: window.fs, dir: '/'});
});
</script>

Besides IndexedDB, BrowserFS supports many different backends with different performance characteristics, as well as advanced configurations such as: multiple mounting points, and overlaying a writeable filesystems on top of a read-only filesystem. You don't need to know about all these features, but familiarizing yourself with the different options may be necessary if you hit a storage limit or performance bottleneck in the IndexedDB backend I suggested above.

View the full Getting Started guide here.

CORS support

Unfortunately, due to the same-origin policy by default isomorphic-git can only clone from the same origin as the webpage it is running on. This is terribly inconvenient, as it means for all practical purposes cloning and pushing repos must be done through a proxy. However, I am "being the change you want to see in the world" by making PRs to all the major git repository hosting services.

It is literally just two lines of code to add the CORS headers!! Easy stuff. Surely it will happen.

Using as an npm module

You can install it from npm.

npm install --save isomorphic-git

In the package.json you'll see there are actually 4 different versions:

  "main": "dist/for-node/",
  "browser": "dist/for-browserify/",
  "module": "dist/for-future/",
  "unpkg": "dist/bundle.umd.min.js",

This probably deserves a brief explanation.

  • the "main" version is for node.
  • the "browser" version is for browserify.
  • the "module" version is for native ES6 module loaders when they arrive.
  • the "unpkg" version is the UMD build.

For more details about each build see ./dist/README.md

isogit CLI

Isomorphic-git comes with a simple CLI tool, named isogit because isomorphic-git is a lot to type. It is really just a thin shell that translates command line arguments into the equivalent JS API commands. So you should be able to run any current or future isomorphic-git commands using the CLI.

It always starts with an the assumption that the current working directory is a git root. E.g. repo = new Git({fs, dir: '.'}).

It uses minimisted to parse command line options.

TODO: Document this more. Also write some tests? IDK the CLI is more of a lark for testing really.

Supported Git commands

I may continue to make changes to the API until the 1.0 release, after which I promise not to make any breaking changes.

commands

utils

Internal code architecture

I have written this library as a series of layers that build upon one another and should tree-shake very well:

Commands

Each command is available as its own file, so you are able to import individual commands if you only need a few in order to optimize your bundle size.

Managers

Managers are a level above models. They take care of implementation performance details like

  • batching reads to and from the file system
  • in-process concurrency locks
  • lockfiles
  • caching files and invalidating cached results
  • reusing objects
  • object memory pools

Models and Utils

Models and utils are the lowest level building blocks. Models generally have very few or no dependencies except for 'buffer'. This makes them portable to many different environments so they can be a useful lowest common denominator.

Utils are basically miscellaneous functions. Some are convenience wrappers for common filesystem operations.

Who is using isomorphic-git?

  • nde - a futuristic next-generation web IDE
  • git-app-manager - install "unhosted" websites locally by git cloning them

Similar projects

Acknowledgments

Isomorphic-git would not have been possible without the pioneering work by @creationix and @chrisdickinson. Git is a tricky binary mess, and without their examples (and their modules!) I would not have been able to come even close to finishing this. They are geniuses ahead of their time.

Contributors

Thanks goes to these wonderful people (emoji key):


William Hilton

📝 🐛 💻 🎨 📖 💡 ⚠️

wDhTIG

🐛

Marc MacLeod

🤔 🔍

Brett Zamir

🤔

Dan Allen

🐛 🤔

Tomáš Hübelbauer

🐛 💻

Juan Campa

🐛

Ira Miller

🐛

Rhys Arkins

💻

Sean Larkin

💻

Daniel Ruf

💻

bokuweb

💻 📖 ⚠️

Hiroki Osame

💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

License

This work is released under The MIT License

FOSSA Status