Nextjs-kodyfire NPM

Welcome to nextjs-kodyfire 👋

Generate nextjs components and related artifacts based on HTML templates using Kodyfire.

🏠 Homepage

Requirements

nextjs-kodyfire requires the kodyfire-cli to be installed

npm install -g kodyfire-cli

Install

npm install nextjs-kodyfire

Usage

Method 1: As a generator

In order to generate your artifacts, run the generate command. The syntax is kody generate|g [kody] [concept]. If you ommit kody and concept the assistant will prompt you to select them. As an example, run the following command from your terminal:

kody generate nextjs component

Method 2: As a runner in a kody project

Refer to the kodyfire generate your artifact section. Once your project is initialized and ready for kody, generate your nextjs concept using the kody ride command or manually. As an example, A declaration for a nextjs concept might look like the following:

{
			"name": "Bird",
			"template": "class.ts.template",
			"outputDir": "classes",
			"extends": "Animal",
			"implements": "",
			"hasConstructor": true,
			"args": [
				{
					"name": "name",
					"type": "string"
				}
			],
			"methods": [
				{
					"name": "fly",
					"returnType": "void"
				}
			],
			"properties": [
				{
					"name": "family",
					"type": "string",
					"optional": false
				},
				{
					"name": "weight",
					"type": "number",
					"optional": true
				}
			]
		}

After adding your concept(s) definitions, run the following command to generate your assets.

kody run -s kody-nextjs.json

Available concepts

`component`

Generates a react component

Params

name string - Component name. Default filename
template enum - template name to use. Only one by default.
extension enum - file extension. Possible values: js, ts, jsx, tsx
isFolder boolean - If the component will be placed in a folder. This will add an index file for imports.
ccsModule boolean - if a css module file should be created.
outputDir string - The output directory

`page`

Generates a nextjs page

Params

name string - Component name. Default filename
isFolder boolean - If the component will be placed in a folder. This will add an index file for imports.
ccsModule boolean - if a css module file should be created.
isDynamicRoute boolean - if the page uses a dynamic route.
routerParam string - Required if isDynamicRoute is true. This will generate a dynamic page. Example: id.jsx
outputDir string - The output directory

`api`

Generates a nextjs api endpoint

Params

name string - Name of the file/folder
isFolder boolean - If the component will be placed in a folder.
isDynamicRoute boolean - if the endpoint uses a dynamic route.
routerParam string - Required if isDynamicRoute is true. This will generate a filename as routerParam.ts
outputDir string - The output directory. Default is src/pages/api

`class`

Generates a typescript class

Params

name string - class name. Default filename
template enum - template name to use. Only one by default.
implements string - Interface(s) to implement
extends string - class(es) to extend.
properties Property[] - list of properties
methods Method[] - list of methods
hasConstructor boolean - if class should have a constructor
args {name: string, type: string} - List of argument to pass to the constructor. hasConstructor must be true.
outputDir string - The output directory

`interface`

Generates a typescript interface

Params

name string - class name. Default filename
template enum - template name to use. Only one by default.
extends string - class(es) to extend.
properties Property[] - list of properties
outputDir string - The output directory

`tsconfig`

Generates a tsconfig file
Params

name enum - The tsconfig configuration name
outputDir string - The output directory

Tsconfigs

Refer to this reference for a list of available tsconfig templates

Property

name string - property name
type string - property type
optional boolean - if the property is optional when constructing an object

Method

name string - method name
params {name: string, type: string} - list of method arguments. Leave empty if none
returnType string - Return type (example: string, number, void)

Add the following params to your generated concepts using the kody ride command or manually. As an example, A declaration for a class might look like the following: