npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@riboseinc/isogit-lfs

v0.2.0

Published

LFS helpers for Isomorphic Git

Downloads

19

Readme

Aspirationally, a set of helpers to simplify working with Git LFS through Isomorphic Git.

Currently the API is fairly low-level.

NOTE: While Isomorphic Git maintenance status is unclear, this library is in turn not likely to receive new features.

== Installation

Peer dependencies:

  • Isomorphic Git ^1.7.8
  • @aws-crypto/sha256-universal ^2.0.0

== Usage

As of 0.2.0 (to be released), API offers the following functions (blobs are Uint8Array instances):

  • downloadBlobFromPointer({ http, headers, url, auth }, lfsPointer) => Uint8Array

where http is an HttpClient as supported by Isomorphic Git, URL is repository URL and lfsPointer is an object returned by readPointer(). + Uses cache, if the object had been previously retrieved.

  • uploadBlob({ http, headers, url, auth }, blob) => PointerInfo

where first argument is the same as for the download function, and returned pointer info can be used to write a pointer file in place of actual object in Git repository (pass it through formatPointerInfo()).

  • readPointer({ gitdir, content }) => Pointer

where gitdir behavior mimics that of Isomorphic Git (for non-bare repositories it’s not working directory but the .git in it) and content is a Uint8Array. + Returns an LFS pointer together with Git repo object path of the full blob (which may or may not be retrieved).

  • readPointerInfo(blob) => PointerInfo

converts a Uint8Array into an LFS pointer structure sufficient for requesting actual LFS blob.

  • formatPointerInfo(lfsPointerInfo) => Uint8Array

converts pointer info to appropriately formatted blob suitable to be stored in Git repository in place of actual object data.

  • populateCache(gitdir, ref?)

where gitdir is same as for readPointer() and ref should probably be left at the default "HEAD". + Attempts to download all LFS objects. + NOTE: This particular function is a very tentative piece of API. Downloads are not particularly optimized, it’s likely quite slow.

== Known shortcomings

  • The @aws-crypto/sha256-universal dependency is suboptimal. It pulls extra dependencies of its own, while it’s not that difficult to provide corresponding implementation using subtle crypto which is compatible between Node and modern browsers.
  • Originally written for Node runtime, but should work in browser as of 0.2.0.
  • Lacks automated tests.

== Considered within scope

  • Implement batch uploads and downloads (parallelise requests? use native batch API?)
  • Find a way to generalize UA header handling
  • Make it work in browser runtime as well (if feasible?) — should be done in 0.2.0