Installation

npm i @bazooka_se/make

Add a script entry to your package.json file:

"scripts": {
    "make": "bazooka-make"
}

Run the script and follow instruction to generate a new component:

npm run make

Setup

To get started, create a directory in your project root called templates with directories for each template inside it. Template directory name can be changed in settings, see below.

Example directory structure:

/templates
    /component
    /container

Global settings

An optional settings file can be created in your project root to change some settings. Create a file called bazooka.make.json and add your settings as an object:

{
    "templates_dir": "templates"
}

Supported settings

The following values are supported at the moment:

| Key | Default | Type | Description | |---|---|---|---| |templates_dir|templates|String|Directory where templates are located|

Templates

A template can contain both files and directories. Empty directories are ignored.

See example templates here.

Template data

The templates will be passed data that can be accessed in both files and filenames. Currently the only data passed is the name you enter, together with case convertions, see below.

Use the following syntax to access the passed data:

# In a filename
[%name%]
[%name.toScreamingSnakeCase%]

# Inside a file
<% name %>
<% name.toDashedCase %>

Available case conversions

| | Example | Note | | - | - | - | | toUpperCamelCase | UpperCamelCase | Same as default | | toLowerCamelCase | lowerCamelCase | | | toDashedCase | dashed-case | | | toKebabCase | kebab-case | Same as dashedCase | | toSnakeCase | snake_case | | | toScreamingSnakeCase | SNAKE_CASE | |

Filenames

All files must have the file ending .template to be included.

Filename examples

| Template | Result | | --- | --- | | index.js.template | index.js | | [%name%].module.scss.template | ComponentName.module.scss |

Template settings

Each template can have a .settings file that supports the following settings:

| Setting | Default | Description | | --- | --- | --- | | destination | null | This is generated from selected template by default. | | new_folder | false | Set to false to place template content in the root of destination folder. | | prompt_subfolder | true | Set to true if destination folder has subfolders where generated component should be placed. | | naming_convention | | A string or an array of strings with regular expressions that given name should match. Disable naming convention by setting a falsy value. Default convention is UpperCamelCase. |

{
    "destination": "tests/",
    "prompt_subfolder": true,
    "new_folder": false,
    "naming_convention": ["^my[A-Z].+$", "[^_]"]
}

Example .settings file.