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

makestatic-build-version

v1.0.5

Published

Generate project build versions

Downloads

1

Readme

Build Version

Generate project version information



Install

yarn add makestatic-build-version

API

BuildVersion

Create version information for a project.

Generates version information and assigns it to the processing context.

Other plugins can consume the version information to generate meta data, visible DOM elements or to create versioned archives.

See Also

BuildVersion

new BuildVersion(context, options)

Creates a BuildVersion plugin.

Provides functions that will extract the version field from package.json (package option) and get the latest git commit hash (commit option).

Result values are assigned to context.data.versions so to retrieve the package version you would access context.data.versions.package or context.data.versions.commit for the git commit hash.

You can supply your own version functions using the versions option, each function is passed the processing context and plugin options and should return a version. If a version function needs to operate asynchronously it should return a promise.

The signature for a version function:

function getVersion(context, options)

When no git option is set the command git rev-parse --verify HEAD is used.

  • context Object the processing context.
  • options Object plugin options.
Options
  • package Boolean=true extract version from package.json.
  • commit Boolean=false extract version from last git commit.
  • git String command to execute to extract commit hash.
  • versions Object map of custom version functions.

.getPackage

BuildVersion.prototype.getPackage(context, options)

Requires package.json from the current working directory and returns the version field.

Returns package version string.

  • context Object the processing context.
  • options Object plugin options.
Throws
  • Error if the call to require package.json fails.

.getCommit

BuildVersion.prototype.getCommit(context, options)

Runs the git rev-parse command and resolves the result from the stdout of the command execution.

Leading and trailing whitespace is removed from the command result.

Returns a promise that resolves to the stdout of the command.

  • context Object the processing context.
  • options Object plugin options.

.before

BuildVersion.prototype.before(context, options)

Configure the map of versions to generate.

  • context Object the processing context.
  • options Object plugin options.

.after

BuildVersion.prototype.after(context, options)

Call version generation functions and assign the results to the processing context.

  • context Object the processing context.
  • options Object plugin options.
Throws
  • Error if a version function errors.

License

MIT


Created by mkdoc on March 12, 2017