## Устройство "рецепта"

Рецепт - набор инструкций и предварительных условий для выполнения вашего шаблона.

Важно! Каждый файл рецепта должен называться `recipe.yaml`.

Каждый рецепт выглядит примерно так:

```yaml
requiredParams:
  name: HeadHunter BaseFragment
  description: Creates HeadHunter BaseFragment

# optional
optionalParams:
  revision: 1
  category: fragment
  formFactor: mobile
  constraints:
    - kotlin
  screens:
    - fragment_gallery
    - menu_entry
  minApi: 7
  minBuildApi: 8
  
# required only for modules templates
predefinedFeatures:
  - enableModuleCreationParams:
      defaultPackageNamePrefix: ru.hh.test
      # optional
      defaultSourceCodeFolderName: java
      # optional
      defaultSourceSetName: main

widgets:
  - stringParameter:
      id: className
      name: Fragment Name
      help: The name of the fragment class to create
      constraints:
        - class
        - nonempty
        - unique
      default: BlankFragment

  - stringParameter:
      id: fragmentName
      name: Fragment Layout Name
      help: The name of the layout to create
      constraints:
        - layout
        - nonempty
        - unique
      default: fragment_blank
      suggest: fragment_${className.classToResource()}

  - booleanParameter:
      id: includeFactory
      name: Include fragment factory method?
      help: Generate static fragment factory method for easy instantiation
      default: true

  - booleanParameter:
      id: includeModule
      name: Include Toothpick Module class?
      help: Generate fragment Toothpick Module for easy instantiation
      default: true

  - suggestParameter:
      id: uiFramework
      name: UI framework
      help: Which UI stack should be generated
      default: compose
      sealed: true
      options:
        - value: compose
          label: Compose
        - value: views
          label: Views

  - suggestParameter:
      id: targetModule
      name: Target module
      help: Module for integration
      sealed: true
      options:
        source: options/modules.csv

  - include:
      file: shared/codeowners.widgets.yaml

  - stringParameter:
      id: moduleName
      name: Fragment Toothpick Module
      help: The name of the Fragment Toothpick Module to create
      constraints:
        - class
        - nonempty
        - unique
      default: BlankModule
      visibility: ${includeModule}
      suggest: ${className.classToResource().underscoreToCamelCase()}Module

  - stringParameter:
      id: composePackage
      name: Compose package
      default: ru.hh.feature.compose
      visibility: ${uiFramework} == compose

globals:
  - stringParameter:
      id: reducerClassName
      value: ${moduleName}Reducer
      
  - booleanParameter:
      id: anotherBooleanFlag
      value: true

recipe:
  - mkDirs:
      - ${srcOut}:
          - api
          - di:
              - modules
              - outer
          - domain:
              - interactors
              - repositories
          - ui
      - ${resOut}:
          - layout
          - drawables
          - values
  - instantiateAndOpen:
      from: root/src/app_package/BlankFragment.kt.ftl
      to: ${srcOut}/${className}.kt
  - instantiate:
      from: root/res/layout/fragment_blank.xml.ftl
      to: ${resOut}/layout/${fragmentName}.xml
  - instantiate:
      from: root/src/app_package/BlankViewModel.kt.ftl
      to: ${currentDirOut}/presentation/${className}ViewModel.kt
  - open:
      file: ${resOut}/layout/${fragmentName}.xml
  - predicate:
      validIf: ${includeModule}
      commands:
        - instantiate:
            from: root/src/app_package/BlankModule.kt.ftl
            to: ${srcOut}/di/${moduleName}.kt
        - open:
            file: ${srcOut}/di/${moduleName}.kt
      elseCommands:
        - instantiateAndOpen:
            from: root/src/app_package/AnotherModule.kt.ftl
            to: ${srcOut}/di/${moduleName}.kt
  - addDependencies:
      - implementation: Libs.jetpack.compose
      - kapt: Libs.di.toothpick
      - ksp: Libs.jetpack.room
      - compileOnly: com.github.stephanenicolas.toothpick:toothpick:3.1.0
      - testImplementation: :shared-core-test
      - androidTestImplementation: Libs.uiTests.kaspresso
  - addGradlePlugins:
      - kotlinx.serialization
      - kotlin-kapt
```

Рецепт состоит из 6-х секций

- `requiredParams` - обязательные параметры для вашего шаблона
- `optionalParams` - соответственно, необязательные параметры
- `predefinedFeatures` - набор заранее предопределённых фич в Geminio, которые могут добавлять новые виджеты в шаблон, дополнять функционал.
- `widgets` - описание параметров шаблона - для использования доступны строковые, булевские и suggest-параметры
- `globals` - описание невидимых параметров для шаблонов, некие "глобальные" переменные.
- `recipe` - сам рецепт, набор инструкций, которые нужно выполнить

Если вам кажется, что это похоже на старые-добрые Freemarker-ные template.xml && recipe.xml,
только в одном файле, то вам не кажется.

### Секции "рецептов"

- [requiredParams](recipe_content/REQURED_PARAMS.md)
- [optionalParams](recipe_content/OPTIONAL_PARAMS.md)
- [predefinedFeatures](recipe_content/PREDEFINED_FEATURES.md)
- [widgets](recipe_content/WIDGETS.md)
- [globals](recipe_content/GLOBALS.md)
- [recipe](recipe_content/RECIPE.md)

### Дополнительно

- [Выражения](EXPRESSIONS.md)

---

[Обратно к содержанию](../../README.md)