root-up

Root Up

English | 한국어

Table of contents

• What is Root Up?
• Installation
  • Global
  • Local
• Before you start
  • templateFolder
  • config.json
• How to run
• Demo
• Contributing

What is Root Up?

This package is built for folder structure generator who has specific folder template.

Installation

Global

# using yarn
yarn global add root-up

# using npm
npm install -g root-up

Local

# using yarn
yarn add -D root-up

# using npm
npm install -D root-up

Note: add --save if you are using npm < 5.0.0

Add script in your package.json

"scripts": {
   "root-up": "root-up"
},

Before you start

You must make .template folder to your root path in workspace The .template folder must be configured as follows

/.template
   /<templateFolder>
   /<templateFolder>
   ...
   config.json

Checkout .template folder demo

templateFolder

/<templateFolder> ... is your own template. Make sure check prefix in your config.json

config.json

The .config.json file must be configured as follows

{
  "prefix": "YOUR_FAVORITE_PREFIX",
  "output": "YOUR_DEFAULT_OUTPUT_PATH_IN_YOUR_WORKSPACE",
  "excludePath": ["YOUR_IGNORE_PREFIX"]
}

prefix: The prefix property is the property that sets the alternate text to be replaced by the name of the folder.
Write down the name of the file, the code used in the template.

output: The output property is the property that path to template folder generated related path to your command is executed path

excludePath:
The excludePath property is the property that can ignore path finding in searching path to generate folder (e.g: .yarn folder)
Default is node_modules and .git

How to run

# Global installed
root-up

# or local installed
yarn <command> # specified in your package.json

Demo

You can use npx

https://user-images.githubusercontent.com/57122180/218425678-eabb9b8d-f7a2-4048-bec1-e32f2da900b0.mov

Contributing

We welcome contribution from everyone in the community.