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

@bumpup/cli

v2.5.1-0

Published

fully automated and extensible software versioning

Downloads

33

Readme

@bumpup/cli

npm version

This is the cli for bumpup

Quickstart

npm install @bumpup/cli --save-dev
npx bumpup init
npx bumpup

Usage

To see all options and commands run bumpup --help or bumpup <subcommands> help

Options and commands

bumpup bump

For convenience the bump subcommand can be executed with just bumpup too.

$ bumpup bump --help
Usage: bumpup bump [options]

bumps up the version

Options:
  -d, --dry                 executes all plugins in dry mode, preventing potentially destructive operations (default: false)
  -p, --pre                 do a prerelease (default: false)
  -l, --log <log-level>     specifies the log level (error, warn, info, verbose, debug, silly) (default: "info")
  -f, --file <config-file>  which config file to read (default: "bumpup.config.mjs")
  -h, --help                display help for command

bumpup init

$ npx bumpup init --help
Usage: bumpup init [options]

initializes a default config file

Options:
  -f, --file <config-file>  which config file to write (default: "bumpup.config.mjs")
  -d, --dry                 executes all plugins in dry mode, preventing potentially destructive operations (default: false)
  -P, --save-prod           packages will appear in your `dependencies` (default: false)
  -s, --skip-install        skip install of packages (default: false)
  -h, --help                display help for command

bumpup --version

Display the current version of @bumpup/cli

$ npx bumpup --version
2.3.1

Configuration

A default bumpup.config.mjs config file can be generated with bumpup init. It contains the plugins for a standard 'npm, git, semver' use case.

The config file can have whatever name you want, but it has to end with *.mjs because otherwise node tries to import the config as a CommonJS Module.

bumpup.config.mjs

A configuration file is an ES Module with a configuration object as its default export. CommonJS Modules are not supported.

The most basic example (although not very useful because it contains no plugins) would be:

export default {
    version: "2.0.0",
    plugins: []
}

To add a plugin import it and add it to the plugin array:

import version from '@bumpup/version-package-json';
import {type, record} from '@bumpup/type-git-tags';
import bump from '@bumpup/bump-package-json';
import determine from '@bumpup/determine-semver';

export default {
    version: "2.0.0",
    plugins: [
        version,
        type,
        determine,
        bump,
        record,
    ]
}

To pass options to a plugin add an array with the plugin and its options instead of the plugin: For a list of options supported by the plugin see the plugins doc.

import version from '@bumpup/version-package-json';
import {type, record} from '@bumpup/type-git-tags';
import bump from '@bumpup/bump-package-json';
import determine from '@bumpup/determine-semver';

export default {
    version: "2.0.0",
    plugins: [
        version,
        type,
        determine,
        [bump, {dry: true}],
        record,
    ]
}
Inline Plugins

Because the configuration is just plain javascript it is also possible to specify a plugin inline. This might be usefull if you want to debug the workflow or slightly alter a plugins behaviour without writing an complete plugin for it.

A simple inline plugin that just logs the options and data looks like this:

import version from '@bumpup/version-package-json';
import {type, record} from '@bumpup/type-git-tags';
import bump from '@bumpup/bump-package-json';
import determine from '@bumpup/determine-semver';

export default {
    version: "2.0.0",
    plugins: [
        options => data => {
            console.log(options, data);
        }
    ]
}