Шаблоны и генерация кода
Как работают шаблоны, как их создавать, синтаксис переменных и как генерировать код с помощью расширения VS Code и CLI.
Структура шаблонов
Все шаблоны лежат в .templates/ в корне проекта. Каждая папка — отдельный шаблон.
text
.templates/
├── component/ # шаблон компонента
│ └── {{name.kebabCase}}/
│ ├── styles/
│ │ └── {{name.kebabCase}}.module.css
│ ├── types/
│ │ └── {{name.kebabCase}}.type.ts
│ ├── {{name.kebabCase}}.tsx
│ └── index.ts
└── store/ # шаблон Zustand стора
└── {{name.kebabCase}}/
├── {{name.kebabCase}}.store.ts
├── {{name.kebabCase}}.type.ts
└── index.tsСинтаксис шаблонов
Переменные работают в именах файлов/папок и внутри файлов. Базовая переменная — name.
text
{{variable}}Модификаторы меняют регистр и формат записи:
text
{{name.pascalCase}} → MyButton
{{name.camelCase}} → myButton
{{name.kebabCase}} → my-button
{{name.snakeCase}} → my_button
{{name.screamingSnakeCase}} → MY_BUTTONКак создать новый шаблон
- Создать папку в
.templates/с именем шаблона (напримерhook). - Внутри разместить файлы и папки, используя
{{name}}и модификаторы в именах и содержимом. - Шаблон сразу доступен и в расширении VS Code, и в CLI.
Пример — создание шаблона для хука:
text
.templates/
└── hook/
└── {{name.kebabCase}}/
├── {{name.kebabCase}}.hook.ts
└── index.tsts
// .templates/hook/{{name.kebabCase}}.hook.ts
export const {{name.camelCase}} = () => {
}ts
// .templates/hook/index.ts
export { {{name.camelCase}} } from './{{name.kebabCase}}.hook'Примеры шаблонов
Шаблон компонента
ts
// .templates/component/index.ts
export { {{name.pascalCase}} } from './{{name.kebabCase}}'ts
// .templates/component/types/{{name.kebabCase}}.type.ts
import type { HTMLAttributes } from 'react'
/**
* Параметры {{name.pascalCase}}.
*/
export type {{name.pascalCase}}Params = {}
/** HTML-атрибуты корневого элемента. */
type RootAttrs = HTMLAttributes<HTMLDivElement>
export type {{name.pascalCase}}Props = RootAttrs & {{name.pascalCase}}Paramstsx
// .templates/component/{{name.kebabCase}}.tsx
import cl from 'clsx'
import type { {{name.pascalCase}}Props } from './types/{{name.kebabCase}}.type'
import styles from './styles/{{name.kebabCase}}.module.css'
/**
* {{name.pascalCase}}.
*/
export const {{name.pascalCase}} = (props: {{name.pascalCase}}Props) => {
const { children, className, ...htmlAttr } = props
return (
<div {...htmlAttr} className={cl(styles.root, className)}>
{children}
</div>
)
}css
/* .templates/component/styles/{{name.kebabCase}}.module.css */
.root {
}Генерация через VS Code
Template File Generator | gromlab (Marketplace, Open VSX) — расширение для генерации файлов и папок из шаблонов через интерфейс редактора.
- ПКМ на целевой папке в проводнике VS Code.
- Generate from template → выбрать шаблон.
- Ввести имя (например
button) — расширение подставит его во все переменные{{name}}.
Генерация через CLI
@gromlab/create — CLI для генерации из тех же шаблонов. Используется через npx, глобальная установка не требуется.
bash
npx @gromlab/create <шаблон> <имя> <путь>| Команда | Что создаёт |
|---|---|
npx @gromlab/create component button src/shared/ui | Компонент |
npx @gromlab/create module auth src/business | Бизнес-модуль |
npx @gromlab/create widget header src/widgets | Виджет |
npx @gromlab/create layout admin src/layouts | Layout |
npx @gromlab/create store auth src/business/auth/stores | Стор |