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

@borracciablu/banner-cli

v1.0.32

Published

CLI tool to add a banner comment to your files.

Downloads

126

Readme


    /*! 
     * [name] v[tag]
     * [homepage]
     *
     * Copyright (c) [year] [author]
     * [license]
     */

By default it will use the values in package.json.
All values are overridable.

If you are evaluating the use of banners please read:

Installing

npm install @borracciablu/banner-cli

API Reference

Usage: banner-cli [options] [source]

CLI tool to add a banner comment to your files.

Arguments:
  source                   Files to bannerize

Options:
  -V, --version            output the version number
  -n, --name <name>        override project name
  -t, --tag <tag>          override tag version
  -s, --site <site>        override homepage
  -a, --author <author>    override author
  -y, --year <year>        override year
  --template <template>    override template
  -l, --license <license>  override license
  -d, --debug              debug options and args
  --dry-run                test the command, simulate without actually doing it
  -h, --help               display help for command

Template feature

The --template option allows you to inject tags.

The avalable tags are:

<br>      := new line. Like using \n. 
[name]    := project name
[tag]     := project tag version
[site]    := project homepage
[author]  := project author
[year]    := copyright year
[license] := license
[time]    := unix timestamp in seconds

Examples

Basic:

# add banner to each js file
$ banner-cli 'dist/**/*.js'

# add banner to each css file
# override author, license, site
$ banner-cli 'dist/**/*.css' --author 'Mr Developer' --license MIT --site https://project.js.org

# use template 
$ banner-cli 'dist/**/*.css' --template '/*! v[tag] :: [time] */'

Advanced:

// in package.json 
// inject next tag 
{
    "scripts" : {
        "banner:patch": "NEXT_TAG=$(semver $npm_package_version -i patch) banner-cli 'dist/*.js' --template='/*! v[tag] :: [time] */' --tag=$NEXT_TAG"
    }
}

Notes

This package is highly inspired by banner-cli and is currently a superset.