copy-paste-component's Introduction

copy-paste-component

A tool to create components, by copying and pasting existing ones.

If you have the structure below:

src/components/App/App.js
src/components/App/App.test.js
src/components/App/App.stories.js
src/components/App/index.js

and run the tool, it will create the following structure, replacing occurrences of the word App inside the files to NewApp:

src/components/NewApp/NewApp.js
src/components/NewApp/NewApp.test.js
src/components/NewApp/NewApp.stories.js
src/components/NewApp/index.js

Installation

yarn global add copy-paste-component or npm i -g copy-paste-component

Editor integration

Are you looking for an editor extension? Check the ones available:

Visual Studio Code

Usage

On the root of your project, run cpc or copy-paste-component.

It will prompt you three questions:

Which component would you like to copy?
What is the name of the new component?
What is the location of the new component?

When you answer those questions, it will generate a structure that is the same as the one that the selected component uses, but it will change the filename to the one you provided on the second question. It will look too inside the file for occurrences of the filename, and if it finds, it replaces with the content of the second question.

So, given the following file:

App.js

import React from 'react'

const App = () => <div>Hello World</div>

export default App

Becomes the following:

NewApp.js

import React from 'react'

const NewApp = () => <div>Hello World</div>

export default NewApp

There is also an option to skip the questions, providing them directly when you call the package, using the copy command, like cpc copy src/components/App/App.js NewApp src/components/NewApp. The first argument is the path of the component you want to copy, the second is the name of the new component, and the last one is the path where the component will be created.

Roadmap

See Roadmap

Changelog

See Releases

License

MIT

copy-paste-component's People

Contributors

Stargazers

Watchers