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

shenanigans-manager

v0.8.15

Published

Manages large-scale operations on FullScreenShenanigans project.

Downloads

24

Readme

shenanigans-manager

NPM version

Manages locally installed FullScreenShenanigans modules for development.

shenanigans-manager is a development dependency of all FullScreenShenanigans modules. It sets up files that are kept standard across the repositories, such as GitHub templates, README.mds, and test infrastructure.

It can also be used as a CLI while developing those modules locally.

CLI

npm install -g shenanigans-manager

shenanigans-manager --help

The shenanigans-manager CLI provides commands that are often useful for developing multiple modules. The full list of commands is in src/Commands; the common ones are:

  • generate-tests: Creates test setup and HTML files for a repository to allow it to run unit tests, which necessitates reading for all .test.ts? files in its src/ directory.
    • If --watch is provided, it'll stay in a watcher mode and continuously recreate those files whenever they're changed on disk.
  • hydrate: Creates the shared file segments common to all EightBittr monorepo packages:
    • hydrate-package-json: Copies a few common portions of package.json, including its scripts.
    • hydrate-readme: Copies the top and bottom portions of README.md.
  • link-packages: Runs yarn link for each package in this monorepo.
  • publish-if-updated: Runs npm publish if and only if a package's version is different from the newest published version in the npm registry.

Package Settings

Modules should declare a "shenanigans" section in their package.json. It may contain the following keys, out of which only name is required:

  • name: PascalCase name of the package, such as "EightBittr".
  • dist: Whether the package should also include a dist command that generates a Webpack-bundled dist/ directory.
  • game: Whether the package's code should be structured as a game inheriting from EightBittr.
  • external: Whether the package is a standalone repository outside of the EightBittr monorepo.
  • loading: Settings for how to prepare the package for browser usage.
    • entries: Any additional Webpack entry points for creating output files.
    • externals: Non-EightBittr dependencies this will need to load before running.
  • mode: Either an "external" package that exists on its own or an "internal" member of this monorepo.
  • web: Whether to create a lib/index.html file to view the package as an EightBittr game.

See ShenanigansSchema in src/typings.ts for details.