trmnl_preview 0.26.0 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c4ffc486c22d7f6adb8a5f92181503f0140245ce1412717c495da6a6e8b35a7
-  data.tar.gz: 21e8cae0d6ad5d6a7363419e07de7cdf2f8f34cb5038915a0157a2fa5fc93015
+  metadata.gz: ddab525950f3e01ae9fd4e07afb80de6561f5c88f5f5a307f46c2578f057c4fa
+  data.tar.gz: 38563769627d50fae1b5f3aee125a99f1661ebb703655adc5cce7133e5371d85
 SHA512:
-  metadata.gz: 6ff9eb94206b9c32193e5d0aee062532c9d685736ee1b965875efe141d1a205da4282221bcc6f36424cb806324f9786325cd3d15072eacffe70dde7b19b09a5d
-  data.tar.gz: 67301f96bfb041425a82d5ba95f5b9c70bf740fde555239c0fb7ec5ba5c3fcd128b263dcfc13f0cceede0c3e0bf12aaaa6aec9d0f427a6e262ae6588f8f9d761
+  metadata.gz: 63e93e72f98d094dc6630394a968d30bca3020fc5938f32654b1b3c7c55fad6aa5456ba25c184c12ebfa1a7f0a9ffcb3efd55d1f3699a1a7ae18dbffc8e3ee4c
+  data.tar.gz: ac550f4ff63967bd8a4a47e7923919ffa889332706e99129e7e454df4065c303d34d6a7d572321234c435ab301c630cb3085647722b56e52ba1c9bad704773e0

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 
 # 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.

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.

data/lib/trmnlp/cli.rb

@@ -117,6 +117,8 @@ module TRMNLP
       puts VERSION
       # Keep the version first when stdout is a pipe and stderr is not.
       $stdout.flush
+      # On stderr, so a script that reads the version still gets the number alone.
+      warn "Running in Docker (#{ENV.fetch('TRMNLP_IMAGE', 'image unknown')})" if self.class.in_container?
       check_for_update(fresh: true)
     end
   end

data/lib/trmnlp/lint/checks/webhook_url_shown.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../check'
+
+module TRMNLP
+  module Lint
+    module Checks
+      # Recipe review asks a webhook recipe to show each install its own
+      # webhook URL, so the user can copy it into the service that pushes data.
+      class WebhookUrlShown < Check
+        MESSAGE = 'Add a custom field with field_type copyable_webhook_url, so people who install this webhook ' \
+                  'recipe can copy their webhook URL. TRMNL fills it in with the URL of each install.'
+        LEARN_MORE = 'https://help.trmnl.com/en/articles/10513740-custom-plugin-form-builder#h_431c22552a'
+
+        private
+
+        def pass?
+          source.settings['strategy'] != 'webhook' ||
+            source.custom_field_definitions.any? { it['field_type'] == 'copyable_webhook_url' }
+        end
+      end
+    end
+  end
+end

data/lib/trmnlp/lint/diagnostic.rb

@@ -7,7 +7,8 @@ module TRMNLP
     class Diagnostic
       SETTINGS_KEYS = {
         'title_casing' => 'name', 'title_length' => 'name',
-        'description_length' => 'description', 'recipe_overview_length' => 'recipe_overview'
+        'description_length' => 'description', 'recipe_overview_length' => 'recipe_overview',
+        'webhook_url_shown' => 'strategy'
       }.freeze
       MARKUP_PATTERNS = {
         'no_async_functions' => /async function/i,

data/lib/trmnlp/lint.rb

@@ -30,6 +30,7 @@ require_relative 'lint/checks/framework_prefixes_exist'
 require_relative 'lint/checks/no_external_qr_codes'
 require_relative 'lint/checks/custom_field_links_embedded'
 require_relative 'lint/checks/files_under_upload_limit'
+require_relative 'lint/checks/webhook_url_shown'
 
 module TRMNLP
   # Markup best-practice checks behind `trmnlp lint`.
@@ -63,7 +64,8 @@ module TRMNLP
       Checks::FrameworkPrefixesExist,
       Checks::NoExternalQrCodes,
       Checks::CustomFieldLinksEmbedded,
-      Checks::FilesUnderUploadLimit
+      Checks::FilesUnderUploadLimit,
+      Checks::WebhookUrlShown
     ].freeze
 
     def self.rule_id(check_type) = check_type.name.split('::').last.gsub(/([a-z\d])([A-Z])/, '\1_\2').downcase

data/lib/trmnlp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TRMNLP
-  VERSION = '0.26.0'
+  VERSION = '0.27.0'
 end

data/templates/init/bin/trmnlp

@@ -7,9 +7,10 @@
 # Add a tag to stay on one release, v0.22.0 or later: trmnl/trmnlp:v0.22.0
 IMAGE=trmnl/trmnlp
 
-# Saved on the PATH as `trmnlp`, this script is what `command -v trmnlp` finds: not a gem.
+# Saved on the PATH as `trmnlp`, this script is what `command -v trmnlp` finds: not a gem. Nor is
+# another copy of it there (it names run_in_docker): that one would run its own image, not the one above.
 GEM="$(command -v trmnlp)"
-if [ -n "$GEM" ] && ! [ "$GEM" -ef "$0" ]
+if [ -n "$GEM" ] && ! [ "$GEM" -ef "$0" ] && ! grep -qs run_in_docker "$GEM"
 then
     exec "$GEM" "$@"
 fi

data/templates/run_in_docker

@@ -60,6 +60,7 @@ exec docker run \
     "${ARGS[@]}" \
     --env CI \
     --env TRMNL_API_KEY \
+    --env TRMNLP_IMAGE="$IMAGE" \
     --volume "$CONFIG_DIR:$CONTAINER_HOME/.config/trmnlp" \
     --volume "$CACHE_DIR:$CONTAINER_HOME/.cache/trmnl" \
     --volume "$(pwd):/plugin" \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trmnl_preview
 version: !ruby/object:Gem::Version
-  version: 0.26.0
+  version: 0.27.0
 platform: ruby
 authors:
 - Rockwell Schrock
@@ -449,6 +449,7 @@ files:
 - lib/trmnlp/lint/checks/title_casing.rb
 - lib/trmnlp/lint/checks/title_length.rb
 - lib/trmnlp/lint/checks/waits_for_dom_load.rb
+- lib/trmnlp/lint/checks/webhook_url_shown.rb
 - lib/trmnlp/lint/checks/yes_no_selects_are_boolean.rb
 - lib/trmnlp/lint/diagnostic.rb
 - lib/trmnlp/lint/source.rb