Skip to content

Opinionated NodeJS CLI for generating React components, useful when working with component libraries

License

Notifications You must be signed in to change notification settings

preshonyee/component-scaffolder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

component scaffolder logo

Component Scaffolder

NPM JavaScript Style Guide

This is a NodeJS CLI helps you quickly generate your React components either as a JavaScript or TypeScript file. This is really helpful if you work a lot with component libraries and want to save time from manually creating these files by hand.

Usage

npx component-scaffolder

For component scaffolder to work properly, it assumes that you have a src folder and components folder in your current working directory.

Follow the prompt that appears and select the type of files you want your components to be in (either JavaScript/TypeScript), and input the name of your component

What's included?

Component scaffolder includes support for styling with Styled Component, TypeScript types, tests, and Storybook.

  • Component.js/ts
  • Component.styles.js/ts (for styling with Styled Components)
  • Component.types.js/ts (for typescript types)
  • Component.test.jsx/tsx (test files)
  • Component.stories.js/ts (storybookJS files)

Libraries using Component Scaffolder

License

MIT © Component-Scaffolder

Thanks

This project would not have been possible without HarveyD whose initial templates helped start this whole experiment

About

Opinionated NodeJS CLI for generating React components, useful when working with component libraries

Resources

License

Stars

Watchers

Forks

Packages

No packages published