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

@jeanlauliac/upd-configure

v0.1.0

Published

Generate `updfile.json` manifests for the `upd` utility

Downloads

1

Readme

upd-configure

Generate updfile.json manifests for the upd utility

Description

When updating a project using the upd utility, you need to provide a file called updfile.json at the root of the project, called the manifest. Even though you can write this file manually, this is inconvenient because it is formatted with bare JSON and it does not allow dynamic choices based on the environment. For example, on one platform you may want to compile C++ using gcc while on another you may want to use clang++.

To alleviate this limitation you can write a script, in any language, that will have the responsability to generate the updfile.json file the first time the project is worked on. Generally this script is named configure, or in the case of JavaScript, configure.js.

upd-configure provide utility functions to generate such a manifest file.

Interface

upd_configure.Manifest

This class represents a manifest being built.

const manifest = new Manifest();

manifest.cli_template(binary_path, args)

  • binary_path: string The name or the path of the command to run. If this is just name, then it'll be search for in the $PATH.
  • args: Array<ArgsPart> The argument templates.
  • Returns: an opaque object representing the template.

This creates a new command-line template in the manifest and returns a handle to that template. That handle can be used in update rules.

manifest.source(pattern)

TODO

manifest.rule(cli_template, inputs, output_pattern, dependencies)

TODO

manifest.export(dirname)

  • dirname: string: the path of the project's root directory.

This writes the manifest to the updfile.json file. dirname should generally just be set to __dirname if your configure.js script is at the root of the project.