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

generator-nwjs-nodegit

v0.0.1

Published

Yeoman generator

Downloads

8

Readme

Why nwjs-nodegit?

This Yeoman generator covers the resources, steps and gotchas relating to running nodegit inside of nw.js. The focus is on build dependencies and verification and not architectural structure.

Note : This has only been tested on Mac OS.

Pre-requisites

Quickstart Steps

After you have installed the tools above - Try these terminal commands first and see the additional information/resources below if you get stuck.

npm install -g nw-gyp
npm install -g generator-nwjs-nodegit
mkdir myTest && cd myTest && yo nwjs-nodegit
alias nw="/Applications/nwjs.app/Contents/MacOS/nwjs"
nw nwapp

If this has worked correctly, you should see a webkit instance open. You should also see console.log output showing git history comments from the sample repo included in the generator template.

Conceptual Overview

This Yeoman project template is intended to facilitate setting up a node-webkit (nw.js) project build that includes the nodegit native library.

The main difficulty arises from the fact that nodegit consists of node bindings to the native libgit2 component. This means that libgit2 must be compiled for the specific operating system and version of nw.js webkit being developed.

Additional Resources

All the information above was consolidated from the resources below.

Also, the Yeoman template includes a gulp build that includes node-webkit-builder

Common Errors

The most common error is -

    Module version mismatch. Expected 14, got 43.
Stack:
  Error: Module version mismatch. Expected 14, got 43.

This error arises when you are trying to run a version of libgit2 that is not compiled for your OS and version of webkit. When you npm install nodegit the install script compiles the native component. If you have not specified the correct version up front then will likely see the above error.

This issue can be corrected after the fact by recompiling nodegit libgit2 with nw-gyp. For example,

  nw-gyp rebuild --target=0.12.2

You can find more detail at here

Also, note that the configuration called out here has already been included within the generator template here.

Once this configuration is set up and

License

MIT