webi installers

ويب

Webi هي كيف يقوم المطورون بتثبيت أدواتهم

• لا sudo
• لا يوجد مدير الحزمة
• لا تعبث مع أذونات النظام
• باختصار: لا هراء

curl https://webi.sh/webi | sh

يحتوي هذا المستودع على الحزم الأولية والمجتمع المقدمة لـ WebInstall.dev.

كيف يعمل Webi

• جهات اتصال واجهات برمجة تطبيقات الإصدار الرسمي لتنزيل عناوين URL
• يحدد نسخة الحزمة المناسبة وتنسيق الأرشيف
• يتم تثبيت $HOME/.local/opt أو $HOME/.local/bin ، حسب الاقتضاء.
• تحديث PATH عبر $HOME/.config/envman/PATH.env
• symlinks أو نسخ الإصدار المحدد الحالي

أكثر تقنيا:

1. <package>/releases.js يحول واجهة برمجة تطبيقات إصدار الحزمة إلى تنسيق شائع
   • (أي HTML أو CSV أو TAB أو JSON في تنسيق JSON محدد)
   • واجهات برمجة تطبيقات الإصدار الشائعة موجودة في _common/ (أي _common/github.js )
2. _webi/bootstrap.sh هو قالب يتبادل معلومات النظام للمثبت الصحيح
   • يقوم بإنشاء وكيل مستخدم مع OS و CPU ومعلومات الأداة المساعدة (أي macos ، amd64 ، يمكنه إلغاء تعبئة tar,zip,xz )
3. _webi/template.sh هو قالب المثبت الأساسي مع وظائف مشتركة ل
   • التحقق من الإصدارات
   • تنزيل وتفريغ
   • تحديث المسار
   • (إعادة) ربط الدلائل
4. قد يوفر <package>/install.sh وظائف لتجاوز _webi/template.sh
5. خلاصة:
   • curl https://webi.sh/<pkg> => bootstrap-<pkg>.sh
   • sh bootstrap-<pkg>.sh => https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar
   • sh install-<pkg>.sh => تنزيل ، إلغاء الظهر ، نقل ، رابط ، تحديث مسار

الفلسفة (لمؤلفي الحزم / المشرفين النشر مع Webi)

• يجب التثبيت على $HOME/.local/opt/<package>-<version> أو $HOME/.local/bin
• لا ينبغي أن تحتاج إلى sudo (باستثناء ربما بالنسبة إلى setcap لمرة واحدة ، إلخ)
• أمثلة:
  • الحزم الكاملة:
    • node.js: https://github.com/webinstall/packages/tree/master/node
    • Golang: https://github.com/webinstall/packages/tree/master/golang
    • postgresql: https://github.com/webinstall/packages/tree/master/postgres
  • مثبتات ثنائية واحدة:
    • Caddy: https://github.com/webinstall/packages/tree/master/caddy
    • RipGrep: https://github.com/webinstall/packages/tree/master/ripgrep
    • Gitea: https://github.com/webinstall/packages/tree/master/gitea
  • البرامج النصية الراحة:
    • أجمل: https://github.com/webinstall/packages/tree/master/prettier
    • Rust-Lang: https://github.com/webinstall/packages/tree/master/rustlang
    • vim-sensible: https://github.com/webinstall/packages/tree/master/vim-sensible

إنشاء مثبت

يتكون التثبيت من 5 أجزاء في 4 ملفات:

 my-new-package/
  - README.md (package info in frontmatter)
  - releases.js
  - install.sh (POSIX Shell)
  - install.ps1 (PowerShell)

1. إنشاء الوصف
2. إحضار الإصدارات
3. فحص الإصدار (شبه خيالي)
4. تحديث المسار

انظر هذه الأمثلة :

• https://github.com/webinstall/packages/blob/master/rg/
• https://github.com/webinstall/packages/blob/master/golang/

يستخدم webinstall.dev Server قائمة الإصدارات التي يتم إرجاعها بواسطة <your-package>/releases.js لإنشاء برنامج نصي Shell مع معظم المتغيرات والوظائف المحددة مسبقًا.

أنت فقط تملأ الفراغات.

TL ؛ د

ما عليك سوى إنشاء دليل فارغ وقم بإجراء الاختبارات حتى تحصل على نتيجة جيدة.

git clone [email protected]:webinstall/webi-installers.git
pushd ./webi-installers/
git submodule update --init
npm clean-install

mkdir -p ./new-package/
node _webi/test.js ./new-package/

1. إنشاء الوصف

فقط انسخ التنسيق من أي من الحزم الحالية. إنه مثل هذا:

README.md :

 ---
