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

cyc-of

v1.0.11

Published

CYC - CLI yield component. For creating a new React components in OF

Downloads

156

Readme

CYC - CLI Yield Component

Simple, customizable utility for adding new React components to your project.

This project is a CLI tool that allows you to quickly scaffold new components. All of the necessary boilerplate will be generated automatically.

A fork of https://github.com/joshwcomeau/new-component

Features

  • Simple CLI interface for adding React components.
  • Uses Prettier to stylistically match the existing project.
  • Offers global config, which can be overridden on a project-by-project basis.
  • Colourful terminal output!

Quickstart

Install via NPM:

# Using Yarn:
$ yarn global add cyc-of

# or, using NPM
$ npm i -g cyc-of

cd into your project's directory, and try creating a new component:

$ cyc MyNewComponent

Your project will now have a new directory at src/components/my-new-component. This directory has two files:

// `my-new-component/my-new-component.tsx`
import Styles from './my-new-component.module.scss';

export const MyNewComponent = () => {
  return (
    <div>

    </div>
  );
}
// `my-new-componentmy-new-component.module.scss`
@import '@/styles/variables'

These files will be formatted according to your Prettier configuration.

API Reference

Directory

Controls the desired directory for the created component. Defaults to src/components

Usage:

Command line: --dir <value> or -d <value> eg. `cyc -d src/containers/NewComponent

JSON config: { "dir": <value> }

Known Issues

If you try to use this package with the Next.js App Router, you’ll run into an error:

**Syntax error:** the name `default` is exported multiple times

This issue is described in depth in my blog post about this package. To solve this problem, you’ll need to fork this library and remove the wildcard export.

Development

To get started with development:

  • Fork and clone the Git repo
  • cd into the directory and install dependencies (yarn install or npm install)
  • Set up a symlink by running npm link, while in the new-component directory. This will ensure that the new-component command uses this locally-cloned project, rather than the global NPM installation.
  • Spin up a test React project.
  • In that test project, use the new-component command to create components and test that your changes are working.