code-template-generator

Table of contents

1. Introduction
   • Screenshot
   • What's new in version 2.2.x
2. Main features
   • Supported project templates
   • Supported component templates
3. Installation
4. Using
   • Sub options
   • Aliases
5. Examples
6. Thanks you!

1. Introduction

This is the lightweight React code template generator that has these parts in one npm package:

• Project template generation that has a part of the Build environments project.
• Component generation.
• Asset generation.
• Utility.

You have more choice for your development environment. It makes your life easier.

Screenshot

What's new in version 2.2.x

• Why?
  • You may have your own libraries, code templates and many more like .gitignore, .editorconfig, .eslinttrc.json, .eslintignore,... You need to use them while you are coding or when you start a new project. We say at they are your assets.
  • You don't want do the same things (copy/ paste) many times. You want to have them whenever you need.
  • It makes you happy with these new features -cf, -m and a new short command gen. ;-)
• New features:
  • New options:
    • -cf, --config
    • -m, --my-asset
  • Syntaxes (You can also view how to use or examples are below):
    • generate -cf --set-asset <path-to-your-directory>
    • generate -cf --view-asset
    • generate -m
  • Config file code-template-generator.json is stored at your Home directory and it depends on your platform. Examples:
    • Windows: C:\Users\<yourname>
    • Ubuntu: /home/<yourname>
    • MacOS: /Users/<yourname>
• A new command is added - You can start a command line by using one of them generate or gen. Examples:
  • generate --version -> Original command.
  • gen --version -> It is shorter and more quickly when you type a command line.
• Improvement:
  • Performance.
  • Resolving handling.
  • Error handling.

2. Main features

• Project template generation:
  • Without Git support.
  • With Git support -> It runs automatically the git init command and generates a .gitignore file while the project is generated.
• Component generation:
  • Two kinds of generated components: React and React-Redux.
  • It can become a single component that is a file *.js, *.jsx or a full component that is a directory with two files *.js, *.css are within.
• .gitignore file generation.
• Automatic update checking for the latest stable version.
• Project templates:
  • It's simple for:
    • Configuration and installation for the dependencies you need.
    • Using together or moving to/from an other React build environment.
  • Code splitting.
  • Image handling.
  • CSS, JS code injected automatic into HTML template.
  • Hot Module Replacement (HMR) is enabled.
  • You don't need to care about the distribution directory /dist. The things you care are only the source directory /src.
  • Anti-caching.
• Your own asset(s) generation.

Supported project templates

You can view more details about these project templates in this repository Build environments.

Supported component templates

(*) You can install and config Redux, React-Redux by yourself.

3. Installation

$ npm install --global code-template-generator

System requirements:

• The minimum supported Node.js version is 8.3.0 (Node.js LTS is a good choice for many reasons).
• Administrator permission is required when you run the command $ generate -u for the latest stable version installation.

4. Using

$ generate [-option] [--sub-option] [project-name][component-name][path]

Tip! You can use command gen instead of generate from version 2.2.0.

(*) Administrator permission is required. Here is an example for MacOS and Ubuntu system:

• $ sudo generate -u

(**) View how to use with its sub options that is below.

Sub options

• --no-install (No install dependencies)
• --set-asset
• --view-asset

Aliases

5. Examples

// Project generation
$ generate first-project             // Without options
$ generate -g secondproject          // Run git init
$ generate --git ThirdProject        // Using alias --git instead of -g
$ generate -g --no-install OtherProject
$ generate --no-install LastProject  // Without installation of dependencies

// Single component -> A file
$ generate -c SearchComponent.js   // React component
$ generate -r ReviewComponent.jsx  // React-Redux component

// Full component -> A directory
$ generate -fc ProductComponent
$ generate -fr CartComponent

// Asset generation
$ generate -cf --set-asset "C:\Users\name\myassets"  // Windows
$ generate -cf --set-asset "/home/name/myassets"     // Ubuntu
$ generate -cf --set-asset "/Users/name/myassets"    // MacOS
$ generate -cf --view-asset   // View the current asset location
$ generate -m                 // Show asset list

// Others
$ generate --gitignore  // Generate a .gitignore file
$ generate --version    // View the installed version
$ generate --help       // View the help information
$ generate --update     // Check and install the latest stable version

6. Thank you!

Special thanks to Harriet Ryder!

Many thanks to Commander.js for the inspiration.