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

git9

v0.2.2

Published

Utilities for Git

Downloads

7

Readme

git9

npm

Utilities for Git.

Installation

npm install --save git9

Usage

import {
  getCommit,
  getCurrentCommit,
  hasCommit,
  isMerging,
  hasConflicts,
  getBranch,
  getCurrentBranch,
  getConfig,
  getRemoteURL,
  getRemoteCommit,
  getDifferences,
  getChangedFiles,
  downloadFile,
} from 'git9'

getCommit

function getCommit(committish: string): Promise<string>

Get commit hash with a commit-ish string.

getCurrentCommit

function getCurrentCommit(): Promise<string>

Get commit hash of the current branch.

hasCommit

function hasCommit(committish: string): Promise<boolean>

Check whether a specified branch or pointer exists.

isMerging

function isMerging(): Promise<boolean>

Check whether the working repository is in the merging state. Equivalent to hasCommit('MERGE_HEAD').

hasConflicts

function hasConflicts(subpath?: string): Promise<boolean>

Check whether the working repository has conflicts.

getBranch

function getBranch(committish: string): Promise<string>

Get the branch name of a commit-ish.

getCurrentBranch

function getCurrentBranch(): Promise<string>

Get the current branch name. Equivalent to getCurrentBranch('HEAD').

getConfig

function getConfig(config: string): Promise<string>

Get specified config value of the repository.

getRemoteURL

function getRemoteURL(name: string): Promise<string>

Get remote repository URL with specified name.

getRemoteCommit

function getRemoteCommit(url: string, committish: string): Promise<string>

Get commit hash with a commit-ish string from remote.

getDifferences

function getDifferences(committish: string): Promise<{
  name: string;
  status: string;
}[]>

Get differences between the current branch and the specified commit-ish.

Possible status letters are:

  • A: addition of a file
  • C: copy of a file into a new one
  • D: deletion of a file
  • M: modification of the contents or mode of a file
  • R: renaming of a file
  • T: change in the type of the file (regular file, symbolic link or submodule)
  • U: file is unmerged (you must complete the merge before it can be committed)
  • X: "unknown" change type (most probably a bug, please report it)

See git-diff.

getChangedFiles

function getChangedFiles(committish: string): Promise<string[]>

Get changed files in current branch from the specified commit-ish.

downloadFile

function downloadFile(url: string, committish: string, file: string): Promise<string>

Download specified file with a commit-ish string from remote using git-archive protocol.

[!NOTE] GitHub does not support git-archive protocol.