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

swig-cli-modules

v0.3.3

Published

Groups of swig tasks for use in other projects

Downloads

42

Readme

swig-cli-modules

The swig-cli-modules package is a collection of utility classes for setting up common swig tasks by project type or other generic grouping.

Swig documentation: https://github.com/mikey-t/swig

Example use: https://github.com/mikey-t/dotnet-react-sandbox (swigfile.ts)

Basic Info and Example

Swig is a CLI script that can execute any exported function from a swigfile (which is just a plain javascript or typescript file). To reduce repetition across projects, a "swig cli module" can be created in order to group together related tasks.

A medium-sized project like dotnet-react-sandbox might end up having a lot of dev automation tasks spanning several different types of activities. Rather than copy/paste what would normally be a relatively large swigfile.ts to each project that is based on the dotnet-react-sandbox template, we can encapsulate the functionality in a swig cli module and then import, configure and re-export all the relevant functions. This is the entire swigfile.ts for a dotnet-react-sandbox project:

import dotenv from 'dotenv'
import config from 'swig-cli-modules/ConfigDotnetReactSandbox'

config.init(dotenv.config)

export * from 'swig-cli-modules/DotnetReactSandbox'

Customization

If you want to run another task before a task from the swig cli module, you can import the function from the module and compose it together with your own like this:

import * as swigDocker from 'swig-cli-modules/DockerCompose'

async function runThisFirst() {
  // Do stuff
}

export const dockerUp = series(runThisFirst, swigDocker.dockerUp)

Ejecting

If you start out using a swig cli module and decide it doesn't do what you want, you can "eject" by simply copying and pasting the contents of the file from this library directly into your swigfile and customize it from there.

Make Your Own Swig CLI Module

You're welcome to create a module within this library, but note that these are simply groups of exported functions, so you could easily create your own library of modules in any location and in any format you like.