Skip to content

imagineLife/CompFile

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 

Repository files navigation

A React-Component Directory Maker

What This Does

This creates a directory for a named React component. Running this package produces...

  • A directory titled a given tile (ex. ComponentA)
  • 3 files inside the directory:
    • a Component.css file (ex. ComponentA.css)
    • a Component.js file which contains some 'boilerplate' react code...(ex. ComponentA.js)
      • the template code currently looks like...
import React from 'react';
const ComponentA = () => <p>ComponentA</p>
export default ComponentA
  • an index.js file, which imports & exports the Component from the sibling js file
import ComponentA from './ComponentA'
export default ComponentA

Installation

npm install -g compfile I recommend installing this globally. Otherwise

  • install it locally to a project
  • create a script in your package.json, something like...
    • "cf": "compfile"

Creating A Component Directory && Files using a terminal

Globally Installed Instance

  • cd into the directory where you plan to insert a new component directory
  • run compfile your-component-name-here

Locally Installed Instance

  • cd into the directory where you plan to insert a new component directory
  • Taking the above script as an an example, run npm run cf your-component-name-here

About

react component directory && file template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published