docs/errors.md

docs/add.md

docs/addNote.md

docs/addRemote.md

docs/checkout.md

docs/clone.md

docs/commit.md

docs/currentBranch.md

docs/deleteBranch.md

docs/deleteRef.md

docs/expandOid.md

docs/expandRef.md

docs/fetch.md

docs/findRoot.md

docs/getRemoteInfo.md

docs/hashBlob.md

docs/indexPack.md

docs/log.md

docs/merge.md

docs/packObjects.md

docs/pull.md

docs/push.md

docs/readBlob.md

docs/removeNote.md

docs/resetIndex.md

docs/resolveRef.md

docs/status.md

docs/statusMatrix.md

docs/tag.md

- [x] I think I'll tweak `readObject` and `writeObject` so that `readObject` doesn't have a crazy polymorphic return type and they somehow "fit" with all the more specific `read/write Blob/Commit/Tag/Tree` commands.

- [x] I think I will change the `plugins` API. The current API (`plugins.set('fs', fs)`) uses a kinda-hacky run-time schema validation that just checks whether certain methods are defined. Static type checking would actually provide a better developer experience and better guarantees, but having `.set` be polymorphic is hard to accurately describe using JSDoc, so I might switch to an API like `plugins.fs(fs)`.

- this also means we can set `new FileSystem(_fs)` in the `plugins.fs(fs)` command, because _we don't have to expose a getter like `plugins.get()`!_

- [ ] To go along with that, I'm experimenting with a way to make the API more aesthetic, eliminating the `emitter` plugin/argument and letting you chain event listeners onto running commands directly. NOTE: need to make sure there's no race condition between adding the event listeners and starting running the command.

- [ ] This also provides an aesthetic way to cancel / stop running commands.

const git = require('isomorphic-git');

const fs = require('fs');

If you're writing code for the browser though, you'll need something that emulates the `fs` API.

<script src="https://unpkg.com/isomorphic-git"></script>

<script>

</script>

- [writeTree](https://isomorphic-git.github.io/docs/writeTree.html)

- [writeRef](https://isomorphic-git.github.io/docs/writeRef.html)

## Community

Share your questions and ideas with us! We love that.

const pify = require('pify')

const { FileSystem } = require('isomorphic-git/internal-apis')

let browserFS = null

let browserFSwritable = null

async function makeBrowserFS (dir) {

const _fs = Object.assign({}, browserFS)

browserFSwritable.empty()

const fs = new FileSystem(_fs)

dir = `/${dir}`

_fs,

fs,

dir,

}

const { FileSystem } = require('isomorphic-git/internal-apis')

const localhost =

typeof window === 'undefined' ? 'localhost' : window.location.hostname

wipe: true,

url: `https://${localhost}:9876/base/__tests__/__fixtures__`

})

const fs = new FileSystem(_fs)

dir = `/${dir}`

const gitdir = `/${dir}.git`

await fs.mkdir(dir)

await fs.mkdir(gitdir)

module.exports.makeLightningFS = makeLightningFS

const path = require('path')

const { FileSystem } = require('isomorphic-git/internal-apis')

async function makeNodeFixture (fixture) {

const _fs = Object.assign({}, require('fs'))

const fs = new FileSystem(_fs)

? await copyFixtureIntoTempDir(testsDir, `${fixture}.git`)

: await createTempDir()

module.exports.makeNodeFixture = makeNodeFixture

const table = require('markdown-table')

const git = require('../..')

const dir = path.join(__dirname, '..', '..')

const ref = process.argv[2] || 'HEAD'

async function gendoc (file, filepath) {

// Fix some TypeScript-isms that jsdoc doesn't like

file = file.replace(/\{import\('events'\)\.EventEmitter\}/g, '{EventEmitter}')

let ast

try {

ast = await jsdoc.explain({ source: file })

if (param.name === '_' || param.name === 'args') continue

let name = param.name.replace('_.', '').replace('args.', '')

if (!param.optional) name = `**${name}**`

let type = param.type.names.map(escapeType).join(' | ')

if (param.type.names[0] === 'function') {

gitignoreContent += '# AUTO-GENERATED DOCS --- DO NOT EDIT BELOW THIS LINE\n'

gitignoreContent += 'docs/errors.md\n'

const entries = tree.filter(

entry => entry.type === 'blob' && !entry.path.startsWith('_')

)

const docs = []

// Load file

const { blob } = await git.readBlob({

dir,

oid,

})

const filetext = Buffer.from(blob).toString('utf8')

if (doctext !== '') {

fs.writeFileSync(path.join(docDir, docfilename), doctext)

docs.push(`docs/${docfilename}`)

}

}

// Generate the shared typedefs

// Generate all the docs

docs.sort()

gitignoreContent += docs.join('\n') + '\n'

const docFile = path.join(__dirname, '..', '..', 'docs', 'errors.md')

const { blob } = await git.readBlob({

dir,

oid,

filepath: 'src/models/GitError.js'