title : Node.js
homepage : https://nodejs.org
tagline : |
  JavaScript V8 runtime
description : |
  Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
---

``` sh
node -e ' console.log("Hello, World!") '
> Hello, World !
```

1. جلب الإصدارات

كل ما تفعله في هذه الخطوة هو مجرد ترجمة من شكل واحد من شكل JSON أو CSV أو علامة التبويب أو أي شيء ، إلى تنسيق يفهمه webi .

• باستخدام إصدارات جيثب؟ انظر ripgrep/releases.js (الذي يستخدم _common/github.js )
• لديك تنسيق خاص؟ انظر golang/releases.js أو node/releases.js .

يبدو أن هذا:

releases.js :

 module . exports = function ( ) {
  return github ( null , owner , repo ) . then ( function ( all ) {
    // if you need to do something special, you can do it here
    // ...
    return all ;
  } ) ;
} ;

2. مثبت باش

1. المتغيرات التي يمكنك ضبطها
2. الوظائف التي يجب تحديدها
3. وظائف الراحة / المساعد

(اختياري ، إذا لزم الأمر) متغيرات باش التي قد تحددها:

 # Define this if the package name is different from the command name (i.e. golang => go)
pkg_cmd_name= " foobar "

# These are used for symlinks, PATH, and test commands
pkg_dst= " $HOME /.local/opt/foobar "
pkg_dst_cmd= " $HOME /.local/opt/foobar/bin/foobar "
# pkg_dst_bin="$(dirname "$pkg_dst_cmd")"

# These are the _real_ locations for the above
pkg_src= " $HOME /.local/opt/foobar-v $WEBI_VERSION "
pkg_src_cmd= " $HOME /.local/opt/foobar-v $WEBI_VERSION /bin/foobar "
# pkg_src_bin="$(dirname "$pkg_src_cmd")"

(مطلوب) وظيفة التحقق من الإصدار التي تقطع جميع غير المرغوب

 pkg_get_current_version () {
    # foobar-v1.1.7 => 1.1.7
    echo " $( foobar --version | head -n 1 | sed ' s:foobar-v:: ' ) "
}

بالنسبة لبقية الوظائف ، يمكنك نسخ/لصق من الأمثلة:

 pkg_format_cmd_version () {}         # Override, pretty prints version

pkg_link                            # Override, replaces webi_link()

pkg_pre_install () {                 # Override, runs any webi_* commands
    webi_check                          # for $HOME/.local/opt tools
    webi_download                       # for things that have a releases.js
    webi_extract                        # for .xz, .tar.*, and .zip files
}

pkg_install () {}                    # Override, usually just needs to rename extracted folder to
                                    # "$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION"

pkg_post_install () {                # Override
    webi_path_add " $pkg_dst_bin "        # should probably update PATH
}

pkg_done_message () {}               # Override, pretty print a success message 

SCRIPT API

انظر webi/template.sh

سيتم تعيين هذه المتغيرات بواسطة الخادم:

WEBI_PKG=example@v1
WEBI_TAG=v1
WEBI_HOST=https://webinstall.dev
WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1 ? os=macos & arch=amd64 & pretty=true
WEBI_CSV=v1.0.2,
WEBI_VERSION=1.0.2
WEBI_MAJOR=1
WEBI_MINOR=0
WEBI_PATCH=2
WEBI_LTS=
WEBI_CHANNEL=stable
WEBI_EXT=tar
WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz
WEBI_PKG_FILE=example-macos-amd64.tar.gz

PKG_NAME=example
PKG_OSES=macos,linux,windows
PKG_ARCHES=amd64,arm64,x86
PKG_FORMATS=zip,xz

WEBI_TMP= ${WEBI_TMP :- " $( mktemp -d -t webinstall-foobar.XXXXXXXX ) " }
WEBI_SINGLE= " " 

webi_check              # Checks to see if the selected version is already installed (and re-links if so)
webi_download           # Downloads the selected release to $HOME/Downloads/webi/<package-name>.tar.gz
webi_extract            # Extracts the download to /tmp/<package-name>-<random>/
webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
webi_pre_install        # Runs webi_check, webi_download, and webi_extract
webi_install            # Moves extracted files from $WEBI_TMP to $pkg_src
webi_link               # replaces any existing symlink with the currently selected version
webi_post_install       # Runs `webi_path_add $pkg_dst_bin`

خريطة الطريق

• لف واجهات برمجة التطبيقات لتوحيد وفضح
• دعم المزيد من حزم Windows
• دعم عناوين URL التعسفية GIT (أي @github.com/node/node )
  • (ربما ghi node/node لـ GitHub على وجه التحديد)
• دعم GIT كتنسيق أرشيف