trmnl_preview 0.25.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 70b815c128b20e0573632c988b2b170eb1721c5715af5a590e294315b2b0ea53
-  data.tar.gz: 101648b396d697a8f19fcfc91b342bd008b982cc59467b9a051726cc0d320540
+  metadata.gz: ddab525950f3e01ae9fd4e07afb80de6561f5c88f5f5a307f46c2578f057c4fa
+  data.tar.gz: 38563769627d50fae1b5f3aee125a99f1661ebb703655adc5cce7133e5371d85
 SHA512:
-  metadata.gz: caa796947c50819b618aefc48602524691a541adbb39b56b588fc85f5b95ca2ea323310e85ab20af4d33911f781f582e218fab1e3d56a2717679cccd90311894
-  data.tar.gz: bc0a881a929cf6548518f21e05f6ca7264a114dd1db1de178d203cfe1c853e583b67b9fef53de8f9617ccff2e7e8784eb064b46354934ca7ee7654913331e3d5
+  metadata.gz: 63e93e72f98d094dc6630394a968d30bca3020fc5938f32654b1b3c7c55fad6aa5456ba25c184c12ebfa1a7f0a9ffcb3efd55d1f3699a1a7ae18dbffc8e3ee4c
+  data.tar.gz: ac550f4ff63967bd8a4a47e7923919ffa889332706e99129e7e454df4065c303d34d6a7d572321234c435ab301c630cb3085647722b56e52ba1c9bad704773e0

data/CHANGELOG.md

@@ -1,6 +1,20 @@
 
 # Changelog
 
+## 0.27.0
+
+- `trmnlp lint` reports a webhook recipe with no `copyable_webhook_url` custom field (`webhook_url_shown`), as TRMNL's recipe review does. Without it, people who install the recipe have no field to copy their webhook URL from.
+- A release pinned in a plugin's `bin/trmnlp`, such as `IMAGE=trmnl/trmnlp:v0.24.0`, is used when another copy of the script is on the PATH as `trmnlp`. The plugin ran the PATH copy's image instead. To get the fix in an existing plugin, run `trmnlp init` there and overwrite only `bin/trmnlp`.
+- `trmnlp version` says when it runs in Docker, and in which image, on a second line on stderr. The version stays alone on stdout.
+
+## 0.26.0
+
+- `trmnlp lint` names the sizes an element has when a size class is missing (`framework_classes_exist`), such as `title--small` to `title--xxlarge` for `title--mega`, and links to the Framework's Element Sizes page. Each element has its own set of sizes.
+- The `hn-stories` example uses `title--small` in its half views. It had `title--xsmall`, which no Framework release has, so those titles rendered at the default size.
+- `trmnlp lint` reports a Framework class behind screen prefixes that its release does not define for it (`framework_prefixes_exist`): a prefix that does not exist, such as `xl:value--large`, prefixes out of order, such as `portrait:lg:value--large`, or a prefix the class has no variant for, such as `dark:value--large`. TRMNL ignores the class and says nothing. The lists come from each release's `plugins.css`; `rake framework:classes` refreshes them.
+- `trmnlp lint` reports a plain `https://` link in a custom field's description (`custom_field_links_embedded`), as TRMNL's recipe review does. An embedded `<a>` link is shorter, opens in a new tab and is plainly clickable; a link written without `https://` stays an unlinked example.
+- `trmnlp lint` reports a `settings.yml`, view or transform over 100 KB (`files_under_upload_limit`). TRMNL refuses to import such a file, so `trmnlp push` failed, even when a transform trims the data and the plugin renders in `serve`. Thanks to @barrymichaeldoyle for #252.
+
 ## 0.25.0
 
 - `trmnlp lint` also reports a `content--` class that the plugin's Framework release does not have (`framework_classes_exist`), such as `content--xsmall`. Rich Text sizes stop at `content--small`, and a missing one leaves the text at the default size.

data/README.md

@@ -13,16 +13,18 @@ The server watches the filesystem for changes to the Liquid templates, seamlessl
 
 ## Quick Start
 
-trmnlp requires Ruby 4.0 or newer. Check with `ruby -v` before installing.
+With [Docker](https://docs.docker.com/get-docker/) installed:
 
 ```sh
-gem install trmnl_preview     # install
+mkdir -p ~/.local/bin         # install
+docker run --rm --entrypoint cat trmnl/trmnlp /app/templates/init/bin/trmnlp > ~/.local/bin/trmnlp
+chmod +x ~/.local/bin/trmnlp
 trmnlp init my_plugin         # scaffold a project
 cd my_plugin
 trmnlp serve                  # preview at http://localhost:4567
 ```
 
-No Ruby on hand? Run it through Docker instead — see [Installing via Docker](#installing-via-docker).
+Have Ruby 4.0 or newer? `gem install trmnl_preview` starts faster — see [Installing via RubyGems](#installing-via-rubygems).
 
 ## Project Structure
 
@@ -227,21 +229,7 @@ The `bin/trmnlp` script is provided as a convenience. It will use the local Ruby
 
 You can modify the `bin/trmnlp` script to set up environment variables (plugin secrets, etc.) before running the server.
 
-**Gem or Docker?** Install the gem if you already have Ruby >= 4.0 — it has the fastest startup. Use Docker for zero local setup.
-
-### Installing via RubyGems
-
-Prerequisites:
-
-- Ruby >= 4.0
-- For PNG rendering (optional):
-  - Firefox
-  - ImageMagick
-
-```sh
-gem install trmnl_preview
-trmnlp serve
-```
+**Docker or gem?** The Docker image has everything trmnlp needs, including Firefox and the tools `trmnlp test` uses. The gem starts a little faster, but needs Ruby 4.0 and those tools installed yourself.
 
 ### Installing via Docker
 
@@ -328,6 +316,24 @@ cd trmnlp
 docker build -t trmnlp .
 ```
 
+### Installing via RubyGems
+
+Prerequisites:
+
+- Ruby >= 4.0
+- For PNG rendering and `trmnlp test`:
+  - Firefox
+  - ImageMagick 7
+- For some `trmnlp test` features ([Testing](docs/testing.md)):
+  - libfaketime, for a transform's clock with `now:`
+  - zbar, for `have_qr_code`
+- Node 24, Python or PHP, for a transform in that language
+
+```sh
+gem install trmnl_preview
+trmnlp serve
+```
+
 ## `.trmnlp.yml` Reference - Project Config
 
 The `.trmnlp.yml` file lives in the root of the plugin project, and is for configuring the local dev server.