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

@gasket/plugin-command

v7.0.9

Published

Plugin to enable other plugins to inject new gasket commands

Downloads

804

Readme

@gasket/plugin-command

Enable plugins to inject new commands to be available for use with the Gasket CLI. Executes the commands lifecycle in the configure hook of the @gasket/plugin-command plugin. This plugin utilizes Commander.js and additional documentation can be found in the documentation.

Installation

npm i @gasket/plugin-command

Update your gasket file plugin configuration:

import { makeGasket } from '@gasket/core';
+ import pluginCommand from '@gasket/plugin-command';

export default makeGasket({
  plugins: [
    // other plugins
+    pluginCommand
  ]
});

Lifecycles

Commands

Executed in the configure hook of @gasket/plugin-command if the gasket command is present in the argv. The gasket command is the CLI execution of the gasket.js file.

export default {
  name: 'test-plugin',
  hooks: {
    commands(gasket) {
      return {
        id: 'test-plugin-cmd',
        description: 'Test plugin',
        action: async () => {
          console.log('test-plugin');
        }
      }
    }
  }
};

Commands can be configured with options (flags), arguments, defaults, and parsing functions.

Example with arguments

Add arguments to the command by adding an args array in the command definition.

export default {
  name: 'test-plugin',
  hooks: {
    commands(gasket) {
      return {
        id: 'test-plugin-cmd',
        description: 'Test plugin',
        args: [
          {
            name: 'message',
            description: 'Message to display',
            required: true // error if message argument is not provided
          },
          {
            name: 'optional-message',
            description: 'Optional message to display'
          }
        ],
        // Arguments are spread into the action function
        action: async (message, optionalMessage) => {
          console.log('test-plugin', message);
          console.log('test-plugin:optional', optionalMessage);
        }
      }
    }
  }
};

Execute the command with the message argument.

node ./gasket.js test-plugin-cmd "Hello, World!"
# result: test-plugin Hello, World!

# Optional message
node ./gasket.js test-plugin-cmd "Hello, World!" "Optional message"
# result: test-plugin Hello, World!
# result: test-plugin:optional Optional message

Example with options

Add options to the command by adding an options array in the command definition.

export default {
  name: 'test-plugin',
  hooks: {
    commands(gasket) {
      return {
        id: 'test-plugin-cmd',
        description: 'Test plugin',
        options: [
          {
            name: 'message',
            description: 'Message to display',
            required: true, // error if --message option is not provided
            short: 'm',
            type: 'string'
          },
          {
            name: 'optional-message',
            description: 'Optional message to display',
            short: 'op',
            type: 'string'
          }
        ]
        // hyphenated options are camelCased
        action: async ({ message, optionalMessage }) => {
          console.log('test-plugin', message);
          console.log('test-plugin:optional', optionalMessage);
        }
      }
    }
  }
};

Execute the command with the --message option.

node ./gasket.js test-plugin-cmd --message "Hello, World!"
# result: test-plugin Hello, World!

# Short option
node ./gasket.js test-plugin-cmd -m "Hello, World!"
# result: test-plugin Hello, World!

# Optional message
node ./gasket.js test-plugin-cmd --message "Hello, World!" --optional-message "Optional message"
# result: test-plugin Hello, World!
# result: test-plugin:optional Optional message

Example with parsing function

Add a parse function to the option to parse the value before it is passed to the action function.

export default {
  name: 'test-plugin',
  hooks: {
    commands(gasket) {
      return {
        id: 'test-plugin-cmd',
        description: 'Test plugin',
        args: [
          {
            name: 'numberOfItems',
            description: 'Retrieve a number of items from an array',
            required: true // error if message argument is not provided
          }
        ],
        options: [
          {
            name: 'groceryList',
            description: 'List of grocery items',
            required: true,
            type: 'string',
            parse: (value) => value.split(',') // split string to an array
          }
        ],
        // args are spread and options are passed as an object
        action: async (numberOfItems, { groceryList }) => {
          const items = groceryList.slice(0, numberOfItems);
          console.log('test-plugin', items);
        }
      }
    }
  }
};

Execute the command with the --groceryList option.

node ./gasket.js test-plugin-cmd 3 --groceryList "apple,banana,orange,grape"
# result: test-plugin [ 'apple', 'banana', 'orange' ]

Example with JSDoc Types

The CommandsHook type is available for type checking your hook's arguments and options.

export default {
  name: 'test-plugin',
  hooks: {
    /* @type {import('@gasket/plugin-command').CommandsHook} */
    commands(gasket) {
      return {
        id: 'test-plugin-cmd',
        description: 'Test plugin',
        args: [
          {
            name: 'numberOfItems',
            description: 'Retrieve a number of items from an array',
            required: true // error if message argument is not provided
          }
        ],
        options: [
          {
            name: 'groceryList',
            description: 'List of grocery items',
            required: true,
            type: 'string',
            parse: (value) => value.split(',') // split string to an array
          }
        ],
        // args are spread and options are passed as an object
        action: async (numberOfItems, { groceryList }) => {
          const items = groceryList.slice(0, numberOfItems);
          console.log('test-plugin', items);
        }
      }
    }
  }
};