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

@tylerbu/hugo-installer

v1.1.0

Published

Installs hugo into your repository.

Downloads

5

Readme

hugo-installer

Installs Hugo into your repository.

npm version dependency status travis ci build status license

What it does

Hugo is one of the most popular static site generators. Now, when it comes to web development, we usually select npm as our dependency management solution. Hugo, however, is a tool written in Go. As a consequence, Hugo is not integrated into the npm module ecosystem - but instead delivered as a binary.

The Hugo Installer is here to help! It's a small node script which can be used to fetch a specific Hugo binary, for instance using the postinstall hook within a package.json file.

I've written this small tool because I'm developing my own personal website using Hugo, and I wanted to have a simple way of seeing the current Hugo version / simply upgrading Hugo to a newer version.

How to install

You can get the hugo-installer via npm by adding it as a new devDependency to your package.json file and running npm install. Alternatively, run the following command:

npm install hugo-installer --save-dev

How to use

We recommended to use the hugo-installer within the postinstall hook of a project's package.json file.

Configure hugo version (required)

The Hugo version can be set using the --version CLI parameter. For example:

{
  "scripts": {
    "postinstall": "hugo-installer --version 0.46"
  }
}

As an alternative, the --version CLI parameter can also be an object path to some value defined in the package.json file. This allows for the hugo version to be configured someplace else, e.g. in a otherDependencies object:

{
  "otherDependencies": {
    "hugo": "0.46"
  },
  "scripts": {
    "postinstall": "hugo-installer --version otherDependencies.hugo"
  }
}

Configure binary path (optional)

The --destination CLI parameter can be used to define the folder into which the Hugo binary will be placed. This parameter is optional, the default destination path is bin/hugo. For example:

{
  "scripts": {
    "postinstall": "hugo-installer --version 0.46 --destination bin/hugo"
  }
}

Don't forget to add the destination path to your .gitignore file!

Using the Hugo binary

Once fetched, the hugo binary can be used directly from your favourite command line. For example:

bin/hugo/hugo.exe --config=hugo.config.json

Alternatively, one might also want to integrate Hugo in a NodeJS build script, or a NodeJS-based build tool such as Gulp. You can execute the Hugo binary using the spawn command; for example:

const path = require( 'path' );
const spawn = require( 'child_process' ).spawn;

// Use Hugo
spawn( path.resolve( process.cwd(), 'bin', 'hugo', 'hugo' ), [
  `--config=hugo.config.json`
], {
  stdio: 'inherit'
} )
  .on( 'close', () => {
    // Callback
  } );

Creator

Dominique Müller