Options
All
  • Public
  • Public/Protected
  • All
Menu

Module console

Консольный скрипт

Назначение

Скрипт предназначен для быстрого создания приложения. Он способен создать шаблон приложения.

Использование

Чтобы воспользоваться скриптом, запустите файл ubot.js, и передайте необходимые параметры.

npm ubot

Команды

На данный момент поддерживаются 1 команда:

  • create - Создать проект

При создании проекта, в качестве 2 параметра нужно передать либо название проекта на английском языке, либо json файл с конфигурацией. При передаче json файла, можно создать шаблон приложения определенного типа. Сейчас поддерживается quiz - викторина, и пустой проект.

Пример json файла

 
{
 "name": "Название проекта (*)",
 "type": "Тип проекта. default, quiz",
 "config": ["Конфигурация для подключения к бд. Структуру смотри в mmApp.config"],
 "params": ["Параметры приложения. Структуру смотри в mmApp.params"],
 "path": "Директория, в которой будет создан проект. По умолчанию, проект создается в папке и именем проекта, в директории запуска скрипта."
}

'*' - обозначены обязательные поля.

Пример использования

Создание пустого проекта:

npm ubot create project

Создание проекта, используя в качестве параметра json

{
 "name": "project",
 "type": "quiz"
}

npm ubot create project.json

Index

References

Properties

References

create

Re-exports create

main

Re-exports main

Properties

utils

utils: { fread: (fileName: any) => string; fwrite: (fileName: any, fileContent: any, mode?: string) => void; is_dir: (file: any) => boolean; is_file: (file: any) => boolean }

Type declaration

  • fread: (fileName: any) => string
      • (fileName: any): string

      • Parameters

        • fileName: any

        Returns string

  • fwrite: (fileName: any, fileContent: any, mode?: string) => void
      • (fileName: any, fileContent: any, mode?: string): void

      • Parameters

        • fileName: any
        • fileContent: any
        • mode: string = 'w'

        Returns void

  • is_dir: (file: any) => boolean
      • (file: any): boolean

      • Parameters

        • file: any

        Returns boolean

  • is_file: (file: any) => boolean
      • (file: any): boolean

      • Parameters

        • file: any

        Returns boolean

Generated using TypeDoc