npm package: @nsmp/create-app
Description: CLI для создания шаблонов встроенных приложений
Latest version: 4.1.1

# CLI для создания шаблонов встроенных приложений

@nsmp/create-app - позволяет создавать шаблоны встроенных приложений, которые содержат необходимый минимум для быстрого начала разработки. Шаблоны сконфигурированы для обеспечения работоспособности приложения в современных браузерах, поддерживающих синтаксис ES6.

> Boilerplate Typescript - это универсальный шаблон, который содержит настроенный webpack, npm-сценарии для сборки, тестирования и запуска приложения в режиме разработки с использованием  webpack-dev-server.

> Boilerplate Typescript React - это доработанный универсальный шаблон, готовый для разработки приложения с использованием React и Redux Toolkit.
Шаблон дополнительно содержит примеры подключения ресурсов, redux slice'ы, unit-тесты.

## Как использовать

С помощью `npx` можно создавать шаблоны приложений без необходимости устанавливать `@nsmp/create-app` глобально:
```bash
npx @nsmp/create-app my-app
```

| Команда                                  | Описание                                                                                                                          |
|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `npx @nsmp/create-app [appName]`       | Создаёт директорию с указанным именем и устанавливает в неё заготовку встроенного приложения. Процесс установки будет прерван, если директория с таким именем уже существует. |

| Опции                                    | Описание                                                                                                                          | Тип              |
|------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|------------------|
| `-s, --skip-options`                    | Пропустить команды для заполнения параметров "Автор(ы)", "Описание приложения" и "Версия".                                        | булевый тип      |
| `-n, --noninteractive`                  | Задать параметры "Установить React", "Автор(ы)", "Описание приложения" и "Версия" в командной строке. Процесс установки будет прерван, если не указано название проекта. | строковый тип     |
| `-r, --react`                           | Задать параметр "Установить React".                                                                                              | булевый тип      |
| `-a, --author`                          | Задать параметр "Автор(ы)".                                                                                                       | строковый тип     |
| `-d, --description`                     | Задать параметр "Описание приложения".                                                                                            | строковый тип     |
| `-v, --app-version`                     | Задать параметр "Версия".                                                                                                         | строковый тип     |
| `-h, --help`                            | Показать помощь                                                                                                                  | булевый тип      |
| `-V, --version`                         | Показать номер версии @nsmp/create-app                                                                                            | булевый тип      |

| Примеры                                      | Описание                                                                                                                          |
|----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| `@nsmp/create-app`                          | Начнётся интерактивный процесс инициализации проекта. Название проекта необходимо будет ввести в предложенном формате.            |
| `@nsmp/create-app embeddedApp`             | Начнётся интерактивный процесс инициализации проекта. Будет создана директория embeddedApp и все файлы заготовки встроенного приложения будут установлены в неё. |
| `@nsmp/create-app embeddedApp -n`          | Будет создана директория embeddedApp и все файлы заготовки встроенного приложения будут установлены в неё. -a="author email@example.com" -d="App description" -v="1.0.0" |
| `@nsmp/create-app embeddedApp -n -r`       | Будет создана директория embeddedApp и все файлы заготовки встроенного приложения React будут установлены в неё. -a="author email@example.com" -d="App description" -v="1.0.0" |
Если по какой-то причине необходимо взаимодействовать с глобально установленным пакетом, то алгоритм действий будет следующий:
```bash
npm i -g @nsmp/create-app
create-app my-app
```

После создания шаблона ВП [appName] с помощью @nsmp/create-app, станут доступны npm-сценарии, описание которых можно найти в файле [appName]/Readme.md.

> Внимание: для работы CLI необходимо использовать версию `node.js` версии `22.11.0` или выше.