docs: Module "buffer" has been externalized for browser compatibility

[milahu]

when i run isomorphic-git in a browser, i get this error

Module "buffer" has been externalized for browser compatibility. Cannot access "buffer.Buffer" in client code

with vite bundler, this is fixed by adding the buffer package

import { Buffer } from 'buffer'
globalThis.Buffer = Buffer

vitejs/vite#2785

lets add this to readme?

https://github.com/isomorphic-git/isomorphic-git#getting-started

If you're using isomorphic-git in the browser, you'll need something that emulates the fs API.

full code

// fix: Module "buffer" has been externalized for browser compatibility. Cannot access "buffer.Buffer" in client code
import { Buffer } from 'buffer'
globalThis.Buffer = Buffer

import h from 'hyperscript';
import * as git from "isomorphic-git"
import http from 'isomorphic-git/http/web'
import LightningFS from "@isomorphic-git/lightning-fs"

var button = h("button", "git clone");
button.onclick = async () => {
  const fs = new LightningFS('fs')
  const dir = '/test-clone'
  git.clone({
    fs,
    http,
    dir,
    url: 'https://github.com/isomorphic-git/lightning-fs',
    corsProxy: 'https://cors.isomorphic-git.org'
  }).then(console.log)
  // FIXME undefined
}
document.body.appendChild(button);

[jcubic]

I think that README is not a good place for this. I believe there was a FAQ somewhere but I can't find a link on the website.

[milahu]

https://github.com/isomorphic-git/isomorphic-git#getting-started
https://isomorphic-git.org/docs/en/quickstart
https://isomorphic-git.org/docs/en/faq

maybe it "just works" with other bundlers (webpack, browserify, ...)
because they polyfill the buffer module by default
but in vite, i have to do it manually

[jcubic]

There was a PR #925 to remove Buffer dependency but it was not finished someone wanted to take over the work but it seems that he didn't.

If you think that README is the best place for this you can update it with a section about Vite.