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

@ithaka/pharos-cli

v5.5.1

Published

Pharos Web Component Generator

Downloads

1

Readme

Pharos CLI

A command-line tool for creating new web components for the Pharos design system.

This will generate SCSS, TypeScript, unit test, and Storybook story files for the component to make getting started more consistent.

Getting started

The dependencies for @ithaka/pharos-cli are installed when running yarn install so no additional install step is needed.

To get this CLI setup, go to your terminal and change to this directory:

$ cd packages/pharos-cli

Next, you will need to compile the TypeScript files into JavaScript:

$ yarn tsc

Lastly, you will need to link this package so it is runnable:

$ npm link

At this point the pharos command can be used in the root of this repo.

Usage

To generate the core files needed to start developing a Pharos web component, go to the root of the Pharos repository and run the following command:

$ pharos component|wc <component-name>

Example

Create a Button component by using the following command:

$ pharos wc button

You should now see your new Button component under the components directory:

├── packages
│   ├── core
│   │   ├── src
│   │   │   ├── components
│   │   │   │   ├── button
│   │   │   │   │   ├── pharos-button.ts
│   │   │   │   │   ├── pharos-button.scss
│   │   │   │   │   ├── pharos-button.test.ts
│   │   │   │   │   ├── pharos-button.wc.stories.mdx
│   │   │   │   │   └── PharosButton.react.stories.mdx

You are now ready to begin developing your new component!

$ yarn storybook:wc:dev

Happy Developing!