npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@infomaximum/package-cli

v2.11.0

Published

@infomaximum/package-cli - предоставляет разработчикам набор команд и функций для сборки пакетов, запуска пакетов в режиме разработки и создания шаблонного кода для виджетов и приложений.

Downloads

185

Readme

@infomaximum/package-cli

@infomaximum/package-cli - предоставляет разработчикам набор команд и функций для сборки пакетов, запуска пакетов в режиме разработки и создания шаблонного кода для виджетов и приложений.

Разработка виджета

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

Для создания нового пакета с виджетом необходимо выполнить следующую команду:

npx @infomaximum/package-cli widget init my_widget

После выполнения данной команды будет создан шаблонный проект my_widget и инициализирован git репозиторий.

Разработка виджета

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

yarn im-package-cli widget build --dev

Данная команда выполняет сборку пакета для разработки. Далее, пакет (собранный архив из папки build) необходимо загрузить в систему. Для этого добавляем пакет в маркетплейс либо в пространство, а так же добавляем разрабатываемый виджет на холст (дашбординг).

Затем необходимо запустить сервер разработки следующей командой:

yarn im-package-cli widget start

В результате будет запущен сервер отслеживающий изменения проекта и выполняющий горячую перезагрузку разрабатываемого компонента.

Сборка пакета

Для того чтобы пользователи имели возможность использовать разработанный вами виджет, необходимо выполнить сборку пакета, для этого выполняем команду:

yarn im-package-cli widget build

Полученный в результате выполнения данной команды пакет можно загрузить в систему.

Файл конфигурации виджета

widgetrc.json

{
  "$schema": "node_modules/@infomaximum/package-cli/schemas/widgetConfigSchema.json",
  "entry": "src/index.tsx",
  "widgetManifest": "manifest.json",
  "packageManifest": "package/manifest.json",
  "packageDir": "package",
  "assetsDir": "_resources",
  "buildDir": "build",
  "port": 5555,
  "host": "localhost"
}
  • entry: Путь к точке входа вашего приложения

  • widgetManifest: Путь к файлу манифеста виджета

  • packageManifest: Путь к файлу манифеста пакета

  • packageDir: Путь к каталогу пакета

  • assetsDir: Путь к каталогу ресурсов

  • buildDir: Путь к каталогу сборки

  • port: Порт, на котором будет запущен сервер разработки

  • host: Хост, на котором будет запущен сервер разработки

Этот файл должен называться widgetrc.json, но также может иметь расширение .js, .yaml. Кроме того, конфигурацию можно добавить в package.json в поле widget.

package.json

{
  "name": "my_widget",
  "version": "1.0.0",
  "dependencies": {
    ...
  },
  "widget": {
    "entry": "src/index.tsx",
    "widgetManifest": "manifest.json",
    "packageManifest": "package/manifest.json",
    "packageDir": "package",
    "assetsDir": "_resources",
    "buildDir": "build",
    "port": 5555,
    "host": "localhost"
  }
}

Эта конфигурация определяет, как будет собираться и запускаться ваш пакет с использованием @infomaximum/package-cli.

Версионирование пакета (2.10.0)

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

fix: увеличивает патч-версию (например, с 1.0.0 до 1.0.1)
feat: увеличивает минорную версию (например, с 1.0.0 до 1.1.0)
BREAKING CHANGE: увеличивает мажорную версию (например, с 1.0.0 до 2.0.0)

После вычисления новой версии автоматически генерируется CHANGELOG.md, который включает список изменений, а также создается соответствующий тег в системе контроля версий.

Создать релиз можно используя команду yarn im-package-cli widget release

Вывод всех доступных команд

Вы можете использовать флаг -h, чтобы просмотреть список всех доступных команд и их описаний:

yarn im-package-cli -h