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

@rapid-build-ui/cli

v0.0.13

Published

Rapid Build UI cli for components, mixins and showcase.

Downloads

4

Readme

@rapid-build-ui/cli

Set of automation tasks for Rapid Build UI cli, components, mixins and showcase.

Installation

Run in project root!

$ npm install @rapid-build-ui/cli

How To Use: Option 1

Simple way, place in project's root package.json scripts property.

cli

{
  "scripts": {
    "build-continuous": "node node_modules/@rapid-build-ui/cli/ci cli continuous",
    "build-release": "node node_modules/@rapid-build-ui/cli/ci cli release",
    "bump": "node node_modules/@rapid-build-ui/cli/bump cli patch"
  }
}

components

{
  "scripts": {
    "build-continuous": "node node_modules/@rapid-build-ui/cli/ci component continuous",
    "build-release": "node node_modules/@rapid-build-ui/cli/ci component release",
    "bump": "node node_modules/@rapid-build-ui/cli/bump component patch"
  }
}

showcase

{
  "scripts": {
    "build-continuous": "node node_modules/@rapid-build-ui/cli/ci showcase continuous",
    "build-release": "node node_modules/@rapid-build-ui/cli/ci showcase release",
    "bump": "node node_modules/@rapid-build-ui/cli/bump showcase patch"
  }
}

How To Use: Option 2

Use the API. The process.cwd() must be the project's root path!

const cli = require('@rapid-build-ui/cli');
// See API Documentation

API

All return a promise.

  • cli.bump.run(type, semver, extraBumpFile = null)

    • params
      • type (string): cli | component
      • semver (string): 1.0.0 | patch | reference
      • extraBumpFile (string, optional): file path relative to project root
    • overview
      • bump version in all package.json(s)
      • bump extra file (optional)
      • update changelog
  • cli.ci.component.continuous(config)

    • build component
    • copy root files to: dist/client/ (ex: LICENSE)
    • trigger showcase ci build
  • cli.ci.component.release(config)

    • build component
    • copy root files to: dist/client/
    • copy npm config to dist/client/
    • publish npm package from dist/client/
    • publish github release from master
  • cli.ci.cli.continuous(config)

    • copy root files to: dist/server/ (ex: LICENSE)
  • cli.ci.cli.release(config)

    • copy root files to: dist/server/
    • copy npm config to dist/server/
    • publish npm package from dist/server/
    • publish github release from master
  • cli.ci.showcase.continuous(config)

    • create directory for cloned components (.rb-components)
    • clone component repos (into .rb-components)
    • setup components
    • setup showcase
    • build showcase
    • create heroku dist/package.json
    • publish heroku app rapid-build-ui-io-dev
  • cli.ci.showcase.release(config)

    • install client
    • install server
    • build showcase
    • create heroku dist/package.json
    • publish heroku app rapid-build-ui-io-staging
    • publish github release from master
  • cli.ci methods

# config example
repo:
	name:  'rb-alert'
	owner: 'rapid-build-ui'
	slug:  'rapid-build-ui/rb-alert'
tokens:
	github: 'token' # all projects
	heroku: 'token' # showcase
	npm:    'token' # components and cli
	travis: 'token' # components
paths:
	abs: # absolute os paths
		project:    '/rb-alert'
		components: '/rapid-build-ui.io/.rb-components' # (showcase only)
		dist:
			root:   '/rb-alert/dist'
			client: '/rb-alert/dist/client'
			server: '/rb-alert/dist/server'
		src:
			root:   '/rb-alert/src'
			client: '/rb-alert/src/client'
			server: '/rb-alert/src/server'
	rel: # relative paths from project root
		dist:
			root:   'dist'
			client: 'dist/client'
			server: 'dist/server'
		src:
			root:   'src'
			client: 'src/client'
			server: 'src/server'

Release Process

Applies to all projects.

$ git checkout master
$ git pull
$ git merge continuous --no-ff -m "chore(merge): continuous"
$ npm run bump # then check CHANGELOG.md (might need tweaking)
$ git commit -am "chore(bump): v1.x.x"
$ git push # ✓ then wait for successful travis ci build
$ git checkout continuous
$ git pull
$ git merge master -m "chore(merge): master"
$ git push