quick-generator

Quickly generate files into Atom
kevincastejon
3.16.0 73
Flag as spam or malicious

quick-generator

Simple, template-based React component and Redux container generator for Atom's Tree View. VS Code version here.

Installation

apm install quick-generator

Usage

  • Right click any directory in Tree View
  • Select component or container
  • Input name and choose options
  • Submit

What's the deal with these files?

The default templates are opinionated, admittedly. They adhere to the principles of feature-based structuring, as promoted in this article by Max Stoiber, and component/container separation, explained here by Dan Abramov.

  • Modular CSS with css-modules and react-css-modules
  • Containers have their own actions, constants, and reducers: see Redux and react-redux
  • index.js simply passes the component through so you can import SomeComponent from '/components/SomeComponent'

However, this package does not force these principles. You can easily customize the templates to match your own tech stack.

Customization

The component and container templates are completely customizable. You can add additional boolean options to the generator panel from the package's settings. One option is included by default: class determines whether to generate a class-based component instead of a functional component.

View the default templates

Click on View Code in the package settings, and see the contents of the component_template and container_template folders. It is recommended that you do not modify the default templates directly, as updates will overwrite your changes.

Enable custom templates

In the package settings, enter absolute paths to your own template folders. This will override the defaults.

Syntax

Template syntax is very simple:

  • Any occurrence of __ComponentName__ in a filename or a file's content will be replaced with the user's text input.
  • Any text surrounded by /* IF condition */ and /* ENDIF */, where condition is the name of an option (definted in the package settings) will be removed unless condition is checked (or invalid)
  • Any text surrounded by /* IF !condition */ and /* ENDIF */ will be removed unless condition is left unchecked (or invalid)
  • Any remaining /* IF */ or /* ENDIF */ comments will be removed, but the text between them will be untouched