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

repomine

v1.0.4

Published

library cloning and updating repositories

Downloads

4

Readme

repomine

Basic usage

repomine.update({
    path: './destination_directory',
    repos: [{
        dir: 'repository-dir-name',
        git: 'https://github.com/link/to/repository'
    }]
})

Info

Repomine update() method verifies target path and then clones or fast forwards repositories returning ES6 promise object.

decorating settings object passed as a parameter.

Promise should always resolve with settings object, passed as a parameter, decorated with fullPath propery and additionally each repo object will get couple of properies: ready and error.

If error occurs during clonning or updating it will be attached to individual repo object on repos property.

Notes

Original gitnode package has been replaced with much slower, simple-git, due to issues with cloning private repositories. Following nodegit blog post solves cloning issues only, fetching authentication still fails, original commit is here

Currently used simple-git library is a wrapper executing shell commands. That means git has to be configured on local box.

Example

Executing below code from local folder

var repomine = require('repomine')

repomine.update({
    path: './tmp',
    repos: [{
        dir: "jewelines",
        git: "https://github.com/indieforger/page-jewelines"
    },{
        dir: "xenoempires",
        git: "https://github.com/indieforger/page-xenoempires",
        ignore: true
    }]
}).then((obj) => {
    console.log(obj)
}, (err) => {
    console.log(err)
})

Should output something like

{ path: './tmp',
  repos:
   [ { dir: 'jewelines',
       git: 'https://github.com/indieforger/page-jewelines',
       ready: true,
       error: null },
     { dir: 'xenoempires',
       git: 'https://github.com/indieforger/page-xenoempires',
       ignore: true,
       ready: false,
       error: [Error: Repository was ignored] } ],
  fullPath: '/Users/Indieforger/repomine/node_modules/verify-path/tmp' }