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

@pattern-lab/cli

v6.1.0

Published

Command-line interface (CLI) for the @pattern-lab/core.

Downloads

15,791

Readme

Pattern Lab Node CLI

Command-line interface (CLI) for the patternlab-node core.

Continuous Integration CodeQL

Installation

Note: Global installs are currently not supported and will be fixed when the Pattern Lab core hits v3.0.0

Via NPM

npm install @pattern-lab/cli --save-dev

Via Yarn

yarn add @pattern-lab/cli --dev

Configuring Your Project to Use the CLI

If the CLI is installed globally, you may call commands directly, such as patternlab --version.

If the CLI is not installed globally, you need to tell npm where to find the executable when invoking commands.

Open package.json and add the following to your scripts object:

"scripts": {
+ "patternlab": "patternlab"
},

This tells npm to look in the local node_modules/.bin directory for the patternlab CLI.

Subcommands and options can then be forwarded to the CLI like this:

npm run patternlab -- serve

Installing edition-node will add the following CLI commands for convenience:

  "scripts": {
+    "pl:build": "patternlab build --config ./patternlab-config.json",
+    "pl:help": "patternlab --help",
+    "pl:install": "patternlab install --config ./patternlab-config.json",
+    "pl:serve": "patternlab serve --config ./patternlab-config.json",
+    "pl:version": "patternlab --version"
  },

Then you can invoke any of these like this:

npm run pl:serve

API & Usage

General usage

Usage: patternlab <cmd> [options]
	Commands:
		build|compile [options]   Build Pattern Lab. Optionally (re-)build only the patterns
		export                    Export a Pattern Lab patterns into a compressed format
		init [options]            Initialize a Pattern Lab project from scratch or import an edition and/or starterkit
	    install|add [options]     Installs Pattern Lab related modules like starterkits or plugins
		serve|browse [options]    Starts a server to inspect files in browser

	Options:
		-h, --help           output usage information
		-V, --version        output the version number
		-c, --config <path>  Specify config file. Default looks up the project dir
		-v, --verbose        Show verbose logging
		--silent             Turn off console logs

Build/Compile Pattern Lab

Usage: build|compile [options]

Build Pattern Lab. Optionally (re-)build only the patterns

	Options:
		-h, --help           output usage information
		-p, --patterns-only  Whether to only build patterns

Initialize Pattern Lab

Usage: init [options]

Initialize a Pattern Lab project from scratch or import an edition and/or starterkit
Passing no options starts the init in interactive mode

	Options:
		-h, --help                output usage information
		-p, --project-dir <path>  Specify a project directory. Default: ./
		-e, --edition <name>      Specify an edition to install. Default: @pattern-lab/edition-node
		-k, --starterkit <name>   Specify a starterkit to install. Default: @pattern-lab/starterkit-handlebars-demo

Serve Pattern Lab

Usage: serve|browse [options]

Starts a server to inspect files in browser


	Options:
		-h, --help   output usage information
		-w, --watch  Start watching for changes

Export Pattern Lab

Usage: export [options]

Export a Pattern Lab patterns into a compressed format

	Options:
		-h, --help  output usage information

Install Pattern Lab starterkits or plugins

Usage: install|add [options]

Installs Pattern Lab related modules like starterkits or plugins

	Options:
		-h, --help             output usage information
		--starterkits <names>  Specify one or more starterkits to install
		--plugins <names>      Specify one or more plugins to install

Examples

    $ patternlab init # Initialize a Pattern Lab project.
    $ patternlab build # Builds Pattern Lab from the current dir
    $ patternlab build --config <path/to/patternlab-config> # Builds Pattern Lab from different project directory

License

MIT © Patternlab contributors