README.md

   1 # @webinstall/packages
   2
   3 > WebInstall is how developers install their tools
   4
   5 ```bash
   6 curl https://webinstall.dev/webi | bash
   7 ```
   8
   9 This repository contains the primary and community-submitted packages for
  10 [webinstall.dev](https://webinstall.dev).
  11
  12 # Installer Guidelines
  13
  14 - Should install to `$HOME/.local/opt/<package>-<version>` or `$HOME/.local/bin`
  15 - Should not need `sudo` (except perhaps for a one-time `setcap`, etc)
  16 - Examples:
  17   - Full Packages:
  18     - Node.js: <https://github.com/webinstall/packages/tree/master/node>
  19     - Golang: <https://github.com/webinstall/packages/tree/master/golang>
  20     - PostgreSQL: <https://github.com/webinstall/packages/tree/master/postgres>
  21   - Single-Binary Installers:
  22     - Caddy: <https://github.com/webinstall/packages/tree/master/caddy>
  23     - Ripgrep: <https://github.com/webinstall/packages/tree/master/ripgrep>
  24     - Gitea: <https://github.com/webinstall/packages/tree/master/gitea>
  25   - Convenience Scripts:
  26     - Prettier: <https://github.com/webinstall/packages/tree/master/prettier>
  27     - Rust-lang: <https://github.com/webinstall/packages/tree/master/rustlang>
  28     - Rust-lang:
  29       <https://github.com/webinstall/packages/tree/master/vim-sensible>
  30
  31 # How it works
  32
  33 - Contacts official release APIs for download URLs
  34 - Selects the appropriate package version and archive format
  35 - Installs to `$HOME/.local/`
  36 - Updates `PATH` via `$HOME/.config/envman/PATH.env`
  37 - Symlinks or copies current selected version
  38
  39 More technically:
  40
  41 1. `<package>/releases.js` transforms the package's release API into a common
  42    formatt
  43    - (i.e. HTML, CSV, TAB, or JSON into a specific JSON format)
  44    - common release APIs are in `_common/` (i.e. `_common/github.js`)
  45 2. `_webi/bootstrap.sh` is a template that exchanges system information for a
  46    correct installer
  47    - contructs a user agent with os, cpu, and utility info (i.e. `macos`,
  48      `amd64`, can unpack `tar,zip,xz`)
  49 3. `_webi/template.sh` is the base installer template with common functions for
  50    - checking versions
  51    - downloading & unpacking
  52    - updating PATH
  53    - (re-)linking directories
  54 4. `<package>/install.sh` may provide functions to override `_webi/template.sh`
  55 5. Recap:
  56    - `curl https://webinstall.dev/<pkg>` => `bootstrap-<pkg>.sh`
  57    - `bash bootstrap-<pkg>.sh` =>
  58      `https://webinstall.dev/api/installers/<pkg>@<ver>.sh?formats=zip,tar`
  59    - `bash install-<pkg>.sh` => download, unpack, move, link, update PATH
  60
  61 ## Creating an Installer
  62
  63 An install consists of 5 parts in 4 files:
  64
  65 ```
  66 my-new-package/
  67   - package.yash
  68   - releases.js
  69   - install.sh
  70   - install.bat
  71 ```
  72
  73 1. Create Description
  74 2. Fetch Releases
  75 3. Version Check (semi-optional)
  76 4. Update PATH
  77
  78 See these **examples**:
  79
  80 - https://github.com/webinstall/packages/blob/master/rg/
  81 - https://github.com/webinstall/packages/blob/master/golang/
  82
  83 The `webinstall.dev` server uses the list of releases returned by
  84 `<your-package>/releases.js` to generate a bash script with most necessary
  85 variables and functions pre-defined.
  86
  87 You just fill in the blanks.
  88
  89 ### TL;DR
  90
  91 Just create an empty directory and run the tests until you get a good result.
  92
  93 ```bash
  94 git clone git@github.com:webinstall/packages.git
  95 pushd packages
  96 npm install
  97 ```
  98
  99 ```bash
 100 mkdir -p ./new-package/
 101 node _webi/test.js ./new-package/
 102 ```
 103
 104 ### 1. Create Description
 105
 106 Just copy the format from any of the existing packages. It's like this:
 107
 108 `package.yash`:
 109
 110 ````
 111 # title: Node.js
 112 # homepage: https://nodejs.org
 113 # tagline: JavaScript V8 runtime
 114 # description: |
 115 #   Node.js® is a JavaScript runtime built on Chrome's V8 JavaScript engine
 116 # examples: |
 117 #   ```bash
 118 #   node -e 'console.log("Hello, World!")'
 119 #   > Hello, World!
 120 #   ```
 121
 122 END
 123 ````
 124
 125 This is a dumb format. We know. Historical accident (originally these were in
 126 bash comments).
 127
 128 It's in the TODOs to replace this with either YAML or Markdown.
 129
 130 ### 1. Fetch Releases
 131
 132 All you're doing in this step is just translating from one form of JSON or CSV
 133 or TAB or whatever, to a format understood by `webi`.
 134
 135 - Using Github releases? See `ripgrep/releases.js` (which uses
 136   `_common/github.js`)
 137 - Have a special format? See `golang/releases.js` or `node/releases.js`.
 138
 139 It looks like this:
 140
 141 `releases.js`:
 142
 143 ```js
 144 module.exports = function (request) {
 145   return github(request, owner, repo).then(function (all) {
 146     // if you need to do something special, you can do it here
 147     // ...
 148     return all;
 149   });
 150 };
 151 ```
 152
 153 ### 2. Bash Installer
 154
 155 1. Variables _you_ can set
 156 2. Functions _you_ must define
 157 3. Convenience / Helper Functions
 158
 159 (optional, if needed) Bash variables that you _may_ define:
 160
 161 ```bash
 162 # Define this if the package name is different from the command name (i.e. golang => go)
 163 pkg_cmd_name="foobar"
 164
 165 # These are used for symlinks, PATH, and test commands
 166 pkg_dst="$HOME/.local/opt/foobar"
 167 pkg_dst_bin="$HOME/.local/opt/foobar/bin"
 168 pkg_dst_cmd="$HOME/.local/opt/foobar/bin/foobar"
 169
 170 # These are the _real_ locations for the above
 171 pkg_src="$HOME/.local/opt/foobar-v$WEBI_VERSION"
 172 pkg_src_bin="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin"
 173 pkg_src_cmd="$HOME/.local/opt/foobar-v$WEBI_VERSION/bin/foobar"
 174 ```
 175
 176 (required) A version check function that strips all non-version junk
 177
 178 ```bash
 179 pkg_get_current_version() {
 180     # foobar-v1.1.7 => 1.1.7
 181     echo "$(foobar --version | head -n 1 | sed 's:foobar-v::')"
 182 }
 183 ```
 184
 185 For the rest of the functions you can like copy/paste from the examples:
 186
 187 ```bash
 188 pkg_format_cmd_version() {}         # Override, pretty prints version
 189
 190 pkg_link                            # Override, replaces webi_link()
 191
 192 pkg_pre_install() {                 # Override, runs any webi_* commands
 193     webi_check                          # for $HOME/.local/opt tools
 194     webi_download                       # for things that have a releases.js
 195     webi_extract                        # for .xz, .tar.*, and .zip files
 196 }
 197
 198 pkg_install() {}                    # Override, usually just needs to rename extracted folder to
 199                                     # "$HOME/.local/opt/$pkg_cmd_name-v$WEBI_VERSION"
 200
 201 pkg_post_install() {                # Override
 202     webi_path_add "$pkg_dst_bin"        # should probably update PATH
 203 }
 204
 205 pkg_done_message() {}               # Override, pretty print a success message
 206 ```
 207
 208 ## Script API
 209
 210 See `webi/template.sh`
 211
 212 These variables will be set by the server:
 213
 214 ```
 215 WEBI_PKG=example@v1
 216 WEBI_NAME=example
 217 WEBI_TAG=v1
 218 WEBI_HOST=https://webinstall.dev
 219 WEBI_RELEASES=https://webinstall.dev/api/releases/example@v1?os=macos&arch=amd64&pretty=true
 220 WEBI_CSV=v1.0.2,
 221 WEBI_VERSION=1.0.2
 222 WEBI_MAJOR=1
 223 WEBI_MINOR=0
 224 WEBI_PATCH=2
 225 WEBI_LTS=
 226 WEBI_CHANNEL=stable
 227 WEBI_EXT=tar
 228 WEBI_PKG_URL=https://cdn.example.com/example-macos-amd64.tar.gz
 229 WEBI_PKG_FILE=example-macos-amd64.tar.gz
 230 ```
 231
 232 ```bash
 233 WEBI_TMP=${WEBI_TMP:-"$(mktemp -d -t webinstall-foobar.XXXXXXXX)"}
 234 WEBI_SINGLE=""
 235 ```
 236
 237 ```bash
 238 webi_check              # Checks to see if the selected version is already installed (and re-links if so)
 239 webi_download           # Downloads the selected release to $HOME/Downloads/<package-name>.tar.gz
 240 webi_extract            # Extracts the download to /tmp/<package-name>-<random>/
 241 webi_path_add /new/path # Adds /new/path to PATH for bash, zsh, and fish
 242 webi_pre_install        # Runs webi_check, webi_download, and webi_extract
 243 webi_install            # Moves extracted files from $WEBI_TMP to $pkg_src
 244 webi_link               # replaces any existing symlink with the currently selected version
 245 webi_post_install       # Runs `webi_add_path $pkg_dst_bin`
 246 ```
 247
 248 # Roadmap
 249
 250 - Wrap release APIs to unify and expose
 251 - [ ] Support arbitrary git urls (i.e. `@github.com/node/node`)
 252   - (maybe `ghi node/node` for github specifically)
 253 - [ ] Support git as an archive format