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

@leny/banye

v0.4.0

Published

Add dynamic header comments to files - cleaned/updated version of misteroneill/bannerize

Downloads

53

Readme

@leny/banye

Add dynamic header comments to files - cleaned/updated version of misteroneill/bannerize


Banner Templates

Banner templates use the EJS templating language. Templates are passed the following properties:

  • pkg: A representation of the nearest package.json file.
  • date: A JavaScript Date object.
  • path: Relate path of the file.

A simple banner might look something like:

/*! <%= pkg.name %> | <%= pkg.version %>
 *  (c) <%= date.getFullYear() %>
 */

And render to:

/*! @leny/banye | 1.0.0
 *  (c) 2021 MIT
 */

CLI

banye ships with a CLI command. Its options vary from the programmatic API. To see all its options, use:

$ banye --help

An example usage might look like:

$ banye *.js *.css --banner=foo/bar.ejs

API

The banye module can be used in your programs. It exports a single function, banye , which takes two arguments:

banye(patterns, [options])

  • pattern {String|Array}: A string or array of glob pattern(s) to which to apply the banner.
  • [options] {Object}: An object containing optional values.

The return value of bannerize() is a Promise that resolves with an array of all the file paths it modified.

Options

  • banner A banner file location. Defaults to banner.ejs in the cwd.

  • cwd Override the cwd for all paths passed to bannerize. Relative paths will be relative to process.cwd(). Defaults to process.cwd().

  • lineBreak Sets the linebreak ('CRLF', 'LF'). Defaults to 'LF'.

  • replace Replace the starting lines of the files (up to the first empty line) with the banner

  • check Check if header already exists in good format before add or replace