Инициализация проекта

Библиотека @infomaximum/package-cli, разработанная Infomaximum, помогает генерировать проект с виджетом и удобно и быстро разворачивать его.

Выполняем команду для инициализации проекта, где в качестве аргумента передается имя проекта my_widget:

npx @infomaximum/package-cli widget init my_widget

После выполнения команды укажите дополнительную информацию о проекте, которую запросит программа (имя пакета, описание, автор, менеджер пакетов):

    npx @infomaximum/package-cli widget init line_chart
? Enter the nameof the package: Line chart
? Enter a description for the package
? Enter the name of the package author: Infomaximum
? Select the package manager: (Use arrows keys)
    npm
>   yarn

После того как проект будет создан, автоматически установятся все необходимые зависимости и выполнится инициализация git-репозитория. В результате будет создана следующая структура проекта:

my_widget
    node_modules/
    package/
        en/
            changelog.md
            doc.md
        resources/
            Widget.png
        ru/
            changelog.md
            doc.md
        manifest.json
    src/
        definition/
            definition.ts
            panel.ts
            settings.ts
        App.tsx
        app.d.ts
        index.css
        index.tsx
    .eslintignore
    .eslintrc
    .gitignore
    babel.config.js
    jest.config.js
    manifest.json
    package.json
    tsconfig.json
    tsconfig.tsbuildinfo
    widgetrc.json
    yarn.lock

Далее можно перейти в проект, выполнив команду:

cd my_widget

Заполните манифесты дополнительной информацией по пакету и виджету и добавьте документацию по виджету, который планируется разрабатывать.

Также можно запустить некоторые встроенные команды, например, команду сборки пакета:

npm run build

Чтобы загрузить полученный пакет в систему, используйте маркетплейс.

Можно узнать дополнительные команды, которые доступны в библиотеке, выполнив команду:

npx @infomaximum/package-cli -h