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

@ghost-fvtt/foundry-publish

v3.0.0

Published

A tool to publish packages for Foundry Virtual Tabletop

Downloads

77

Readme

Foundry Publish

Checks npm downloads Docker pulls REUSE status Ko-fi

Foundry Publish is a CLI tool that developers can use to add new versions of their packages for Foundry Virtual Tabletop to the Package Administration.

Usage

You can run Foundry Publish with npx:

npx @ghost-fvtt/foundry-publish [options]

Alternatively you can install it globally and then execute it:

npm install -g @ghost-fvtt/foundry-publish
foundry-publish [options]

Options

In order to use Foundry Publish, you need to provide several parameters. They can be provided either as environment variables or as command line options, with one exception: For security reasons, the password required to authenticate with the Package Administration can only be provided as environment variable. Additionally, a couple of options can also be read from a manifest file.

| Command Line Parameter | Environment Variable | Manifest Property | Description | Required | | -------------------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -------- | | --changelogURL | FVTT_CHANGELOG_URL | changelog | The URL of the changelog of the package version being published | No | | --deleteObsoleteVersions | FVTT_DELETE_OBSOLETE_VERSIONS | | Delete obsolete versions, i.e., all versions with the same compatible core version as the version being published | No | | --dryRun | FVTT_DRY_RUN | | Just perform a dry run instead of actually publishing the package | No | | --headed | FVTT_HEADED | | Run in headed mode, to be able to see the browser interaction | No | | --manifestURL | FVTT_MANIFEST_URL | manifest | The URL of the manifest of the package version being published | Yes | | --manifestPath | FVTT_MANIFEST_PATH | | A path to a manifest file to read information from | No | | --maximumCoreVersion | FVTT_MAXIMUM_CORE_VERSION | compatibility.maximum, | The maximum version of the core Foundry software which is allowed to use the package | No | | --minimumCoreVersion | FVTT_MINIMUM_CORE_VERSION | compatibility.minimum, minimumCoreVersion | The minimum version of the core Foundry software which is required to use the package | Yes | | --packageID | FVTT_PACKAGE_ID | id | The ID of the package—the id from the manifest | Yes | | --packageVersion | FVTT_PACKAGE_VERSION | version | The version of the package | Yes | | | FVTT_PASSWORD | | The password of the account for accessing the Foundry VTT administration page | Yes | | --username | FVTT_USERNAME | | The username of the account for accessing the Foundry VTT administration page (you may need to use the email address) | Yes | | --verifiedCoreVersion, --compatibleCoreVersion | FVTT_VERIFIED_CORE_VERSION, FVTT_COMPATIBLE_CORE_VERSION | compatibility.verified, compatibleCoreVersion | The maximum version of the core Foundry software for which compatibility of the package has been verified | Yes |

Development

Prerequisites

In order to build this project, recent versions of node and npm are required. We recommend using the latest lts version of node. If you use nvm of fnm to manage your node versions, you can simply run

nvm install

or

fnm install

in the project's root directory.

You also need to install the project's dependencies. To do so, run

npm install

Building

You can build the project by running

npm run build

Alternatively, you can run

npm run watch

to watch for changes and automatically build as necessary.

Contributing

Contributions via pull requests are very welcome. If you find any issues, please report them in the issue tracker.

Licensing

This project uses REUSE to specify the used licenses. Currently, everything is licensed under the MIT license. More information (including the copyright holders) can be found in the individual files.

Acknowledgment

This project is heavily based on eXaminator's foundry-auto-release. Thanks for the great work!