nucliar v0.1.2

Nucliar

A command-line tool helping React developers by generating boilerplate code for them.

:arrow_down: Installation

Install Nucliar globally with your favorite package manager:

# npm
npm i -g nucliar

# yarn
yarn global add nucliar

# pnpm
pnpm add -g nucliar

:desktop_computer: Usage

Use the generate command to create a component based on its type:

nucliar generate <type> <name>

Now, let's try to generate a default component called Test:

nucliar generate component Test

After execution, it will create this file structure in your project directory:

./awesome-react-project
├─ ...
└─ Test/
    ├─ Test.js
    └─ Test.css

You can give any path by just preprending it to your component name:

nucliar generate component ./components/Test

Until now, we only used the component type. But nucliar actually supports multiple types out of the box: component (functional component), class-component (class-based component), hook (surprise: a hook), hoc (high order component) and provider (React context API).

In order to use one of them, just put the wanted value in the type argument:

# This will generate *drum rolling* a class component.
nucliar generate class-component Test 

The command can also be shorten to gen or even g:

nucliar g component WowThisIsAReallyShortCommand

:gear: Configuration

It can be very tedious to rely on flag parameters to configure components generation. Plus, you may want to set up specific behaviors depending on some projects. The configuration file resolve this issue.

First, let's go inside our awesome-react-project directory and run the command below:

nucliar init

It will prompt you some questions about your project in order to create a configuration file nucliar.json.

At the end, you should have a file with a similar content:

{
    "useJsx": false,
    "useTypescript": false,
    "generateLazy": false,
    "generateStyle": false,
    "flat": false,
    "useCssModules": false,
    "preprocessor": "css",
    "path": "./",
    "types": {
        "component": {
            "generateStyle": true
        },
        "class-component": {
            "generateStyle": true
        },
        "hoc": {
            "flat": true
        },
        "hook": {
            "flat": true
        }
    }
}

This file can be divided in two parts:

{
    // Global configuration
    "useJsx": false,
    "useTypescript": false,
    "generateLazy": false,
    "generateStyle": false,
    "flat": false,
    "useCssModules": false,
    "preprocessor": "css",
    "path": "./",

    // Type scoped configuration
    "types": {
        "component": {
            "generateStyle": true
        },
        "class-component": {
            "generateStyle": true
        },
        "hoc": {
            "flat": true
        },
        "hook": {
            "flat": true
        }
    }
}

Inside the first part, you will find global configuration. Any change made to it will affect all types of component. As of the second part, it will scope the configuration to a specific type. Note that all of the global properties are valid for each component type. Any type scoped configuration overrides its global counterpart.

Thus, if you want to use jsx only on function-based components, you will have to change the configuration as such:

{
    "useJsx": false,
    // ...
    "types": {
        "component": {
            "useJsx": true, // here
            "generateStyle": true
        },
        // ...
    }
}

:pencil: Custom types

As mentioned in the usage part, Nucliar includes many component types by default. These are already very useful but may not fulfill all use cases. This is why it is possible to create custom component types.

At the root of your project, create a directory named templates:

mkdir templates

In fact, you can name your directory by anything you want. templates is used in this case by convention.

Inside, let's create a file effect-component.txt with the following content:

import React, { useEffect } from "react";

const {{it.name}} = (props = initProps) => {

    useEffect(() => {
        console.log("Freshly generated from Nucliar!");
    }, []);

    return <></>; 
}

export default {{it.name}};

This file contains the template Nucliar will use to generate our effect-component.

The template engine used by Nucliar is Squirrelly. You can learn more about the template syntax here.

The it object contains the component render data.

After that, let's edit nucliar.json:

{
    // ...
    "types": {
        "component": {
            "generateStyle": true
        },
        "class-component": {
            "generateStyle": true
        },
        "hoc": {
            "flat": true
        },
        "hook": {
            "flat": true
        },
        "effect-component": {
            "template": "./templates/effect-template.txt",
        },
    }
}

Congrats! You have successfully added a new component type. :tada:

Let's try to generate it now:

nucliar g effect-component MyPrecious

Without any doubt, this will generate the following code:

import React, { useEffect } from "react";

const MyPrecious = (props = initProps) => {

    useEffect(() => {
        console.log("Freshly generated from Nucliar!");
    }, []);

    return <></>; 
}

export default MyPrecious;

The example above will not generate specific Typescript code. In order to do that, you will have to use the it.useTypescript property inside a if statement in the template.

:round_pushpin: Roadmap

• Generate functional components
• Generate class components
• Generate hooks
• Generate lazy components
• Generate provider components
• Generate style sheet (with or without any preprocessor)
• Generate components from custom templates
• Use of a local configuration file
• Manage errors
• Add following keys to config file: path, template
• Complete documentation
• Automate package publishing
• Write tests (some made but still wip)

• Implement a plugin API giving the opportunity to customize Nucliar even more